com.exalead.mot.components.regexpmatcher

Class RegexpMatch

java.lang.Object

com.exalead.mot.components.regexpmatcher.RegexpMatch

All Implemented Interfaces:

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

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

No documentation for this element.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RegexpMatch.Level

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	annotation
static java.lang.String	DEFAULT_LANG
static java.lang.String	DEFAULT_LEVEL
java.lang.String	displayForm
java.lang.String	lang
java.lang.String	level
java.lang.String	regexp

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	check(boolean deep, java.lang.String errorContext) Checks this RegexpMatch.
static RegexpMatch	fromString(java.lang.String s) String representation of this RegexpMatch.
java.lang.String	getAnnotation() Tag of the annotations to add on matched tokens.
java.lang.String	getDisplayForm() Value of the annotations to add on matched tokens. By default, the display form is that of the matched tokens, but it can be overriden by the user. Captures may be used.
java.lang.String	getLang() Lang of the regular expression. The regexp will not match token in other languages.
java.lang.String	getLevel() Level of the regular expression. For example, a regexp with level=lowercase will match case-insensitively.
RegexpMatch.Level	getLevelAsEnum() Level of the regular expression. For example, a regexp with level=lowercase will match case-insensitively.
java.lang.String	getRegexp() Regular expression to recognize.
static boolean	isA(java.lang.String str, RegexpMatch.Level item)
static boolean	isOneOf(java.lang.String str, RegexpMatch.Level... items)
RegexpMatch	makeCopy() Creates and returns a deep copy of this RegexpMatch.
static RegexpMatch	readFrom(java.io.InputStream is) Read this RegexpMatch from an XML fragment.
void	setAnnotation(java.lang.String annotation) Tag of the annotations to add on matched tokens.
void	setDisplayForm(java.lang.String displayForm) Value of the annotations to add on matched tokens. By default, the display form is that of the matched tokens, but it can be overriden by the user. Captures may be used.
void	setLang(java.lang.String lang) Lang of the regular expression. The regexp will not match token in other languages.
void	setLevel(RegexpMatch.Level item) Level of the regular expression. For example, a regexp with level=lowercase will match case-insensitively.
void	setLevel(java.lang.String level) Level of the regular expression. For example, a regexp with level=lowercase will match case-insensitively.
void	setRegexp(java.lang.String regexp) Regular expression to recognize.
java.lang.String	toString() String representation of this RegexpMatch.
RegexpMatch	withAnnotation(java.lang.String annotation)
RegexpMatch	withDisplayForm(java.lang.String displayForm)
RegexpMatch	withLang(java.lang.String lang)
RegexpMatch	withLevel(java.lang.String level)
RegexpMatch	withRegexp(java.lang.String regexp)
void	writeTo(java.io.OutputStream os) Write this RegexpMatch as an XML fragment

Methods inherited from class java.lang.Object

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

Field Detail

regexp

public java.lang.String regexp

annotation

public java.lang.String annotation

level

public java.lang.String level

DEFAULT_LEVEL

public static final java.lang.String DEFAULT_LEVEL

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

displayForm

public java.lang.String displayForm

Constructor Detail

RegexpMatch

public RegexpMatch()

RegexpMatch

public RegexpMatch(RegexpMatch o)

Copy constructor

Method Detail

isA

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

isOneOf

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

setLevel

public void setLevel(RegexpMatch.Level item)

Level of the regular expression.
For example, a regexp with level=lowercase will match case-insensitively.

getLevelAsEnum

public RegexpMatch.Level getLevelAsEnum()

Level of the regular expression.
For example, a regexp with level=lowercase will match case-insensitively.

setRegexp

public void setRegexp(java.lang.String regexp)

Regular expression to recognize.

getRegexp

public java.lang.String getRegexp()

Regular expression to recognize.

withRegexp

public RegexpMatch withRegexp(java.lang.String regexp)

setAnnotation

public void setAnnotation(java.lang.String annotation)

Tag of the annotations to add on matched tokens.

getAnnotation

public java.lang.String getAnnotation()

Tag of the annotations to add on matched tokens.

withAnnotation

public RegexpMatch withAnnotation(java.lang.String annotation)

setLevel

public void setLevel(java.lang.String level)

Level of the regular expression.
For example, a regexp with level=lowercase will match case-insensitively.

getLevel

public java.lang.String getLevel()

Level of the regular expression.
For example, a regexp with level=lowercase will match case-insensitively.

withLevel

public RegexpMatch withLevel(java.lang.String level)

setLang

public void setLang(java.lang.String lang)

Lang of the regular expression.
The regexp will not match token in other languages. If lang=xx, token may be matched whatever language they are in.

getLang

public java.lang.String getLang()

Lang of the regular expression.
The regexp will not match token in other languages. If lang=xx, token may be matched whatever language they are in.

withLang

public RegexpMatch withLang(java.lang.String lang)

setDisplayForm

public void setDisplayForm(java.lang.String displayForm)

Value of the annotations to add on matched tokens.
By default, the display form is that of the matched tokens, but it can be overriden by the user.
Captures may be used. Eg. if the regexp is "(foo)bar", and the displayForm may is "\1baz", then annoations will be added on "foobar" with value "foobaz".

getDisplayForm

public java.lang.String getDisplayForm()

Value of the annotations to add on matched tokens.
By default, the display form is that of the matched tokens, but it can be overriden by the user.
Captures may be used. Eg. if the regexp is "(foo)bar", and the displayForm may is "\1baz", then annoations will be added on "foobar" with value "foobaz".

withDisplayForm

public RegexpMatch withDisplayForm(java.lang.String displayForm)

makeCopy

public RegexpMatch makeCopy()

Creates and returns a deep copy of this RegexpMatch.

readFrom

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

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

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this RegexpMatch.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this RegexpMatch.

Overrides:

toString in class java.lang.Object

check

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

Checks this RegexpMatch.

Specified by:

check in interface com.exalead.util.Checkable

Throws:

com.exalead.util.TypedException