com.exalead.indexing.analysis.v10

Class SemanticProcessor

java.lang.Object

com.exalead.indexing.analysis.v10.SemanticProcessor

All Implemented Interfaces:

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

Direct Known Subclasses:

AcronymDetector, Anchorer, AnnotationManager, Chunker, Classifier, CompoundWordSplitter, CustomSemanticProcessor, DebugSemanticProcessor, FarTextAnnotator, FastRulesMatcher, Lemmatizer, NamedEntitiesMatcher, NGramsExtractor, Normalizer, OntologyMatcher, PartOfSpeechTagger, Phonetizer, ProximityProcessor, RelatedTerms, RulesMatcher, SemanticExtractor, SentimentAnalyzer, SnowballStemmer, SQI

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

A SemanticProcessor applies semantic processing on the textual content of the DocumentChunks.
A Semantic Processor creates SemanticAnnotations on tokens.
These SemanticAnnotations can then be used in the Mapping.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

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

Field Summary

Fields

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
abstract <T> T	accept(SemanticProcessor.Transformer<T> transformer, T[] t)
abstract void	accept(SemanticProcessor.Visitor visitor)
void	check(boolean deep, java.lang.String errorContext) Checks this SemanticProcessor.
static SemanticProcessor	fromString(java.lang.String s) String representation of this SemanticProcessor.
java.lang.String	getContexts() Comma-separated list of the ContextNames of the Document Chunks on which this processor should be applied. If this list is empty, all DocumentChunks are processed.
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 semantic processor managed by a data model?
SemanticProcessor.FromDataModel	getFromDataModel()
java.lang.String	getName() Name of the Semantic Processor. This name is only used for tracing and debugging purposes.
boolean	isDisabled() Disables the DocumentProcessor
SemanticProcessor	makeCopy()
static SemanticProcessor	readFrom(java.io.InputStream is) Read this SemanticProcessor from an XML fragment.
void	setContexts(java.lang.String contexts) Comma-separated list of the ContextNames of the Document Chunks on which this processor should be applied. If this list is empty, all DocumentChunks are processed.
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 semantic processor managed by a data model?
void	setDisabled(boolean disabled) Disables the DocumentProcessor
void	setFromDataModel(SemanticProcessor.FromDataModel __value)
void	setName(java.lang.String name) Name of the Semantic Processor. This name is only used for tracing and debugging purposes.
java.lang.String	toString() String representation of this SemanticProcessor.
SemanticProcessor	withContexts(java.lang.String contexts)
SemanticProcessor	withDataModelClass(java.lang.String dataModelClass)
SemanticProcessor	withDataModelProperty(java.lang.String dataModelProperty)
SemanticProcessor	withDataModelState(java.lang.String dataModelState)
SemanticProcessor	withDisabled(boolean disabled)
SemanticProcessor	withDisabled(java.lang.Boolean disabled)
SemanticProcessor	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

name

public java.lang.String name

contexts

public java.lang.String contexts

fromDataModel

protected SemanticProcessor.FromDataModel fromDataModel

dataModelState

public java.lang.String dataModelState

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

SemanticProcessor

public SemanticProcessor()

SemanticProcessor

public SemanticProcessor(SemanticProcessor o)

Copy constructor

Method Detail

setName

public void setName(java.lang.String name)

Name of the Semantic Processor.
This name is only used for tracing and debugging purposes.

getName

public java.lang.String getName()

Name of the Semantic Processor.
This name is only used for tracing and debugging purposes.

withName

public SemanticProcessor withName(java.lang.String name)

setContexts

public void setContexts(java.lang.String contexts)

Comma-separated list of the ContextNames of the Document Chunks on which this processor should be applied.
If this list is empty, all DocumentChunks are processed.

getContexts

public java.lang.String getContexts()

Comma-separated list of the ContextNames of the Document Chunks on which this processor should be applied.
If this list is empty, all DocumentChunks are processed.

withContexts

public SemanticProcessor withContexts(java.lang.String contexts)

getFromDataModel

public SemanticProcessor.FromDataModel getFromDataModel()

setFromDataModel

public void setFromDataModel(SemanticProcessor.FromDataModel __value)

setDataModelState

public void setDataModelState(java.lang.String dataModelState)

Is this semantic processor managed by a data model?

getDataModelState

public java.lang.String getDataModelState()

Is this semantic processor managed by a data model?

withDataModelState

public SemanticProcessor withDataModelState(java.lang.String dataModelState)

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 SemanticProcessor 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 SemanticProcessor withDataModelProperty(java.lang.String dataModelProperty)

setDisabled

public void setDisabled(boolean disabled)

Disables the DocumentProcessor

isDisabled

public boolean isDisabled()

Disables the DocumentProcessor

withDisabled

public SemanticProcessor withDisabled(boolean disabled)

withDisabled

public SemanticProcessor withDisabled(java.lang.Boolean disabled)

makeCopy

public SemanticProcessor makeCopy()

readFrom

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

Read this SemanticProcessor 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 SemanticProcessor fromString(java.lang.String s)
                                    throws javax.xml.bind.JAXBException,
                                           java.io.UnsupportedEncodingException

String representation of this SemanticProcessor.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this SemanticProcessor.

Overrides:

toString in class java.lang.Object

check

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

Checks this SemanticProcessor.

Specified by:

check in interface com.exalead.util.Checkable

Throws:

com.exalead.util.TypedException

accept

public abstract void accept(SemanticProcessor.Visitor visitor)
                     throws com.exalead.util.TypedException

Throws:

com.exalead.util.TypedException

accept

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

Throws:

com.exalead.util.TypedException