com.exalead.indexing.analysis.v10

Class FarTextAnnotator

java.lang.Object

com.exalead.indexing.analysis.v10.SemanticProcessor

com.exalead.indexing.analysis.v10.FarTextAnnotator

All Implemented Interfaces:

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

public class FarTextAnnotator
extends SemanticProcessor
implements com.exalead.util.Checkable, java.io.Serializable

A FarTextAnnotator annotates alphanumeric tokens with 'annotation' if they are farther than 'startOffset'

See Also:

Serialized Form

Nested Class Summary

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

SemanticProcessor.FromDataModel, SemanticProcessor.Transformer<T>, SemanticProcessor.Visitor

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	annotation
static java.lang.String	DEFAULT_ANNOTATION
static int	DEFAULT_START_OFFSET
int	startOffset

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

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
<T> T	accept(SemanticProcessor.Transformer<T> transformer, T[] t)
void	accept(SemanticProcessor.Visitor visitor)
void	check(boolean deep, java.lang.String errorContext) Checks this FarTextAnnotator.
static FarTextAnnotator	fromString(java.lang.String s) String representation of this FarTextAnnotator.
java.lang.String	getAnnotation()
int	getStartOffset()
FarTextAnnotator	makeCopy() Creates and returns a deep copy of this FarTextAnnotator.
static FarTextAnnotator	readFrom(java.io.InputStream is) Read this FarTextAnnotator from an XML fragment.
void	setAnnotation(java.lang.String annotation)
void	setStartOffset(int startOffset)
java.lang.String	toString() String representation of this FarTextAnnotator.
FarTextAnnotator	withAnnotation(java.lang.String annotation)
FarTextAnnotator	withContexts(java.lang.String contexts)
FarTextAnnotator	withDataModelClass(java.lang.String dataModelClass)
FarTextAnnotator	withDataModelProperty(java.lang.String dataModelProperty)
FarTextAnnotator	withDataModelState(java.lang.String dataModelState)
FarTextAnnotator	withDisabled(boolean disabled)
FarTextAnnotator	withDisabled(java.lang.Boolean disabled)
FarTextAnnotator	withFromDataModel(SemanticProcessor fromDataModel)
FarTextAnnotator	withName(java.lang.String name)
FarTextAnnotator	withStartOffset(int startOffset)
FarTextAnnotator	withStartOffset(java.lang.Integer startOffset)
void	writeTo(java.io.OutputStream os) Write this FarTextAnnotator as an XML fragment

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

getContexts, getDataModelClass, getDataModelProperty, getDataModelState, getFromDataModel, getName, isDisabled, setContexts, 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

startOffset

public int startOffset

DEFAULT_START_OFFSET

public static final int DEFAULT_START_OFFSET

See Also:

Constant Field Values

annotation

public java.lang.String annotation

DEFAULT_ANNOTATION

public static final java.lang.String DEFAULT_ANNOTATION

See Also:

Constant Field Values

Constructor Detail

FarTextAnnotator

public FarTextAnnotator()

FarTextAnnotator

public FarTextAnnotator(FarTextAnnotator o)

Copy constructor

Method Detail

withName

public FarTextAnnotator withName(java.lang.String name)

Overrides:

withName in class SemanticProcessor

withContexts

public FarTextAnnotator withContexts(java.lang.String contexts)

Overrides:

withContexts in class SemanticProcessor

withFromDataModel

public FarTextAnnotator withFromDataModel(SemanticProcessor fromDataModel)

withDataModelState

public FarTextAnnotator withDataModelState(java.lang.String dataModelState)

Overrides:

withDataModelState in class SemanticProcessor

withDataModelClass

public FarTextAnnotator withDataModelClass(java.lang.String dataModelClass)

Overrides:

withDataModelClass in class SemanticProcessor

withDataModelProperty

public FarTextAnnotator withDataModelProperty(java.lang.String dataModelProperty)

Overrides:

withDataModelProperty in class SemanticProcessor

withDisabled

public FarTextAnnotator withDisabled(boolean disabled)

Overrides:

withDisabled in class SemanticProcessor

withDisabled

public FarTextAnnotator withDisabled(java.lang.Boolean disabled)

Overrides:

withDisabled in class SemanticProcessor

setStartOffset

public void setStartOffset(int startOffset)

getStartOffset

public int getStartOffset()

withStartOffset

public FarTextAnnotator withStartOffset(int startOffset)

withStartOffset

public FarTextAnnotator withStartOffset(java.lang.Integer startOffset)

setAnnotation

public void setAnnotation(java.lang.String annotation)

getAnnotation

public java.lang.String getAnnotation()

withAnnotation

public FarTextAnnotator withAnnotation(java.lang.String annotation)

makeCopy

public FarTextAnnotator makeCopy()

Creates and returns a deep copy of this FarTextAnnotator.

Overrides:

makeCopy in class SemanticProcessor

readFrom

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

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

Overrides:

writeTo in class SemanticProcessor

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this FarTextAnnotator.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this FarTextAnnotator.

Overrides:

toString in class SemanticProcessor

check

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

Checks this FarTextAnnotator.

Specified by:

check in interface com.exalead.util.Checkable

Overrides:

check in class SemanticProcessor

Throws:

com.exalead.util.TypedException

accept

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

Specified by:

accept in class SemanticProcessor

Throws:

com.exalead.util.TypedException

accept

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

Specified by:

accept in class SemanticProcessor

Throws:

com.exalead.util.TypedException