com.exalead.indexing.analysis.v10

Class CustomDocumentProcessor

java.lang.Object

com.exalead.indexing.analysis.v10.DocumentProcessor

com.exalead.indexing.analysis.v10.CustomDocumentProcessor

All Implemented Interfaces:

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

public class CustomDocumentProcessor
extends DocumentProcessor
implements com.exalead.util.Checkable, java.io.Serializable

A Custom document processor allows you to plug in custom code packaged as a CVPlugin into the document processing pipeline.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.exalead.indexing.analysis.v10.DocumentProcessor

DocumentProcessor.FromDataModel, DocumentProcessor.Transformer<T>

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	classId
java.util.List<KeyValue>	keyValue

Fields inherited from class com.exalead.indexing.analysis.v10.DocumentProcessor

acceptCondition, dataModelClass, dataModelProperty, dataModelState, DEFAULT_DISABLED, disabled, fromDataModel, name

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
<T> T	accept(DocumentProcessor.Transformer<T> transformer, T[] t)
void	check(boolean deep, java.lang.String errorContext) Checks this CustomDocumentProcessor.
static CustomDocumentProcessor	fromString(java.lang.String s) String representation of this CustomDocumentProcessor.
java.lang.String	getClassId() Class identifier. The specified class must implement the com.exalead.pdoc.analysis.CustomDocumentProcessor Java Interface.
java.util.List<KeyValue>	getKeyValue()
CustomDocumentProcessor	makeCopy() Creates and returns a deep copy of this CustomDocumentProcessor.
static CustomDocumentProcessor	readFrom(java.io.InputStream is) Read this CustomDocumentProcessor from an XML fragment.
void	setClassId(java.lang.String classId) Class identifier. The specified class must implement the com.exalead.pdoc.analysis.CustomDocumentProcessor Java Interface.
java.lang.String	toString() String representation of this CustomDocumentProcessor.
CustomDocumentProcessor	withAcceptCondition(AcceptCondition acceptCondition)
CustomDocumentProcessor	withClassId(java.lang.String classId)
CustomDocumentProcessor	withDataModelClass(java.lang.String dataModelClass)
CustomDocumentProcessor	withDataModelProperty(java.lang.String dataModelProperty)
CustomDocumentProcessor	withDataModelState(java.lang.String dataModelState)
CustomDocumentProcessor	withDisabled(boolean disabled)
CustomDocumentProcessor	withDisabled(java.lang.Boolean disabled)
CustomDocumentProcessor	withFromDataModel(DocumentProcessor fromDataModel)
CustomDocumentProcessor	withKeyValue(java.util.Collection<KeyValue> __values)
CustomDocumentProcessor	withKeyValue(KeyValue... __values)
CustomDocumentProcessor	withName(java.lang.String name)
void	writeTo(java.io.OutputStream os) Write this CustomDocumentProcessor as an XML fragment

Methods inherited from class com.exalead.indexing.analysis.v10.DocumentProcessor

getAcceptCondition, getDataModelClass, getDataModelProperty, getDataModelState, getFromDataModel, getName, isDisabled, setAcceptCondition, setDataModelClass, setDataModelProperty, setDataModelState, setDisabled, setFromDataModel, setName

Methods inherited from class java.lang.Object

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

Field Detail

keyValue

public java.util.List<KeyValue> keyValue

classId

public java.lang.String classId

Constructor Detail

CustomDocumentProcessor

public CustomDocumentProcessor()

CustomDocumentProcessor

public CustomDocumentProcessor(CustomDocumentProcessor o)

Copy constructor

Method Detail

withAcceptCondition

public CustomDocumentProcessor withAcceptCondition(AcceptCondition acceptCondition)

Overrides:

withAcceptCondition in class DocumentProcessor

withName

public CustomDocumentProcessor withName(java.lang.String name)

Overrides:

withName in class DocumentProcessor

withDataModelState

public CustomDocumentProcessor withDataModelState(java.lang.String dataModelState)

Overrides:

withDataModelState in class DocumentProcessor

withFromDataModel

public CustomDocumentProcessor withFromDataModel(DocumentProcessor fromDataModel)

withDataModelClass

public CustomDocumentProcessor withDataModelClass(java.lang.String dataModelClass)

Overrides:

withDataModelClass in class DocumentProcessor

withDataModelProperty

public CustomDocumentProcessor withDataModelProperty(java.lang.String dataModelProperty)

Overrides:

withDataModelProperty in class DocumentProcessor

withDisabled

public CustomDocumentProcessor withDisabled(boolean disabled)

Overrides:

withDisabled in class DocumentProcessor

withDisabled

public CustomDocumentProcessor withDisabled(java.lang.Boolean disabled)

Overrides:

withDisabled in class DocumentProcessor

getKeyValue

public java.util.List<KeyValue> getKeyValue()

withKeyValue

public CustomDocumentProcessor withKeyValue(KeyValue... __values)

withKeyValue

public CustomDocumentProcessor withKeyValue(java.util.Collection<KeyValue> __values)

setClassId

public void setClassId(java.lang.String classId)

Class identifier.
The specified class must implement the com.exalead.pdoc.analysis.CustomDocumentProcessor Java Interface.

getClassId

public java.lang.String getClassId()

Class identifier.
The specified class must implement the com.exalead.pdoc.analysis.CustomDocumentProcessor Java Interface.

withClassId

public CustomDocumentProcessor withClassId(java.lang.String classId)

makeCopy

public CustomDocumentProcessor makeCopy()

Creates and returns a deep copy of this CustomDocumentProcessor.

Overrides:

makeCopy in class DocumentProcessor

readFrom

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

Read this CustomDocumentProcessor 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

Write this CustomDocumentProcessor as an XML fragment

Overrides:

writeTo in class DocumentProcessor

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this CustomDocumentProcessor.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this CustomDocumentProcessor.

Overrides:

toString in class DocumentProcessor

check

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

Checks this CustomDocumentProcessor.

Specified by:

check in interface com.exalead.util.Checkable

Overrides:

check in class DocumentProcessor

Throws:

com.exalead.util.TypedException

accept

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

Specified by:

accept in class DocumentProcessor

Throws:

com.exalead.util.TypedException