com.exalead.mot.components.transducer

Class Annotation

java.lang.Object

com.exalead.linguistic.v10.Modifiable

com.exalead.mot.components.transducer.Pattern

com.exalead.mot.components.transducer.RulePattern

com.exalead.mot.components.transducer.BoolPattern

com.exalead.mot.components.transducer.Annotation

All Implemented Interfaces:

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

Direct Known Subclasses:

Ctx

public class Annotation
extends BoolPattern
implements com.exalead.util.Checkable, java.io.Serializable

Matches an annotation kind and possibly its display form if specified.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Annotation.Error

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_ERROR
static boolean	DEFAULT_REQUIRED
static boolean	DEFAULT_USE_DISPLAY_FORM
static java.lang.String	DEFAULT_VALUE
java.lang.String	error
java.lang.String	kind
boolean	required Deprecated.
boolean	useDisplayForm
java.lang.String	value

Fields inherited from class com.exalead.mot.components.transducer.BoolPattern

anchor, DEFAULT_ANCHOR

Fields inherited from class com.exalead.mot.components.transducer.RulePattern

DEFAULT_PRIORITY, name, priority

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

modifiedAt, modifiedBy

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	check(boolean deep, java.lang.String errorContext) Checks this Annotation.
static Annotation	fromString(java.lang.String s) String representation of this Annotation.
java.lang.String	getError()
Annotation.Error	getErrorAsEnum()
java.lang.String	getKind()
java.lang.String	getValue()
static boolean	isA(java.lang.String str, Annotation.Error item)
static boolean	isOneOf(java.lang.String str, Annotation.Error... items)
boolean	isRequired() Deprecated.
boolean	isUseDisplayForm()
Annotation	makeCopy() Creates and returns a deep copy of this Annotation.
static Annotation	readFrom(java.io.InputStream is) Read this Annotation from an XML fragment.
void	setError(Annotation.Error item)
void	setError(java.lang.String error)
void	setKind(java.lang.String kind)
void	setRequired(boolean required) Deprecated.
void	setUseDisplayForm(boolean useDisplayForm)
void	setValue(java.lang.String value)
java.lang.String	toString() String representation of this Annotation.
Annotation	withAnchor(boolean anchor)
Annotation	withAnchor(java.lang.Boolean anchor)
Annotation	withError(java.lang.String error)
Annotation	withKind(java.lang.String kind)
Annotation	withModifiedAt(java.lang.Long modifiedAt)
Annotation	withModifiedBy(java.lang.String modifiedBy)
Annotation	withName(java.lang.String name)
Annotation	withPriority(int priority)
Annotation	withPriority(java.lang.Integer priority)
Annotation	withRequired(boolean required) Deprecated.
Annotation	withRequired(java.lang.Boolean required) Deprecated.
Annotation	withUseDisplayForm(boolean useDisplayForm)
Annotation	withUseDisplayForm(java.lang.Boolean useDisplayForm)
Annotation	withValue(java.lang.String value)
void	writeTo(java.io.OutputStream os) Write this Annotation as an XML fragment

Methods inherited from class com.exalead.mot.components.transducer.BoolPattern

isAnchor, setAnchor

Methods inherited from class com.exalead.mot.components.transducer.RulePattern

getName, getPriority, setName, setPriority

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

kind

public java.lang.String kind

value

public java.lang.String value

DEFAULT_VALUE

public static final java.lang.String DEFAULT_VALUE

See Also:

Constant Field Values

useDisplayForm

public boolean useDisplayForm

DEFAULT_USE_DISPLAY_FORM

public static final boolean DEFAULT_USE_DISPLAY_FORM

See Also:

Constant Field Values

required

@Deprecated
public boolean required

Deprecated.

DEFAULT_REQUIRED

public static final boolean DEFAULT_REQUIRED

See Also:

Constant Field Values

error

public java.lang.String error

DEFAULT_ERROR

public static final java.lang.String DEFAULT_ERROR

See Also:

Constant Field Values

Constructor Detail

Annotation

public Annotation()

Annotation

public Annotation(Annotation o)

Copy constructor

Method Detail

isA

public static boolean isA(java.lang.String str,
                          Annotation.Error item)

isOneOf

public static boolean isOneOf(java.lang.String str,
                              Annotation.Error... items)

setError

public void setError(Annotation.Error item)

getErrorAsEnum

public Annotation.Error getErrorAsEnum()

withAnchor

public Annotation withAnchor(boolean anchor)

Overrides:

withAnchor in class BoolPattern

withAnchor

public Annotation withAnchor(java.lang.Boolean anchor)

Overrides:

withAnchor in class BoolPattern

withPriority

public Annotation withPriority(int priority)

Overrides:

withPriority in class BoolPattern

withPriority

public Annotation withPriority(java.lang.Integer priority)

Overrides:

withPriority in class BoolPattern

withName

public Annotation withName(java.lang.String name)

Overrides:

withName in class BoolPattern

withModifiedBy

public Annotation withModifiedBy(java.lang.String modifiedBy)

Overrides:

withModifiedBy in class BoolPattern

withModifiedAt

public Annotation withModifiedAt(java.lang.Long modifiedAt)

Overrides:

withModifiedAt in class BoolPattern

setKind

public void setKind(java.lang.String kind)

getKind

public java.lang.String getKind()

withKind

public Annotation withKind(java.lang.String kind)

setValue

public void setValue(java.lang.String value)

getValue

public java.lang.String getValue()

withValue

public Annotation withValue(java.lang.String value)

setUseDisplayForm

public void setUseDisplayForm(boolean useDisplayForm)

isUseDisplayForm

public boolean isUseDisplayForm()

withUseDisplayForm

public Annotation withUseDisplayForm(boolean useDisplayForm)

withUseDisplayForm

public Annotation withUseDisplayForm(java.lang.Boolean useDisplayForm)

setRequired

@Deprecated
public void setRequired(boolean required)

Deprecated.

isRequired

@Deprecated
public boolean isRequired()

Deprecated.

withRequired

@Deprecated
public Annotation withRequired(boolean required)

Deprecated.

withRequired

@Deprecated
public Annotation withRequired(java.lang.Boolean required)

Deprecated.

setError

public void setError(java.lang.String error)

getError

public java.lang.String getError()

withError

public Annotation withError(java.lang.String error)

makeCopy

public Annotation makeCopy()

Creates and returns a deep copy of this Annotation.

Overrides:

makeCopy in class BoolPattern

readFrom

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

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

Overrides:

writeTo in class BoolPattern

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this Annotation.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this Annotation.

Overrides:

toString in class BoolPattern

check

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

Checks this Annotation.

Specified by:

check in interface com.exalead.util.Checkable

Overrides:

check in class BoolPattern

Throws:

com.exalead.util.TypedException