com.google.enterprise.connector.util.filter

Interface DocumentFilterFactory

All Known Implementing Classes:

AbstractDocumentFilter, AclPropertyFilter, AddPropertyFilter, CopyPropertyFilter, DeletePropertyFilter, DocumentFilterChain, ModifyPropertyFilter, MovePropertyFilter, SkipDocumentFilter

public interface DocumentFilterFactory

An interface for factories that create Document filters. Document filter acts to transform the information retrieved from its source document. Typically document filters would add, remove, or modify a Document's Properties, including the document content. A document filter might even throw SkippedDocumentException to prevent a document from being fed to the GSA.

Multiple document filters may be chained together, forming a transformational document processing pipeline.

Since:

2.8

See Also:

DocumentFilterChain

Method Summary

Modifier and Type	Method and Description
Document	newDocumentFilter(Document source) Returns a new Document that acts as a filter for the supplied source Document.

Method Detail

newDocumentFilter

Document newDocumentFilter(Document source)
                    throws RepositoryException

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

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