com.exalead.mot.components.transducer

Class AnnotationRegexp

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.AnnotationRegexp

All Implemented Interfaces:

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

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

Matches an annotation with specified kind
and whose display form matches the specified regular expression.
If defined, "capture" contains an output format a la sed used for generating
the final match annotation

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AnnotationRegexp.Error
static class	AnnotationRegexp.Level

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	capture
static java.lang.String	DEFAULT_ERROR
static java.lang.String	DEFAULT_LEVEL
static boolean	DEFAULT_REQUIRED
static boolean	DEFAULT_USE_DISPLAY_FORM
java.lang.String	error
java.lang.String	kind
java.lang.String	level
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
AnnotationRegexp()
AnnotationRegexp(AnnotationRegexp o) Copy constructor

Method Summary

Modifier and Type	Method and Description
void	check(boolean deep, java.lang.String errorContext) Checks this AnnotationRegexp.
static AnnotationRegexp	fromString(java.lang.String s) String representation of this AnnotationRegexp.
java.lang.String	getCapture() Output format in sed format used to generate the final match annotation
java.lang.String	getError()
AnnotationRegexp.Error	getErrorAsEnum()
java.lang.String	getKind() Annotation kind that the annotation regular expression will be tested against.
java.lang.String	getLevel() Matching level, can be normalized, lowercase or exact.
AnnotationRegexp.Level	getLevelAsEnum() Matching level, can be normalized, lowercase or exact.
java.lang.String	getValue() Regular expression of the annotation.
static boolean	isA(java.lang.String str, AnnotationRegexp.Error item)
static boolean	isA(java.lang.String str, AnnotationRegexp.Level item)
static boolean	isOneOf(java.lang.String str, AnnotationRegexp.Error... items)
static boolean	isOneOf(java.lang.String str, AnnotationRegexp.Level... items)
boolean	isRequired() Deprecated.
boolean	isUseDisplayForm() Activate this option to use the display form of this annotation to build the final output annotation.
AnnotationRegexp	makeCopy() Creates and returns a deep copy of this AnnotationRegexp.
static AnnotationRegexp	readFrom(java.io.InputStream is) Read this AnnotationRegexp from an XML fragment.
void	setCapture(java.lang.String capture) Output format in sed format used to generate the final match annotation
void	setError(AnnotationRegexp.Error item)
void	setError(java.lang.String error)
void	setKind(java.lang.String kind) Annotation kind that the annotation regular expression will be tested against.
void	setLevel(AnnotationRegexp.Level item) Matching level, can be normalized, lowercase or exact.
void	setLevel(java.lang.String level) Matching level, can be normalized, lowercase or exact.
void	setRequired(boolean required) Deprecated.
void	setUseDisplayForm(boolean useDisplayForm) Activate this option to use the display form of this annotation to build the final output annotation.
void	setValue(java.lang.String value) Regular expression of the annotation.
java.lang.String	toString() String representation of this AnnotationRegexp.
AnnotationRegexp	withAnchor(boolean anchor)
AnnotationRegexp	withAnchor(java.lang.Boolean anchor)
AnnotationRegexp	withCapture(java.lang.String capture)
AnnotationRegexp	withError(java.lang.String error)
AnnotationRegexp	withKind(java.lang.String kind)
AnnotationRegexp	withLevel(java.lang.String level)
AnnotationRegexp	withModifiedAt(java.lang.Long modifiedAt)
AnnotationRegexp	withModifiedBy(java.lang.String modifiedBy)
AnnotationRegexp	withName(java.lang.String name)
AnnotationRegexp	withPriority(int priority)
AnnotationRegexp	withPriority(java.lang.Integer priority)
AnnotationRegexp	withRequired(boolean required) Deprecated.
AnnotationRegexp	withRequired(java.lang.Boolean required) Deprecated.
AnnotationRegexp	withUseDisplayForm(boolean useDisplayForm)
AnnotationRegexp	withUseDisplayForm(java.lang.Boolean useDisplayForm)
AnnotationRegexp	withValue(java.lang.String value)
void	writeTo(java.io.OutputStream os) Write this AnnotationRegexp 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

level

public java.lang.String level

DEFAULT_LEVEL

public static final java.lang.String DEFAULT_LEVEL

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

capture

public java.lang.String capture

Constructor Detail

AnnotationRegexp

public AnnotationRegexp()

AnnotationRegexp

public AnnotationRegexp(AnnotationRegexp o)

Copy constructor

Method Detail

isA

public static boolean isA(java.lang.String str,
                          AnnotationRegexp.Level item)

isOneOf

public static boolean isOneOf(java.lang.String str,
                              AnnotationRegexp.Level... items)

setLevel

public void setLevel(AnnotationRegexp.Level item)

Matching level, can be normalized, lowercase or exact.

getLevelAsEnum

public AnnotationRegexp.Level getLevelAsEnum()

Matching level, can be normalized, lowercase or exact.

isA

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

isOneOf

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

setError

public void setError(AnnotationRegexp.Error item)

getErrorAsEnum

public AnnotationRegexp.Error getErrorAsEnum()

withAnchor

public AnnotationRegexp withAnchor(boolean anchor)

Overrides:

withAnchor in class BoolPattern

withAnchor

public AnnotationRegexp withAnchor(java.lang.Boolean anchor)

Overrides:

withAnchor in class BoolPattern

withPriority

public AnnotationRegexp withPriority(int priority)

Overrides:

withPriority in class BoolPattern

withPriority

public AnnotationRegexp withPriority(java.lang.Integer priority)

Overrides:

withPriority in class BoolPattern

withName

public AnnotationRegexp withName(java.lang.String name)

Overrides:

withName in class BoolPattern

withModifiedBy

public AnnotationRegexp withModifiedBy(java.lang.String modifiedBy)

Overrides:

withModifiedBy in class BoolPattern

withModifiedAt

public AnnotationRegexp withModifiedAt(java.lang.Long modifiedAt)

Overrides:

withModifiedAt in class BoolPattern

setKind

public void setKind(java.lang.String kind)

Annotation kind that the annotation regular expression will be tested against.

getKind

public java.lang.String getKind()

Annotation kind that the annotation regular expression will be tested against.

withKind

public AnnotationRegexp withKind(java.lang.String kind)

setValue

public void setValue(java.lang.String value)

Regular expression of the annotation.

getValue

public java.lang.String getValue()

Regular expression of the annotation.

withValue

public AnnotationRegexp withValue(java.lang.String value)

setLevel

public void setLevel(java.lang.String level)

Matching level, can be normalized, lowercase or exact.

getLevel

public java.lang.String getLevel()

Matching level, can be normalized, lowercase or exact.

withLevel

public AnnotationRegexp withLevel(java.lang.String level)

setUseDisplayForm

public void setUseDisplayForm(boolean useDisplayForm)

Activate this option to use the display form of this annotation to build the final output annotation.

isUseDisplayForm

public boolean isUseDisplayForm()

Activate this option to use the display form of this annotation to build the final output annotation.

withUseDisplayForm

public AnnotationRegexp withUseDisplayForm(boolean useDisplayForm)

withUseDisplayForm

public AnnotationRegexp withUseDisplayForm(java.lang.Boolean useDisplayForm)

setRequired

@Deprecated
public void setRequired(boolean required)

Deprecated.

isRequired

@Deprecated
public boolean isRequired()

Deprecated.

withRequired

@Deprecated
public AnnotationRegexp withRequired(boolean required)

Deprecated.

withRequired

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

Deprecated.

setError

public void setError(java.lang.String error)

getError

public java.lang.String getError()

withError

public AnnotationRegexp withError(java.lang.String error)

setCapture

public void setCapture(java.lang.String capture)

Output format in sed format used to generate the final match annotation

getCapture

public java.lang.String getCapture()

Output format in sed format used to generate the final match annotation

withCapture

public AnnotationRegexp withCapture(java.lang.String capture)

makeCopy

public AnnotationRegexp makeCopy()

Creates and returns a deep copy of this AnnotationRegexp.

Overrides:

makeCopy in class BoolPattern

readFrom

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

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

Overrides:

writeTo in class BoolPattern

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this AnnotationRegexp.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this AnnotationRegexp.

Overrides:

toString in class BoolPattern

check

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

Checks this AnnotationRegexp.

Specified by:

check in interface com.exalead.util.Checkable

Overrides:

check in class BoolPattern

Throws:

com.exalead.util.TypedException