com.exalead.indexing.analysis.v10

Class DocumentProcessor

java.lang.Object

com.exalead.indexing.analysis.v10.DocumentProcessor

All Implemented Interfaces:

com.exalead.util.Checkable, java.io.Serializable

Direct Known Subclasses:

CGRDocumentProcessor, ConvertTextExtractor, CustomDocumentProcessor, DataModelClassResolver, DebugCrashProcessor, DiscardDocument, DocumentProcessorGroup, HTMLCSSExtractor, HTMLCSSSelector, HTMLRelevantContentExtractor, HTMLTableExtractor, InferFileExtension, InsertCurrentDate, JavaDocumentProcessor, JavaScriptProcessor, MathDocumentProcessor, MetaFinder, MIMEDetector, MimeTypeSetter, MultiContextDocumentProcessor, NativeTextExtractor, NewChunk, PLMExpandDocumentProcessor, PrecomputedThumbnailsDocumentProcessor, PrintfValues, RealTimeAlerting, RemoteHTTPTransformer, RenameUnmappedContexts, ReplaceContextNames, SemanticPipeDocumentProcessor, SetDefaultValue, SimilarStringToPart, SingleContextDocumentProcessor, StandardPartsMerger, StorageServiceDocumentProcessor, UniformRandomContextGenerator, UnitsOfMeasurementNormalizer, XpathExtractor, XpathFragmentExtractor

public abstract class DocumentProcessor
extends java.lang.Object
implements com.exalead.util.Checkable, java.io.Serializable

Abstract class for a document processor.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DocumentProcessor.FromDataModel
static interface	DocumentProcessor.Transformer<T>

Field Summary

Fields

Modifier and Type	Field and Description
AcceptCondition	acceptCondition
java.lang.String	dataModelClass
java.lang.String	dataModelProperty
java.lang.String	dataModelState
static boolean	DEFAULT_DISABLED
boolean	disabled
protected DocumentProcessor.FromDataModel	fromDataModel
java.lang.String	name

Constructor Summary

Constructors

Constructor and Description
DocumentProcessor()
DocumentProcessor(DocumentProcessor o) Copy constructor

Method Summary

Modifier and Type	Method and Description
abstract <T> T	accept(DocumentProcessor.Transformer<T> transformer, T[] t)
void	check(boolean deep, java.lang.String errorContext) Checks this DocumentProcessor.
static DocumentProcessor	fromString(java.lang.String s) String representation of this DocumentProcessor.
AcceptCondition	getAcceptCondition() Expresses the enablement condition of this DocumentProcessor.
java.lang.String	getDataModelClass() If dataModelState is either "auto" or "customized", you will find here the name of the DataModelClass that generated this DocumentProcessor.
java.lang.String	getDataModelProperty() If dataModelState is either "auto" or "customized", you will find here the name of the DataModelProperty that generated this DocumentProcessor.
java.lang.String	getDataModelState() Is this document processor managed by a data model?
DocumentProcessor.FromDataModel	getFromDataModel()
java.lang.String	getName() Name of this processor.
boolean	isDisabled() Disable the DocumentProcessor
DocumentProcessor	makeCopy()
static DocumentProcessor	readFrom(java.io.InputStream is) Read this DocumentProcessor from an XML fragment.
void	setAcceptCondition(AcceptCondition acceptCondition) Expresses the enablement condition of this DocumentProcessor.
void	setDataModelClass(java.lang.String dataModelClass) If dataModelState is either "auto" or "customized", you will find here the name of the DataModelClass that generated this DocumentProcessor.
void	setDataModelProperty(java.lang.String dataModelProperty) If dataModelState is either "auto" or "customized", you will find here the name of the DataModelProperty that generated this DocumentProcessor.
void	setDataModelState(java.lang.String dataModelState) Is this document processor managed by a data model?
void	setDisabled(boolean disabled) Disable the DocumentProcessor
void	setFromDataModel(DocumentProcessor.FromDataModel __value)
void	setName(java.lang.String name) Name of this processor.
java.lang.String	toString() String representation of this DocumentProcessor.
DocumentProcessor	withAcceptCondition(AcceptCondition acceptCondition)
DocumentProcessor	withDataModelClass(java.lang.String dataModelClass)
DocumentProcessor	withDataModelProperty(java.lang.String dataModelProperty)
DocumentProcessor	withDataModelState(java.lang.String dataModelState)
DocumentProcessor	withDisabled(boolean disabled)
DocumentProcessor	withDisabled(java.lang.Boolean disabled)
DocumentProcessor	withName(java.lang.String name)
void	writeTo(java.io.OutputStream os)

Methods inherited from class java.lang.Object

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

Field Detail

acceptCondition

public AcceptCondition acceptCondition

name

public java.lang.String name

dataModelState

public java.lang.String dataModelState

fromDataModel

protected DocumentProcessor.FromDataModel fromDataModel

dataModelClass

public java.lang.String dataModelClass

dataModelProperty

public java.lang.String dataModelProperty

disabled

public boolean disabled

DEFAULT_DISABLED

public static final boolean DEFAULT_DISABLED

See Also:

Constant Field Values

Constructor Detail

DocumentProcessor

public DocumentProcessor()

DocumentProcessor

public DocumentProcessor(DocumentProcessor o)

Copy constructor

Method Detail

setAcceptCondition

public void setAcceptCondition(AcceptCondition acceptCondition)

Expresses the enablement condition of this DocumentProcessor.

getAcceptCondition

public AcceptCondition getAcceptCondition()

Expresses the enablement condition of this DocumentProcessor.

withAcceptCondition

public DocumentProcessor withAcceptCondition(AcceptCondition acceptCondition)

setName

public void setName(java.lang.String name)

Name of this processor.
The name of a processor is used only for tracing and debugging purposes.

getName

public java.lang.String getName()

Name of this processor.
The name of a processor is used only for tracing and debugging purposes.

withName

public DocumentProcessor withName(java.lang.String name)

setDataModelState

public void setDataModelState(java.lang.String dataModelState)

Is this document processor managed by a data model?

getDataModelState

public java.lang.String getDataModelState()

Is this document processor managed by a data model?

withDataModelState

public DocumentProcessor withDataModelState(java.lang.String dataModelState)

getFromDataModel

public DocumentProcessor.FromDataModel getFromDataModel()

setFromDataModel

public void setFromDataModel(DocumentProcessor.FromDataModel __value)

setDataModelClass

public void setDataModelClass(java.lang.String dataModelClass)

If dataModelState is either "auto" or "customized", you will find here the
name of the DataModelClass that generated this DocumentProcessor.

getDataModelClass

public java.lang.String getDataModelClass()

If dataModelState is either "auto" or "customized", you will find here the
name of the DataModelClass that generated this DocumentProcessor.

withDataModelClass

public DocumentProcessor withDataModelClass(java.lang.String dataModelClass)

setDataModelProperty

public void setDataModelProperty(java.lang.String dataModelProperty)

If dataModelState is either "auto" or "customized", you will find here the
name of the DataModelProperty that generated this DocumentProcessor.

getDataModelProperty

public java.lang.String getDataModelProperty()

If dataModelState is either "auto" or "customized", you will find here the
name of the DataModelProperty that generated this DocumentProcessor.

withDataModelProperty

public DocumentProcessor withDataModelProperty(java.lang.String dataModelProperty)

setDisabled

public void setDisabled(boolean disabled)

Disable the DocumentProcessor

isDisabled

public boolean isDisabled()

Disable the DocumentProcessor

withDisabled

public DocumentProcessor withDisabled(boolean disabled)

withDisabled

public DocumentProcessor withDisabled(java.lang.Boolean disabled)

makeCopy

public DocumentProcessor makeCopy()

readFrom

public static DocumentProcessor readFrom(java.io.InputStream is)
                                  throws javax.xml.bind.JAXBException

Read this DocumentProcessor from an XML fragment.

Throws:

javax.xml.bind.JAXBException

writeTo

public void writeTo(java.io.OutputStream os)
             throws javax.xml.bind.JAXBException,
                    java.io.IOException

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

public static DocumentProcessor fromString(java.lang.String s)
                                    throws javax.xml.bind.JAXBException,
                                           java.io.UnsupportedEncodingException

String representation of this DocumentProcessor.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this DocumentProcessor.

Overrides:

toString in class java.lang.Object

check

public void check(boolean deep,
                  java.lang.String errorContext)
           throws com.exalead.util.TypedException

Checks this DocumentProcessor.

Specified by:

check in interface com.exalead.util.Checkable

Throws:

com.exalead.util.TypedException

accept

public abstract <T> T accept(DocumentProcessor.Transformer<T> transformer,
                             T[] t)
                      throws com.exalead.util.TypedException

Throws:

com.exalead.util.TypedException