com.exalead.mot.components.semanticextractor

Class TextEntity

java.lang.Object

com.exalead.linguistic.v10.Modifiable

com.exalead.mot.components.semanticextractor.AbstractEntity

com.exalead.mot.components.semanticextractor.SimpleEntity

com.exalead.mot.components.semanticextractor.ValuedEntity

com.exalead.mot.components.semanticextractor.TextEntity

All Implemented Interfaces:

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

public class TextEntity
extends ValuedEntity
implements com.exalead.util.Checkable, java.io.Serializable

Matches strings

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.exalead.mot.components.semanticextractor.ValuedEntity

ValuedEntity.RightContexts, ValuedEntity.Units

Nested classes/interfaces inherited from class com.exalead.mot.components.semanticextractor.SimpleEntity

SimpleEntity.LeftContexts, SimpleEntity.Triggers

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_LANG
static int	DEFAULT_MAX_VALUE_SIZE
java.lang.String	lang
int	maxValueSize
java.lang.String	value

Fields inherited from class com.exalead.mot.components.semanticextractor.ValuedEntity

rightContext, rightContexts, unit, units

Fields inherited from class com.exalead.mot.components.semanticextractor.SimpleEntity

annotation, DEFAULT_MATCH_MODE, display, leftContext, leftContexts, matchMode, trigger, triggers

Fields inherited from class com.exalead.mot.components.semanticextractor.AbstractEntity

name

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

modifiedAt, modifiedBy

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	check(boolean deep, java.lang.String errorContext) Checks this TextEntity.
static TextEntity	fromString(java.lang.String s) String representation of this TextEntity.
java.lang.String	getLang() Optional language constraint
int	getMaxValueSize() Maximum number of tokens for the value
java.lang.String	getValue() The values to match, separated with '|'
TextEntity	makeCopy() Creates and returns a deep copy of this TextEntity.
static TextEntity	readFrom(java.io.InputStream is) Read this TextEntity from an XML fragment.
void	setLang(java.lang.String lang) Optional language constraint
void	setMaxValueSize(int maxValueSize) Maximum number of tokens for the value
void	setValue(java.lang.String value) The values to match, separated with '|'
java.lang.String	toString() String representation of this TextEntity.
TextEntity	withAnnotation(java.lang.String annotation)
TextEntity	withDisplay(java.lang.String display)
TextEntity	withLang(java.lang.String lang)
TextEntity	withLeftContext(java.lang.String leftContext)
TextEntity	withLeftContexts(java.util.Collection<exa.bee.StringValue> __values)
TextEntity	withLeftContexts(exa.bee.StringValue... __values) Alias for triggers
TextEntity	withMatchMode(java.lang.String matchMode)
TextEntity	withMaxValueSize(int maxValueSize)
TextEntity	withMaxValueSize(java.lang.Integer maxValueSize)
TextEntity	withModifiedAt(java.lang.Long modifiedAt)
TextEntity	withModifiedBy(java.lang.String modifiedBy)
TextEntity	withName(java.lang.String name)
TextEntity	withRightContext(java.lang.String rightContext)
TextEntity	withRightContexts(java.util.Collection<exa.bee.StringValue> __values)
TextEntity	withRightContexts(exa.bee.StringValue... __values) Alias for units
TextEntity	withTrigger(java.lang.String trigger)
TextEntity	withTriggers(java.util.Collection<exa.bee.StringValue> __values)
TextEntity	withTriggers(exa.bee.StringValue... __values) An optional list of left contexts triggering the match
TextEntity	withUnit(java.lang.String unit)
TextEntity	withUnits(java.util.Collection<exa.bee.StringValue> __values)
TextEntity	withUnits(exa.bee.StringValue... __values) An optional list of conditions on right context
TextEntity	withValue(java.lang.String value)
void	writeTo(java.io.OutputStream os) Write this TextEntity as an XML fragment

Methods inherited from class com.exalead.mot.components.semanticextractor.ValuedEntity

getRightContext, getRightContexts, getUnit, getUnits, setRightContext, setRightContexts, setUnit, setUnits, withRightContexts, withUnits

Methods inherited from class com.exalead.mot.components.semanticextractor.SimpleEntity

getAnnotation, getDisplay, getLeftContext, getLeftContexts, getMatchMode, getTrigger, getTriggers, setAnnotation, setDisplay, setLeftContext, setLeftContexts, setMatchMode, setTrigger, setTriggers, withLeftContexts, withTriggers

Methods inherited from class com.exalead.mot.components.semanticextractor.AbstractEntity

getName, setName

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

getModifiedAt, getModifiedBy, setModifiedAt, setModifiedBy

Methods inherited from class java.lang.Object

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

Field Detail

value

public java.lang.String value

maxValueSize

public int maxValueSize

DEFAULT_MAX_VALUE_SIZE

public static final int DEFAULT_MAX_VALUE_SIZE

See Also:

Constant Field Values

lang

public java.lang.String lang

DEFAULT_LANG

public static final java.lang.String DEFAULT_LANG

See Also:

Constant Field Values

Constructor Detail

TextEntity

public TextEntity()

TextEntity

public TextEntity(TextEntity o)

Copy constructor

Method Detail

withUnit

public TextEntity withUnit(java.lang.String unit)

Overrides:

withUnit in class ValuedEntity

withUnits

public TextEntity withUnits(exa.bee.StringValue... __values)

An optional list of conditions on right context

Overrides:

withUnits in class ValuedEntity

withUnits

public TextEntity withUnits(java.util.Collection<exa.bee.StringValue> __values)

Overrides:

withUnits in class ValuedEntity

withRightContext

public TextEntity withRightContext(java.lang.String rightContext)

Overrides:

withRightContext in class ValuedEntity

withRightContexts

public TextEntity withRightContexts(exa.bee.StringValue... __values)

Alias for units

Overrides:

withRightContexts in class ValuedEntity

withRightContexts

public TextEntity withRightContexts(java.util.Collection<exa.bee.StringValue> __values)

Overrides:

withRightContexts in class ValuedEntity

withTrigger

public TextEntity withTrigger(java.lang.String trigger)

Overrides:

withTrigger in class ValuedEntity

withTriggers

public TextEntity withTriggers(exa.bee.StringValue... __values)

An optional list of left contexts triggering the match

Overrides:

withTriggers in class ValuedEntity

withTriggers

public TextEntity withTriggers(java.util.Collection<exa.bee.StringValue> __values)

Overrides:

withTriggers in class ValuedEntity

withLeftContext

public TextEntity withLeftContext(java.lang.String leftContext)

Overrides:

withLeftContext in class ValuedEntity

withLeftContexts

public TextEntity withLeftContexts(exa.bee.StringValue... __values)

Alias for triggers

Overrides:

withLeftContexts in class ValuedEntity

withLeftContexts

public TextEntity withLeftContexts(java.util.Collection<exa.bee.StringValue> __values)

Overrides:

withLeftContexts in class ValuedEntity

withAnnotation

public TextEntity withAnnotation(java.lang.String annotation)

Overrides:

withAnnotation in class ValuedEntity

withDisplay

public TextEntity withDisplay(java.lang.String display)

Overrides:

withDisplay in class ValuedEntity

withMatchMode

public TextEntity withMatchMode(java.lang.String matchMode)

Overrides:

withMatchMode in class ValuedEntity

withName

public TextEntity withName(java.lang.String name)

Overrides:

withName in class ValuedEntity

withModifiedBy

public TextEntity withModifiedBy(java.lang.String modifiedBy)

Overrides:

withModifiedBy in class ValuedEntity

withModifiedAt

public TextEntity withModifiedAt(java.lang.Long modifiedAt)

Overrides:

withModifiedAt in class ValuedEntity

setValue

public void setValue(java.lang.String value)

The values to match, separated with '|'

getValue

public java.lang.String getValue()

The values to match, separated with '|'

withValue

public TextEntity withValue(java.lang.String value)

setMaxValueSize

public void setMaxValueSize(int maxValueSize)

Maximum number of tokens for the value

getMaxValueSize

public int getMaxValueSize()

Maximum number of tokens for the value

withMaxValueSize

public TextEntity withMaxValueSize(int maxValueSize)

withMaxValueSize

public TextEntity withMaxValueSize(java.lang.Integer maxValueSize)

setLang

public void setLang(java.lang.String lang)

Optional language constraint

getLang

public java.lang.String getLang()

Optional language constraint

withLang

public TextEntity withLang(java.lang.String lang)

makeCopy

public TextEntity makeCopy()

Creates and returns a deep copy of this TextEntity.

Overrides:

makeCopy in class ValuedEntity

readFrom

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

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

Overrides:

writeTo in class ValuedEntity

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this TextEntity.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this TextEntity.

Overrides:

toString in class ValuedEntity

check

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

Checks this TextEntity.

Specified by:

check in interface com.exalead.util.Checkable

Overrides:

check in class ValuedEntity

Throws:

com.exalead.util.TypedException