Jive API (4.5.7.0) Core Javadocs

com.jivesoftware.community
Class BlogTagResultFilter

java.lang.Object
  extended by com.jivesoftware.community.ResultFilter
      extended by com.jivesoftware.community.ThreadResultFilter
          extended by com.jivesoftware.community.TagResultFilter
              extended by com.jivesoftware.community.BlogTagResultFilter

public class BlogTagResultFilter
extends TagResultFilter

Filters and sorts tags with specific fields for Blogs.


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
BlogTagResultFilter()
           
 
Method Summary
static BlogTagResultFilter createDefaultFilter()
          Creates a default tag ResultFilter: all tags associated with blog posts that have status = BlogPost#STATUS_PUBLISH, publishDate less than now() (with minute precision) ordered by tag name in descending order.
 boolean equals(java.lang.Object o)
           
 java.util.Date getPublishDateRangeMax()
          Returns a date that represents the upper boundry for tags to be selected by the result filter.
 java.util.Date getPublishDateRangeMin()
          Returns the publish date that represents the lower boundary for blog posts to be filtered on.
 int hashCode()
           
 void setPublishDateRangeMax(java.util.Date publishDateRangeMax)
          Sets a date that represents the upper boundry for tags to be selected by the result filter.
 void setPublishDateRangeMin(java.util.Date publishDateRangeMin)
          Sets the date that represents the lower boundary for blog posts to be selected by the result filter.
 
Methods inherited from class com.jivesoftware.community.TagResultFilter
getExcludedGroupTypes, getMinimum, getStartIndex, setExcludedGroupTypes, setMinimum, setStartIndex
 
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

BlogTagResultFilter

public BlogTagResultFilter()
Method Detail

createDefaultFilter

public static BlogTagResultFilter createDefaultFilter()
Creates a default tag ResultFilter: all tags associated with blog posts that have status = BlogPost#STATUS_PUBLISH, publishDate less than now() (with minute precision) ordered by tag name in descending order.

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


getPublishDateRangeMin

public java.util.Date getPublishDateRangeMin()
Returns the publish date that represents the lower boundary for blog posts to be filtered on. If this value has not been set, the method will return null.

Returns:
a Date representing the lower bound for publish dates to filter on.

setPublishDateRangeMin

public void setPublishDateRangeMin(java.util.Date publishDateRangeMin)
Sets the date that represents the lower boundary for blog posts to be selected by the result filter. If this value is not set the results filter will be unbounded for the earliest publish date selected.

Setting a date range for a BlogTagResultFilter is a potential performance bottleneck. For example, if the argument for the date range is "new Date()" then the corresponding database query will map to an accuracy of a particular millesecond in time. This means that the results can't be cached. A better solution is to round dates to the nearest minute, hour, etc (whatever accuracy you need).

Parameters:
publishDateRangeMin - Date representing the filter lowest value of the publish date to be selected.

getPublishDateRangeMax

public java.util.Date getPublishDateRangeMax()
Returns a date that represents the upper boundry for tags to be selected by the result filter. If this value is not set it will return null and the results filter will be unbounded for the latest publish date selected.

Returns:
a Date representing the filter highest value of the publish date to be selected.

setPublishDateRangeMax

public void setPublishDateRangeMax(java.util.Date publishDateRangeMax)
Sets a date that represents the upper boundry for tags to be selected by the result filter. If this value is not set the results filter will be unbounded for the latest publish date selected. Setting a date range for a BlogTagResultFilter is a potential performance bottleneck. For example, if the argument for the date range is "new Date()" then the corresponding database query will map to an accuracy of a particular millesecond in time. This means that the results can't be cached. A better solution is to round dates to the nearest minute, hour, etc (whatever accuracy you need).

Parameters:
publishDateRangeMax - Date representing the filter lowest value of the publish date range.

equals

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

hashCode

public int hashCode()
Overrides:
hashCode in class TagResultFilter

Jive Product Page

Copyright © 1999-2007 Jive Software.