com.exalead.linguistic.v10

Class Proximity

java.lang.Object

com.exalead.linguistic.v10.SemanticProcessor

com.exalead.linguistic.v10.Proximity

All Implemented Interfaces:

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

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

Annotates pieces of text where a number of annotations appear close to each other

See Also:

Serialized Form

Nested Class Summary

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

SemanticProcessor.Transformer<T>, SemanticProcessor.Visitor

Field Summary

Fields

Modifier and Type	Field and Description
boolean	allowElementOverlap
java.lang.String	annotation
static boolean	DEFAULT_ALLOW_ELEMENT_OVERLAP
static java.lang.String	DEFAULT_ANNOTATION
static java.lang.String	DEFAULT_DISPLAY_FORM
static int	DEFAULT_MAX_DISTANCE
static int	DEFAULT_MIN_DISTANCE
static boolean	DEFAULT_ORDERED
static boolean	DEFAULT_PARAGRAPH_SCOPE
static boolean	DEFAULT_SENTENCE_SCOPE
static int	DEFAULT_WINDOW_SIZE
java.lang.String	displayForm
int	maxDistance
int	minDistance
boolean	ordered
boolean	paragraphScope
java.util.List<ProximityElement>	proximityElement
java.lang.String	resourceFile
boolean	sentenceScope
int	windowSize

Fields inherited from class com.exalead.linguistic.v10.SemanticProcessor

contexts, name, src

Constructor Summary

Constructors

Constructor and Description
Proximity()
Proximity(Proximity 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 Proximity.
static Proximity	fromString(java.lang.String s) String representation of this Proximity.
java.lang.String	getAnnotation() Output annotation
java.lang.String	getDisplayForm() Optional format for the output annotation display form: elements can be referred to using their $names
int	getMaxDistance() The maximum distance between two elements in terms of token
int	getMinDistance() The minimum distance between two elements in terms of token
java.util.List<ProximityElement>	getProximityElement() The set of annotations to search for
java.lang.String	getResourceFile() URL for the resource if not inline (data://, file:// or resource:// )
int	getWindowSize() Maximum size of a match in terms of token
boolean	isAllowElementOverlap() If TRUE, reports also matches where annotations overlap
boolean	isOrdered() If TRUE, forces the processor to match the annotations in definition order
boolean	isParagraphScope() If TRUE, each match is to be contained in a paragraph, no match will span several paragraphs
boolean	isSentenceScope() If TRUE, each match is to be contained in a sentence, no match will span several sentences
Proximity	makeCopy() Creates and returns a deep copy of this Proximity.
static Proximity	readFrom(java.io.InputStream is) Read this Proximity from an XML fragment.
void	setAllowElementOverlap(boolean allowElementOverlap) If TRUE, reports also matches where annotations overlap
void	setAnnotation(java.lang.String annotation) Output annotation
void	setDisplayForm(java.lang.String displayForm) Optional format for the output annotation display form: elements can be referred to using their $names
void	setMaxDistance(int maxDistance) The maximum distance between two elements in terms of token
void	setMinDistance(int minDistance) The minimum distance between two elements in terms of token
void	setOrdered(boolean ordered) If TRUE, forces the processor to match the annotations in definition order
void	setParagraphScope(boolean paragraphScope) If TRUE, each match is to be contained in a paragraph, no match will span several paragraphs
void	setResourceFile(java.lang.String resourceFile) URL for the resource if not inline (data://, file:// or resource:// )
void	setSentenceScope(boolean sentenceScope) If TRUE, each match is to be contained in a sentence, no match will span several sentences
void	setWindowSize(int windowSize) Maximum size of a match in terms of token
java.lang.String	toString() String representation of this Proximity.
Proximity	withAllowElementOverlap(boolean allowElementOverlap)
Proximity	withAllowElementOverlap(java.lang.Boolean allowElementOverlap)
Proximity	withAnnotation(java.lang.String annotation)
Proximity	withContexts(java.lang.String contexts)
Proximity	withDisplayForm(java.lang.String displayForm)
Proximity	withMaxDistance(int maxDistance)
Proximity	withMaxDistance(java.lang.Integer maxDistance)
Proximity	withMinDistance(int minDistance)
Proximity	withMinDistance(java.lang.Integer minDistance)
Proximity	withName(java.lang.String name)
Proximity	withOrdered(boolean ordered)
Proximity	withOrdered(java.lang.Boolean ordered)
Proximity	withParagraphScope(boolean paragraphScope)
Proximity	withParagraphScope(java.lang.Boolean paragraphScope)
Proximity	withProximityElement(java.util.Collection<ProximityElement> __values)
Proximity	withProximityElement(ProximityElement... __values) The set of annotations to search for
Proximity	withResourceFile(java.lang.String resourceFile)
Proximity	withSentenceScope(boolean sentenceScope)
Proximity	withSentenceScope(java.lang.Boolean sentenceScope)
Proximity	withSrc(java.lang.String src) Deprecated.
Proximity	withWindowSize(int windowSize)
Proximity	withWindowSize(java.lang.Integer windowSize)
void	writeTo(java.io.OutputStream os) Write this Proximity as an XML fragment

Methods inherited from class com.exalead.linguistic.v10.SemanticProcessor

getContexts, getName, getSrc, setContexts, setName, setSrc

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

annotation

public java.lang.String annotation

DEFAULT_ANNOTATION

public static final java.lang.String DEFAULT_ANNOTATION

See Also:

Constant Field Values

displayForm

public java.lang.String displayForm

DEFAULT_DISPLAY_FORM

public static final java.lang.String DEFAULT_DISPLAY_FORM

See Also:

Constant Field Values

proximityElement

public java.util.List<ProximityElement> proximityElement

ordered

public boolean ordered

DEFAULT_ORDERED

public static final boolean DEFAULT_ORDERED

See Also:

Constant Field Values

sentenceScope

public boolean sentenceScope

DEFAULT_SENTENCE_SCOPE

public static final boolean DEFAULT_SENTENCE_SCOPE

See Also:

Constant Field Values

paragraphScope

public boolean paragraphScope

DEFAULT_PARAGRAPH_SCOPE

public static final boolean DEFAULT_PARAGRAPH_SCOPE

See Also:

Constant Field Values

windowSize

public int windowSize

DEFAULT_WINDOW_SIZE

public static final int DEFAULT_WINDOW_SIZE

See Also:

Constant Field Values

minDistance

public int minDistance

DEFAULT_MIN_DISTANCE

public static final int DEFAULT_MIN_DISTANCE

See Also:

Constant Field Values

maxDistance

public int maxDistance

DEFAULT_MAX_DISTANCE

public static final int DEFAULT_MAX_DISTANCE

See Also:

Constant Field Values

allowElementOverlap

public boolean allowElementOverlap

DEFAULT_ALLOW_ELEMENT_OVERLAP

public static final boolean DEFAULT_ALLOW_ELEMENT_OVERLAP

See Also:

Constant Field Values

Constructor Detail

Proximity

public Proximity()

Proximity

public Proximity(Proximity o)

Copy constructor

Method Detail

withName

public Proximity withName(java.lang.String name)

Overrides:

withName in class SemanticProcessor

withContexts

public Proximity withContexts(java.lang.String contexts)

Overrides:

withContexts in class SemanticProcessor

withSrc

@Deprecated
public Proximity withSrc(java.lang.String src)

Deprecated.

Overrides:

withSrc in class SemanticProcessor

setResourceFile

public void setResourceFile(java.lang.String resourceFile)

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

getResourceFile

public java.lang.String getResourceFile()

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

withResourceFile

public Proximity withResourceFile(java.lang.String resourceFile)

setAnnotation

public void setAnnotation(java.lang.String annotation)

Output annotation

getAnnotation

public java.lang.String getAnnotation()

Output annotation

withAnnotation

public Proximity withAnnotation(java.lang.String annotation)

setDisplayForm

public void setDisplayForm(java.lang.String displayForm)

Optional format for the output annotation display form: elements can be referred to using their $names

getDisplayForm

public java.lang.String getDisplayForm()

Optional format for the output annotation display form: elements can be referred to using their $names

withDisplayForm

public Proximity withDisplayForm(java.lang.String displayForm)

getProximityElement

public java.util.List<ProximityElement> getProximityElement()

The set of annotations to search for

withProximityElement

public Proximity withProximityElement(ProximityElement... __values)

The set of annotations to search for

withProximityElement

public Proximity withProximityElement(java.util.Collection<ProximityElement> __values)

setOrdered

public void setOrdered(boolean ordered)

If TRUE, forces the processor to match the annotations in definition order

isOrdered

public boolean isOrdered()

If TRUE, forces the processor to match the annotations in definition order

withOrdered

public Proximity withOrdered(boolean ordered)

withOrdered

public Proximity withOrdered(java.lang.Boolean ordered)

setSentenceScope

public void setSentenceScope(boolean sentenceScope)

If TRUE, each match is to be contained in a sentence, no match will span several sentences

isSentenceScope

public boolean isSentenceScope()

If TRUE, each match is to be contained in a sentence, no match will span several sentences

withSentenceScope

public Proximity withSentenceScope(boolean sentenceScope)

withSentenceScope

public Proximity withSentenceScope(java.lang.Boolean sentenceScope)

setParagraphScope

public void setParagraphScope(boolean paragraphScope)

If TRUE, each match is to be contained in a paragraph, no match will span several paragraphs

isParagraphScope

public boolean isParagraphScope()

If TRUE, each match is to be contained in a paragraph, no match will span several paragraphs

withParagraphScope

public Proximity withParagraphScope(boolean paragraphScope)

withParagraphScope

public Proximity withParagraphScope(java.lang.Boolean paragraphScope)

setWindowSize

public void setWindowSize(int windowSize)

Maximum size of a match in terms of token

getWindowSize

public int getWindowSize()

Maximum size of a match in terms of token

withWindowSize

public Proximity withWindowSize(int windowSize)

withWindowSize

public Proximity withWindowSize(java.lang.Integer windowSize)

setMinDistance

public void setMinDistance(int minDistance)

The minimum distance between two elements in terms of token

getMinDistance

public int getMinDistance()

The minimum distance between two elements in terms of token

withMinDistance

public Proximity withMinDistance(int minDistance)

withMinDistance

public Proximity withMinDistance(java.lang.Integer minDistance)

setMaxDistance

public void setMaxDistance(int maxDistance)

The maximum distance between two elements in terms of token

getMaxDistance

public int getMaxDistance()

The maximum distance between two elements in terms of token

withMaxDistance

public Proximity withMaxDistance(int maxDistance)

withMaxDistance

public Proximity withMaxDistance(java.lang.Integer maxDistance)

setAllowElementOverlap

public void setAllowElementOverlap(boolean allowElementOverlap)

If TRUE, reports also matches where annotations overlap

isAllowElementOverlap

public boolean isAllowElementOverlap()

If TRUE, reports also matches where annotations overlap

withAllowElementOverlap

public Proximity withAllowElementOverlap(boolean allowElementOverlap)

withAllowElementOverlap

public Proximity withAllowElementOverlap(java.lang.Boolean allowElementOverlap)

makeCopy

public Proximity makeCopy()

Creates and returns a deep copy of this Proximity.

Overrides:

makeCopy in class SemanticProcessor

readFrom

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

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

Overrides:

writeTo in class SemanticProcessor

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this Proximity.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this Proximity.

Overrides:

toString in class SemanticProcessor

check

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

Checks this Proximity.

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