com.exalead.actionrules.v21

Class Atom

java.lang.Object

com.exalead.actionrules.v21.Pattern

com.exalead.actionrules.v21.Atom

All Implemented Interfaces:

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

public class Atom
extends Pattern
implements com.exalead.util.Checkable, java.io.Serializable, Cloneable

Raw patterns
Applies on the main url unless specified otherwise.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DEFAULT_LITTERAL
static java.lang.String	DEFAULT_NORM
java.lang.String	field
java.lang.String	kind
boolean	litteral
java.lang.String	matchedUrl
java.lang.String	norm
java.lang.String	value

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	check(boolean deep, java.lang.String errorContext) Checks this Atom.
Atom	clone() Creates and returns a deep copy of this Atom.
static Atom	fromString(java.lang.String s) String representation of this Atom.
java.lang.String	getField() the field on which the pattern is applied A field may be the whole url or a part of it (url, scheme, host, port, path, query)
java.lang.String	getKind() specify the semantics of the attribute value - "length": specify the length of a field ([:10], [11:12], [30:]) - "exact", "prefix", "suffix", "inside": specify a regexp and its anchoring
java.lang.String	getMatchedUrl() If not empty, this rule applies on the url provided with the name matchedUrl, instead of the main url.
java.lang.String	getNorm() Specify the normalization level (default is case insentive match) values: norm, lower or none
java.lang.String	getValue() value (regexp)
boolean	isLitteral()
Atom	makeCopy() Creates and returns a deep copy of this Atom.
static Atom	readFrom(java.io.InputStream is) Read this Atom from an XML fragment.
void	setField(java.lang.String field) the field on which the pattern is applied A field may be the whole url or a part of it (url, scheme, host, port, path, query)
void	setKind(java.lang.String kind) specify the semantics of the attribute value - "length": specify the length of a field ([:10], [11:12], [30:]) - "exact", "prefix", "suffix", "inside": specify a regexp and its anchoring
void	setLitteral(boolean litteral)
void	setMatchedUrl(java.lang.String matchedUrl) If not empty, this rule applies on the url provided with the name matchedUrl, instead of the main url.
void	setNorm(java.lang.String norm) Specify the normalization level (default is case insentive match) values: norm, lower or none
void	setValue(java.lang.String value) value (regexp)
java.lang.String	toString() String representation of this Atom.
Atom	withField(java.lang.String field)
Atom	withKind(java.lang.String kind)
Atom	withLitteral(boolean litteral)
Atom	withLitteral(java.lang.Boolean litteral)
Atom	withMatchedUrl(java.lang.String matchedUrl)
Atom	withNorm(java.lang.String norm)
Atom	withValue(java.lang.String value)
void	writeTo(java.io.OutputStream os) Write this Atom as an XML fragment

Methods inherited from class java.lang.Object

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

Field Detail

field

public java.lang.String field

kind

public java.lang.String kind

norm

public java.lang.String norm

DEFAULT_NORM

public static final java.lang.String DEFAULT_NORM

See Also:

Constant Field Values

value

public java.lang.String value

matchedUrl

public java.lang.String matchedUrl

litteral

public boolean litteral

DEFAULT_LITTERAL

public static final boolean DEFAULT_LITTERAL

See Also:

Constant Field Values

Constructor Detail

Atom

public Atom()

Atom

public Atom(Atom o)

Copy constructor

Method Detail

setField

public void setField(java.lang.String field)

the field on which the pattern is applied
A field may be the whole url or a part of it (url, scheme, host, port, path, query)

getField

public java.lang.String getField()

the field on which the pattern is applied
A field may be the whole url or a part of it (url, scheme, host, port, path, query)

withField

public Atom withField(java.lang.String field)

setKind

public void setKind(java.lang.String kind)

specify the semantics of the attribute value
- "length": specify the length of a field ([:10], [11:12], [30:])
- "exact", "prefix", "suffix", "inside": specify a regexp and its anchoring

getKind

public java.lang.String getKind()

specify the semantics of the attribute value
- "length": specify the length of a field ([:10], [11:12], [30:])
- "exact", "prefix", "suffix", "inside": specify a regexp and its anchoring

withKind

public Atom withKind(java.lang.String kind)

setNorm

public void setNorm(java.lang.String norm)

Specify the normalization level (default is case insentive match)
values: norm, lower or none

getNorm

public java.lang.String getNorm()

Specify the normalization level (default is case insentive match)
values: norm, lower or none

withNorm

public Atom withNorm(java.lang.String norm)

setValue

public void setValue(java.lang.String value)

value (regexp)

getValue

public java.lang.String getValue()

value (regexp)

withValue

public Atom withValue(java.lang.String value)

setMatchedUrl

public void setMatchedUrl(java.lang.String matchedUrl)

If not empty, this rule applies on the url provided with the name matchedUrl,
instead of the main url.

getMatchedUrl

public java.lang.String getMatchedUrl()

If not empty, this rule applies on the url provided with the name matchedUrl,
instead of the main url.

withMatchedUrl

public Atom withMatchedUrl(java.lang.String matchedUrl)

setLitteral

public void setLitteral(boolean litteral)

isLitteral

public boolean isLitteral()

withLitteral

public Atom withLitteral(boolean litteral)

withLitteral

public Atom withLitteral(java.lang.Boolean litteral)

clone

public Atom clone()

Creates and returns a deep copy of this Atom.

Specified by:

clone in class Pattern

makeCopy

public Atom makeCopy()

Creates and returns a deep copy of this Atom.

Overrides:

makeCopy in class Pattern

readFrom

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

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

Overrides:

writeTo in class Pattern

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this Atom.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this Atom.

Overrides:

toString in class Pattern

check

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

Checks this Atom.

Specified by:

check in interface com.exalead.util.Checkable

Overrides:

check in class Pattern

Throws:

com.exalead.util.TypedException