Package com.norconex.importer.handler.filter

Interface IDocumentFilter

All Superinterfaces:

IImporterHandler

All Known Implementing Classes:

AbstractCharStreamFilter, AbstractDocumentFilter, AbstractStringFilter, DateMetadataFilter, DOMContentFilter, DOMFilter, EmptyFilter, EmptyMetadataFilter, NumericMetadataFilter, ReferenceFilter, RegexContentFilter, RegexMetadataFilter, RegexReferenceFilter, RejectFilter, ScriptFilter, TextFilter

public interface IDocumentFilter
extends IImporterHandler

Filters documents. Rejected documents are no longer processed.

Author:

Pascal Essiembre

Method Summary

Modifier and Type	Method	Description
boolean	acceptDocument(HandlerDoc doc, InputStream input, ParseState parseState)	Whether to accepts a document.

Method Detail

acceptDocument

boolean acceptDocument(HandlerDoc doc,
                       InputStream input,
                       ParseState parseState)
                throws ImporterHandlerException

Whether to accepts a document.

Parameters:

doc - the document to evaluate

input - document content

parseState - whether the document has been parsed already or not (a parsed document should normally be text-based)

Returns:

true if document is accepted

Throws:

ImporterHandlerException - problem reading the document