com.exalead.indexing.analysis.v10

Class JavaDocumentProcessor

java.lang.Object

com.exalead.indexing.analysis.v10.DocumentProcessor

com.exalead.indexing.analysis.v10.JavaDocumentProcessor

All Implemented Interfaces:

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

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

Takes Java code either inline or from a file, and executes it on-the-fly.
For production mode, we recommend packaging your custom code as a Java Plugin (CVPlugin) and using the Custom Document Processor to call it.
Plugins allow better packaging and source code maintenance. Note that this processor does not work when the Java JVM used to run Cloudview is only a JRE and not a JDK

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	path
int	priority
java.lang.String	sourceCode

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
JavaDocumentProcessor()
JavaDocumentProcessor(JavaDocumentProcessor 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 JavaDocumentProcessor.
static JavaDocumentProcessor	fromString(java.lang.String s) String representation of this JavaDocumentProcessor.
java.lang.String	getPath() User defined path to a Java file containing the processor code
int	getPriority() Defines which path to use (0: user defined path, 1: resource managed path (inlined Java))
java.lang.String	getSourceCode() Inline Java code
JavaDocumentProcessor	makeCopy() Creates and returns a deep copy of this JavaDocumentProcessor.
static JavaDocumentProcessor	readFrom(java.io.InputStream is) Read this JavaDocumentProcessor from an XML fragment.
void	setPath(java.lang.String path) User defined path to a Java file containing the processor code
void	setPriority(int priority) Defines which path to use (0: user defined path, 1: resource managed path (inlined Java))
void	setSourceCode(java.lang.String sourceCode) Inline Java code
java.lang.String	toString() String representation of this JavaDocumentProcessor.
JavaDocumentProcessor	withAcceptCondition(AcceptCondition acceptCondition)
JavaDocumentProcessor	withDataModelClass(java.lang.String dataModelClass)
JavaDocumentProcessor	withDataModelProperty(java.lang.String dataModelProperty)
JavaDocumentProcessor	withDataModelState(java.lang.String dataModelState)
JavaDocumentProcessor	withDisabled(boolean disabled)
JavaDocumentProcessor	withDisabled(java.lang.Boolean disabled)
JavaDocumentProcessor	withFromDataModel(DocumentProcessor fromDataModel)
JavaDocumentProcessor	withName(java.lang.String name)
JavaDocumentProcessor	withPath(java.lang.String path)
JavaDocumentProcessor	withPriority(int priority)
JavaDocumentProcessor	withPriority(java.lang.Integer priority)
JavaDocumentProcessor	withSourceCode(java.lang.String sourceCode)
void	writeTo(java.io.OutputStream os) Write this JavaDocumentProcessor 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

path

public java.lang.String path

priority

public int priority

sourceCode

public java.lang.String sourceCode

Constructor Detail

JavaDocumentProcessor

public JavaDocumentProcessor()

JavaDocumentProcessor

public JavaDocumentProcessor(JavaDocumentProcessor o)

Copy constructor

Method Detail

withAcceptCondition

public JavaDocumentProcessor withAcceptCondition(AcceptCondition acceptCondition)

Overrides:

withAcceptCondition in class DocumentProcessor

withName

public JavaDocumentProcessor withName(java.lang.String name)

Overrides:

withName in class DocumentProcessor

withDataModelState

public JavaDocumentProcessor withDataModelState(java.lang.String dataModelState)

Overrides:

withDataModelState in class DocumentProcessor

withFromDataModel

public JavaDocumentProcessor withFromDataModel(DocumentProcessor fromDataModel)

withDataModelClass

public JavaDocumentProcessor withDataModelClass(java.lang.String dataModelClass)

Overrides:

withDataModelClass in class DocumentProcessor

withDataModelProperty

public JavaDocumentProcessor withDataModelProperty(java.lang.String dataModelProperty)

Overrides:

withDataModelProperty in class DocumentProcessor

withDisabled

public JavaDocumentProcessor withDisabled(boolean disabled)

Overrides:

withDisabled in class DocumentProcessor

withDisabled

public JavaDocumentProcessor withDisabled(java.lang.Boolean disabled)

Overrides:

withDisabled in class DocumentProcessor

setPath

public void setPath(java.lang.String path)

User defined path to a Java file containing the processor code

getPath

public java.lang.String getPath()

User defined path to a Java file containing the processor code

withPath

public JavaDocumentProcessor withPath(java.lang.String path)

setPriority

public void setPriority(int priority)

Defines which path to use (0: user defined path, 1: resource managed path (inlined Java))

getPriority

public int getPriority()

Defines which path to use (0: user defined path, 1: resource managed path (inlined Java))

withPriority

public JavaDocumentProcessor withPriority(int priority)

withPriority

public JavaDocumentProcessor withPriority(java.lang.Integer priority)

setSourceCode

public void setSourceCode(java.lang.String sourceCode)

Inline Java code

getSourceCode

public java.lang.String getSourceCode()

Inline Java code

withSourceCode

public JavaDocumentProcessor withSourceCode(java.lang.String sourceCode)

makeCopy

public JavaDocumentProcessor makeCopy()

Creates and returns a deep copy of this JavaDocumentProcessor.

Overrides:

makeCopy in class DocumentProcessor

readFrom

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

Read this JavaDocumentProcessor 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 JavaDocumentProcessor as an XML fragment

Overrides:

writeTo in class DocumentProcessor

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this JavaDocumentProcessor.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this JavaDocumentProcessor.

Overrides:

toString in class DocumentProcessor

check

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

Checks this JavaDocumentProcessor.

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