com.exalead.linguistic.v10

Class ProximityElement

java.lang.Object

com.exalead.linguistic.v10.ProximityElement

All Implemented Interfaces:

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

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

Proximity processor configuration element

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	annotation
static boolean	DEFAULT_MANDATORY
boolean	mandatory
java.lang.String	name
java.lang.String	value

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	check(boolean deep, java.lang.String errorContext) Checks this ProximityElement.
static ProximityElement	fromString(java.lang.String s) String representation of this ProximityElement.
java.lang.String	getAnnotation() The annotation tag to search for
java.lang.String	getName() A optional name that can be referenced in the output annotation format using $name.
java.lang.String	getValue() An optional display form to match.
boolean	isMandatory() If FALSE, the processor is allowed to report matches where this annotation is missing
ProximityElement	makeCopy() Creates and returns a deep copy of this ProximityElement.
static ProximityElement	readFrom(java.io.InputStream is) Read this ProximityElement from an XML fragment.
void	setAnnotation(java.lang.String annotation) The annotation tag to search for
void	setMandatory(boolean mandatory) If FALSE, the processor is allowed to report matches where this annotation is missing
void	setName(java.lang.String name) A optional name that can be referenced in the output annotation format using $name.
void	setValue(java.lang.String value) An optional display form to match.
java.lang.String	toString() String representation of this ProximityElement.
ProximityElement	withAnnotation(java.lang.String annotation)
ProximityElement	withMandatory(boolean mandatory)
ProximityElement	withMandatory(java.lang.Boolean mandatory)
ProximityElement	withName(java.lang.String name)
ProximityElement	withValue(java.lang.String value)
void	writeTo(java.io.OutputStream os) Write this ProximityElement as an XML fragment

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

annotation

public java.lang.String annotation

mandatory

public boolean mandatory

DEFAULT_MANDATORY

public static final boolean DEFAULT_MANDATORY

See Also:

Constant Field Values

value

public java.lang.String value

name

public java.lang.String name

Constructor Detail

ProximityElement

public ProximityElement()

ProximityElement

public ProximityElement(ProximityElement o)

Copy constructor

Method Detail

setAnnotation

public void setAnnotation(java.lang.String annotation)

The annotation tag to search for

getAnnotation

public java.lang.String getAnnotation()

The annotation tag to search for

withAnnotation

public ProximityElement withAnnotation(java.lang.String annotation)

setMandatory

public void setMandatory(boolean mandatory)

If FALSE, the processor is allowed to report matches where this annotation is missing

isMandatory

public boolean isMandatory()

If FALSE, the processor is allowed to report matches where this annotation is missing

withMandatory

public ProximityElement withMandatory(boolean mandatory)

withMandatory

public ProximityElement withMandatory(java.lang.Boolean mandatory)

setValue

public void setValue(java.lang.String value)

An optional display form to match. Regular expressions can be used by enclosing the string in slashes

getValue

public java.lang.String getValue()

An optional display form to match. Regular expressions can be used by enclosing the string in slashes

withValue

public ProximityElement withValue(java.lang.String value)

setName

public void setName(java.lang.String name)

A optional name that can be referenced in the output annotation format using $name. Names shall be made of characters in [0-9a-zA-Z]

getName

public java.lang.String getName()

A optional name that can be referenced in the output annotation format using $name. Names shall be made of characters in [0-9a-zA-Z]

withName

public ProximityElement withName(java.lang.String name)

makeCopy

public ProximityElement makeCopy()

Creates and returns a deep copy of this ProximityElement.

readFrom

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

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

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this ProximityElement.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this ProximityElement.

Overrides:

toString in class java.lang.Object

check

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

Checks this ProximityElement.

Specified by:

check in interface com.exalead.util.Checkable

Throws:

com.exalead.util.TypedException