com.jivesoftware.community
Class TagResultFilter

java.lang.Object
  com.jivesoftware.community.ResultFilter
      com.jivesoftware.community.ThreadResultFilter
          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_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.
int	getMinimum() Returns the minimum number of JiveContentObjects that a tag must be associated with to be included in the result set.
void	setMinimum(int minimum) Sets the minimum number of JiveContentObjects that a tag must be associated with to be included in the result set.

Methods inherited from class com.jivesoftware.community.ThreadResultFilter

addResolutionState, clearResolutionStates, createDefaultMessageFilter, createDefaultThreadFilter, createDefaultUserMessagesFilter, getModerationRangeMax, getModerationRangeMin, getResolutionDateRangeMax, getResolutionDateRangeMin, getResolutionStates, getSortField, removeResolutionState, roundDate, roundDate, setModerationRangeMax, setModerationRangeMin, setResolutionDateRangeMax, setResolutionDateRangeMin, setSortField

Methods inherited from class com.jivesoftware.community.ResultFilter

addProperty, addProperty, addTag, createDefaultContentFilter, createDefaultRecursiveContentFilter, getCreationDateRangeMax, getCreationDateRangeMin, getModificationDateRangeMax, getModificationDateRangeMin, getNumResults, getPropertyCount, getPropertyMatchType, getPropertyMode, getPropertyName, getPropertyValue, getPropertyValueString, getSortOrder, getSortPropertyName, getStartIndex, getTags, getUserID, isAllTagsRequired, isPerformDistinctCount, isRecursive, setAllTagsRequired, setCreationDateRangeMax, setCreationDateRangeMin, setModificationDateRangeMax, setModificationDateRangeMin, setNumResults, setPerformDistinctCount, setPropertyMode, setRecursive, setSortOrder, setSortPropertyName, setStartIndex, setTags, setUserID

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, 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

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.