com.exalead.mot.components.sqi

Class Entity

java.lang.Object

com.exalead.mot.components.sqi.Entity

All Implemented Interfaces:

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

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

No documentation for this element.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_MATCH_MODE
java.lang.String	entity
java.lang.String	matchMode
java.lang.String	output
java.lang.String	type

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	check(boolean deep, java.lang.String errorContext) Checks this Entity.
static Entity	fromString(java.lang.String s) String representation of this Entity.
java.lang.String	getEntity() entity in full text, 'Mr John Doe' for example (mandatory)
java.lang.String	getMatchMode() entity match mode - exact : match exact (including punctuation and case) - lower: match lowercase - norm : match normalized - skipPunct : ignore punctuation (normalized) - fuzzy : allow typo
java.lang.String	getOutput() Normalized form of entity that you can use in the rewritten form (Optionnal)
java.lang.String	getType() entity type, for example 'street', 'city', 'person', ... (mandatory)
Entity	makeCopy() Creates and returns a deep copy of this Entity.
static Entity	readFrom(java.io.InputStream is) Read this Entity from an XML fragment.
void	setEntity(java.lang.String entity) entity in full text, 'Mr John Doe' for example (mandatory)
void	setMatchMode(java.lang.String matchMode) entity match mode - exact : match exact (including punctuation and case) - lower: match lowercase - norm : match normalized - skipPunct : ignore punctuation (normalized) - fuzzy : allow typo
void	setOutput(java.lang.String output) Normalized form of entity that you can use in the rewritten form (Optionnal)
void	setType(java.lang.String type) entity type, for example 'street', 'city', 'person', ... (mandatory)
java.lang.String	toString() String representation of this Entity.
Entity	withEntity(java.lang.String entity)
Entity	withMatchMode(java.lang.String matchMode)
Entity	withOutput(java.lang.String output)
Entity	withType(java.lang.String type)
void	writeTo(java.io.OutputStream os) Write this Entity as an XML fragment

Methods inherited from class java.lang.Object

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

Field Detail

type

public java.lang.String type

entity

public java.lang.String entity

output

public java.lang.String output

matchMode

public java.lang.String matchMode

DEFAULT_MATCH_MODE

public static final java.lang.String DEFAULT_MATCH_MODE

See Also:

Constant Field Values

Constructor Detail

Entity

public Entity()

Entity

public Entity(Entity o)

Copy constructor

Method Detail

setType

public void setType(java.lang.String type)

entity type, for example 'street', 'city', 'person', ...
(mandatory)

getType

public java.lang.String getType()

entity type, for example 'street', 'city', 'person', ...
(mandatory)

withType

public Entity withType(java.lang.String type)

setEntity

public void setEntity(java.lang.String entity)

entity in full text, 'Mr John Doe' for example
(mandatory)

getEntity

public java.lang.String getEntity()

entity in full text, 'Mr John Doe' for example
(mandatory)

withEntity

public Entity withEntity(java.lang.String entity)

setOutput

public void setOutput(java.lang.String output)

Normalized form of entity that you can use in the rewritten form
(Optionnal)

getOutput

public java.lang.String getOutput()

Normalized form of entity that you can use in the rewritten form
(Optionnal)

withOutput

public Entity withOutput(java.lang.String output)

setMatchMode

public void setMatchMode(java.lang.String matchMode)

entity match mode
- exact : match exact (including punctuation and case)
- lower: match lowercase
- norm : match normalized
- skipPunct : ignore punctuation (normalized)
- fuzzy : allow typo

getMatchMode

public java.lang.String getMatchMode()

entity match mode
- exact : match exact (including punctuation and case)
- lower: match lowercase
- norm : match normalized
- skipPunct : ignore punctuation (normalized)
- fuzzy : allow typo

withMatchMode

public Entity withMatchMode(java.lang.String matchMode)

makeCopy

public Entity makeCopy()

Creates and returns a deep copy of this Entity.

readFrom

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

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

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this Entity.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this Entity.

Overrides:

toString in class java.lang.Object

check

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

Checks this Entity.

Specified by:

check in interface com.exalead.util.Checkable

Throws:

com.exalead.util.TypedException