Jive API (4.5.7.0) Core Javadocs

com.jivesoftware.community
Class TagResultFilter

java.lang.Object
  extended by com.jivesoftware.community.ResultFilter
      extended by com.jivesoftware.community.ThreadResultFilter
          extended by com.jivesoftware.community.TagResultFilter
Direct Known Subclasses:
BlogTagResultFilter

public class TagResultFilter
extends ThreadResultFilter

Filters and sorts JiveContentObjects based on ContentTags.


Field Summary
 
Fields inherited from class com.jivesoftware.community.ResultFilter
AND_MODE, ASCENDING, CONTAINS_MATCH, DESCENDING, EXACT_MATCH, NULL_DOUBLE, NULL_INT, OR_MODE
 
Constructor Summary
TagResultFilter()
           
 
Method Summary
static TagResultFilter createDefaultFilter()
          Creates a default TagResultFilter: all tags sorted in descending order with no minimum number of JiveContentObjects.
 boolean equals(java.lang.Object o)
           
 java.util.Collection<com.jivesoftware.community.socialgroup.SocialGroupType> getExcludedGroupTypes()
          Returns a list of social group types to be excluded from any generated query.
 int getMinimum()
          Returns the minimum number of JiveContentObjects that a tag must be associated with to be included in the result set.
 int getStartIndex()
          Tag result filters are not meant to retrieve results by page - thus setting a position within a logical sequence doesn't fit the use case.
 int hashCode()
           
 void setExcludedGroupTypes(java.util.Collection<com.jivesoftware.community.socialgroup.SocialGroupType> excludedGroupTypes)
          Sets a list of social group types to be excluded from any generated query.
 void setMinimum(int minimum)
          Sets the minimum number of JiveContentObjects that a tag must be associated with to be included in the result set.
 void setStartIndex(int startIndex)
          Sets the index of the first result to return.
 
Methods inherited from class com.jivesoftware.community.ThreadResultFilter
addResolutionState, clearResolutionStates, createDefaultMessageFilter, createDefaultThreadFilter, createDefaultUserMessagesFilter, getModerationRangeMax, getModerationRangeMin, getResolutionDateRangeMax, getResolutionDateRangeMin, getResolutionStates, getShowModerated, getSortField, isShowThreadOwnersOnly, removeResolutionState, roundDate, roundDate, setModerationRangeMax, setModerationRangeMin, setResolutionDateRangeMax, setResolutionDateRangeMin, setShowModerated, setShowThreadOwnersOnly, setSortField, toString
 
Methods inherited from class com.jivesoftware.community.ResultFilter
addProperty, addProperty, addTag, createDefaultContentFilter, createDefaultRecursiveContentFilter, getCreationDateRangeMax, getCreationDateRangeMin, getEndIndex, getModificationDateRangeMax, getModificationDateRangeMin, getNumResults, getPropertyCount, getPropertyMatchType, getPropertyMode, getPropertyName, getPropertyValue, getPropertyValueString, getSortOrder, getSortPropertyName, getTags, getTagSets, getUserID, isAllTagsRequired, isPerformDistinctCount, isRecursive, setAllTagsRequired, setCreationDateRangeMax, setCreationDateRangeMin, setModificationDateRangeMax, setModificationDateRangeMin, setNumResults, setPerformDistinctCount, setPropertyMode, setRecursive, setSortOrder, setSortPropertyName, setTags, setTagSets, setUserID
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

TagResultFilter

public TagResultFilter()
Method Detail

createDefaultFilter

public static TagResultFilter createDefaultFilter()
Creates a default TagResultFilter: all tags sorted in descending order with no minimum number of JiveContentObjects.

NOTE: The resulting TagResultFilter should not be stored by invoking classes; this filter is the default tag filter at the time this method is invoked.

Returns:
a default TagResultFilter

setStartIndex

public void setStartIndex(int startIndex)
Description copied from class: ResultFilter
Sets the index of the first result to return. For example, if the start index is set to 20, the Iterator returned will start at the 20th result in the query. This method can be used in combination with setNumResults(int) to perform pagination of results.

Overrides:
setStartIndex in class ResultFilter
Parameters:
startIndex - the index of the first result to return.

getStartIndex

public int getStartIndex()
Tag result filters are not meant to retrieve results by page - thus setting a position within a logical sequence doesn't fit the use case. This implementation always returns 0;

Overrides:
getStartIndex in class ResultFilter
Returns:
0

getMinimum

public int getMinimum()
Returns the minimum number of JiveContentObjects that a tag must be associated with to be included in the result set.

Returns:
the minimum number of JiveContentObjects that a tag must be associated with to be included in the result set.

setMinimum

public void setMinimum(int minimum)
Sets the minimum number of JiveContentObjects that a tag must be associated with to be included in the result set.

Parameters:
minimum - the minimum number of JiveContentObjects that a tag must be associated with to be included in the result set.

getExcludedGroupTypes

public java.util.Collection<com.jivesoftware.community.socialgroup.SocialGroupType> getExcludedGroupTypes()
Returns a list of social group types to be excluded from any generated query. Tags on social groups of these types will be ignored

Returns:
a list of social group types whose tags should be ignored

setExcludedGroupTypes

public void setExcludedGroupTypes(java.util.Collection<com.jivesoftware.community.socialgroup.SocialGroupType> excludedGroupTypes)
Sets a list of social group types to be excluded from any generated query. Tags on social groups of these types will be ignored

Parameters:
excludedGroupTypes - a list of group types that will be excluded from any tag query

equals

public boolean equals(java.lang.Object o)
Overrides:
equals in class ThreadResultFilter

hashCode

public int hashCode()
Overrides:
hashCode in class ThreadResultFilter

Jive Product Page

Copyright © 1999-2007 Jive Software.