Jive Forums API (5.5.20.2-oracle) Developer Javadocs

com.jivesoftware.forum.nntp
Class ArticleHeaderFilter

java.lang.Object
  extended by com.jivesoftware.forum.nntp.ArticleFilter
      extended by com.jivesoftware.forum.nntp.ArticleHeaderFilter

public class ArticleHeaderFilter
extends ArticleFilter

Filters article lists according normal range filtering plus header wildmat pattern matching.


Field Summary
 
Fields inherited from class com.jivesoftware.forum.nntp.ArticleFilter
ALL, ALL_ARTICLE_FILTER, CURRENT_ARTICLE, CURRENT_ARTICLE_FILTER, MESSAGE_ID, NUMBER, OPEN_RANGE, RANGE
 
Constructor Summary
ArticleHeaderFilter(java.lang.String headerName, java.lang.String range, Wildmat matcher)
          Create an article header filter with the given header name and wildmat pattern.
 
Method Summary
 java.lang.String getHeader()
          Obtains the name of the header that will have the wildmat pattern applied.
 Wildmat getWildmat()
          Sets the wildmat pattern for this filter to use when restricting matching articles.
 void setHeader(java.lang.String headerName)
          Sets the name of the header that will have the wildmat pattern applied.
 void setWildmat(Wildmat matcher)
          Sets the wildmat pattern matcher for this filter to use when restricting matching articles by header.
 
Methods inherited from class com.jivesoftware.forum.nntp.ArticleFilter
getArticleNumber, getEndIndex, getMessageID, getMode, getStartIndex, setRange
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ArticleHeaderFilter

public ArticleHeaderFilter(java.lang.String headerName,
                           java.lang.String range,
                           Wildmat matcher)

Create an article header filter with the given header name and wildmat pattern.

Parameters:
headerName - The header this filter will search
range - The range defining what articles to search
matcher - The pattern used to search the header
Method Detail

setHeader

public void setHeader(java.lang.String headerName)

Sets the name of the header that will have the wildmat pattern applied. Headers can only be one of the standard NNTP headers guaranteed to be on all articles (e.g. subject).

Parameters:
headerName - The header this filter uses (e.g. subject)

getHeader

public java.lang.String getHeader()

Obtains the name of the header that will have the wildmat pattern applied. Headers can only be one of the standard NNTP headers guaranteed to be on all articles (e.g. subject).

Returns:
The header this filter uses

setWildmat

public void setWildmat(Wildmat matcher)

Sets the wildmat pattern matcher for this filter to use when restricting matching articles by header.

Parameters:
matcher - The wildmat pattern

getWildmat

public Wildmat getWildmat()

Sets the wildmat pattern for this filter to use when restricting matching articles.

Returns:
The wildmat pattern

Jive Forums Project Page

Copyright © 1999-2006 Jive Software.