com.exalead.indexing.analysis.v10

Class ProximityProcessor

java.lang.Object

com.exalead.indexing.analysis.v10.SemanticProcessor

com.exalead.indexing.analysis.v10.ProximityProcessor

All Implemented Interfaces:

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

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

A proximity processor detects and annotates pieces of text where several annotations occur given distance constraints. Possible constraints (non mutually exclusive):

• token window size
• distance between annotations
• sentence/paragraph scope

Annotations generated:

• Depending on the resource (See Proximity)

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	resourceFile

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
ProximityProcessor()
ProximityProcessor(ProximityProcessor 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 ProximityProcessor.
static ProximityProcessor	fromString(java.lang.String s) String representation of this ProximityProcessor.
java.lang.String	getResourceFile() URL for the resource (data://, file:// or resource://)
ProximityProcessor	makeCopy() Creates and returns a deep copy of this ProximityProcessor.
static ProximityProcessor	readFrom(java.io.InputStream is) Read this ProximityProcessor from an XML fragment.
void	setResourceFile(java.lang.String resourceFile) URL for the resource (data://, file:// or resource://)
java.lang.String	toString() String representation of this ProximityProcessor.
ProximityProcessor	withContexts(java.lang.String contexts)
ProximityProcessor	withDataModelClass(java.lang.String dataModelClass)
ProximityProcessor	withDataModelProperty(java.lang.String dataModelProperty)
ProximityProcessor	withDataModelState(java.lang.String dataModelState)
ProximityProcessor	withDisabled(boolean disabled)
ProximityProcessor	withDisabled(java.lang.Boolean disabled)
ProximityProcessor	withFromDataModel(SemanticProcessor fromDataModel)
ProximityProcessor	withName(java.lang.String name)
ProximityProcessor	withResourceFile(java.lang.String resourceFile)
void	writeTo(java.io.OutputStream os) Write this ProximityProcessor 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

resourceFile

public java.lang.String resourceFile

Constructor Detail

ProximityProcessor

public ProximityProcessor()

ProximityProcessor

public ProximityProcessor(ProximityProcessor o)

Copy constructor

Method Detail

withName

public ProximityProcessor withName(java.lang.String name)

Overrides:

withName in class SemanticProcessor

withContexts

public ProximityProcessor withContexts(java.lang.String contexts)

Overrides:

withContexts in class SemanticProcessor

withFromDataModel

public ProximityProcessor withFromDataModel(SemanticProcessor fromDataModel)

withDataModelState

public ProximityProcessor withDataModelState(java.lang.String dataModelState)

Overrides:

withDataModelState in class SemanticProcessor

withDataModelClass

public ProximityProcessor withDataModelClass(java.lang.String dataModelClass)

Overrides:

withDataModelClass in class SemanticProcessor

withDataModelProperty

public ProximityProcessor withDataModelProperty(java.lang.String dataModelProperty)

Overrides:

withDataModelProperty in class SemanticProcessor

withDisabled

public ProximityProcessor withDisabled(boolean disabled)

Overrides:

withDisabled in class SemanticProcessor

withDisabled

public ProximityProcessor withDisabled(java.lang.Boolean disabled)

Overrides:

withDisabled in class SemanticProcessor

setResourceFile

public void setResourceFile(java.lang.String resourceFile)

URL for the resource (data://, file:// or resource://)

getResourceFile

public java.lang.String getResourceFile()

URL for the resource (data://, file:// or resource://)

withResourceFile

public ProximityProcessor withResourceFile(java.lang.String resourceFile)

makeCopy

public ProximityProcessor makeCopy()

Creates and returns a deep copy of this ProximityProcessor.

Overrides:

makeCopy in class SemanticProcessor

readFrom

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

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

Overrides:

writeTo in class SemanticProcessor

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this ProximityProcessor.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this ProximityProcessor.

Overrides:

toString in class SemanticProcessor

check

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

Checks this ProximityProcessor.

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