com.norconex.importer.handler.filter

Interface IDocumentFilter

All Superinterfaces:

IImporterHandler

All Known Implementing Classes:

AbstractCharStreamFilter, AbstractDocumentFilter, AbstractStringFilter, DateMetadataFilter, DOMContentFilter, EmptyMetadataFilter, NumericMetadataFilter, RegexContentFilter, RegexMetadataFilter, RegexReferenceFilter, ScriptFilter

public interface IDocumentFilter
extends IImporterHandler

Filters documents. Rejected documents are no longer processed.

Author:

Pascal Essiembre

Method Summary

Modifier and Type	Method and Description
boolean	acceptDocument(String reference, InputStream document, ImporterMetadata metadata, boolean parsed) Whether to accepts a document.

Method Detail

acceptDocument

boolean acceptDocument(String reference,
                       InputStream document,
                       ImporterMetadata metadata,
                       boolean parsed)
                throws ImporterHandlerException

Whether to accepts a document.

Parameters:

reference - document reference

document - the document to evaluate

metadata - document metadata

parsed - 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