prajna.data.query

Class DocFilter

java.lang.Object

prajna.data.DataFilter

prajna.data.query.DocFilter

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

GeoDocFilter, MatchFilter, NotClause, ProximitySearch, RangeFilter, SearchTerm, TreeClause

public abstract class DocFilter
extends DataFilter

Abstract Document Filter class which filters document record objects, referenced by the DocData class, as well as DataRecord objects. This class supports automatic tagging of documents which match a particular filter or sub-filter.

Author:

Edward Swing

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
DocFilter()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	accept(DocData doc) Return whether the represented document is accepted by this filter.
java.util.Set<DocData>	filterDocuments(java.util.Collection<DocData> documents) Filter a collection of documents.
java.lang.String	getTag() Get the tag for this document filter.
protected abstract boolean	matchDoc(DocData doc) Return whether the represented document is accepted by this filter.
void	setTag(java.lang.String tagString) Set the tag for this document filter.

Methods inherited from class prajna.data.DataFilter

accept, filterRecords

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DocFilter

public DocFilter()

Method Detail

accept

public boolean accept(DocData doc)

Return whether the represented document is accepted by this filter. If so, and if the tag has been set, the tag is added to the set of document tags. This method calls matchDoc to determine if the document matches.

Parameters:

doc - the document record to match.

Returns:

true if the document matches the filter, false otherwise

filterDocuments

public java.util.Set<DocData> filterDocuments(java.util.Collection<DocData> documents)

Filter a collection of documents. Only those documents which match this filter will be returned.

Parameters:

documents - a collection of documents

Returns:

The set of documents which match the filter

getTag

public java.lang.String getTag()

Get the tag for this document filter.

Returns:

the tag for this filter

matchDoc

protected abstract boolean matchDoc(DocData doc)

Return whether the represented document is accepted by this filter.

Parameters:

doc - the document record to match.

Returns:

true if the document matches the filter, false otherwise

setTag

public void setTag(java.lang.String tagString)

Set the tag for this document filter. The tag is added to the document tags if the filter matches a document.

Parameters:

tagString - the tag for this filter