com.google.enterprise.connector.util.filter

Class AbstractDocumentFilter

java.lang.Object

com.google.enterprise.connector.util.filter.AbstractDocumentFilter

All Implemented Interfaces:

DocumentFilterFactory

Direct Known Subclasses:

AclPropertyFilter, AddPropertyFilter, CopyPropertyFilter, DeletePropertyFilter, ModifyPropertyFilter, SkipDocumentFilter

public abstract class AbstractDocumentFilter
extends java.lang.Object
implements DocumentFilterFactory

A base Document filter implementation that does nothing. It is meant to used as a base class for document filter subclasses. Subclasses are exected to override findProperty(Document, String) and/or getPropertyNames(Document), but not newDocumentFilter(Document).

Since:

2.8

Constructor Summary

Constructors

Constructor and Description
AbstractDocumentFilter()

Method Summary

Modifier and Type	Method and Description
Property	findProperty(Document source, java.lang.String name) Finds a Property by name.
java.util.Set<java.lang.String>	getPropertyNames(Document source) Gets the set of names of all Properties in the source Document.
java.util.List<Value>	getPropertyValues(Document source, java.lang.String name) Return a mutable list of all the existing Values of the named Property.
Document	newDocumentFilter(Document source) Returns a new Document that acts as a filter for the supplied source Document.
java.lang.String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

AbstractDocumentFilter

public AbstractDocumentFilter()

Method Detail

newDocumentFilter

public Document newDocumentFilter(Document source)
                           throws RepositoryException

Description copied from interface: DocumentFilterFactory

Returns a new Document that acts as a filter for the supplied source Document.

Specified by:

newDocumentFilter in interface DocumentFilterFactory

Parameters:

source - the input Document for the filter - must not be null

Returns:

a document filter

Throws:

RepositoryException - if there was a problem accessing the source

findProperty

public Property findProperty(Document source,
                             java.lang.String name)
                      throws RepositoryException

Finds a Property by name. If the source Document has a property of that name, then that property is returned.

Filter subclasses are likely to override this method.

Parameters:

source - the source Document for this filter

name - the name of the property to find

Returns:

the Property, if found; null otherwise

Throws:

RepositoryException - if a repository access error occurs

RepositoryDocumentException - if a document has fatal processing errors

getPropertyNames

public java.util.Set<java.lang.String> getPropertyNames(Document source)
                                                 throws RepositoryException

Gets the set of names of all Properties in the source Document.

Filter subclasses are likely to override this method.

Parameters:

source - the source Document for this filter

Returns:

the names, as a Set of Strings

Throws:

RepositoryException - if a repository access error occurs

RepositoryDocumentException - if a document has fatal processing errors

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getPropertyValues

public java.util.List<Value> getPropertyValues(Document source,
                                               java.lang.String name)
                                        throws RepositoryException

Return a mutable list of all the existing Values of the named Property. Subclasses might make use of this convenience method.

Parameters:

source - the source Document for this filter

name - the name of the Property whose values are to be fetched.

Returns:

a List of Values of the named property, or an empty list if the requested property does exist.

Throws:

RepositoryException - if a repository access error occurs

RepositoryDocumentException - if a document has fatal processing errors