com.exalead.indexing.analysis.v10

Class MetaCondition

java.lang.Object

com.exalead.indexing.analysis.v10.AcceptCondition

com.exalead.indexing.analysis.v10.MetaCondition

All Implemented Interfaces:

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

public class MetaCondition
extends AcceptCondition
implements com.exalead.util.Checkable, java.io.Serializable

MetaCondition matches if the Document contains a DocumentChunk whose meta name and value match the specified condition.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MetaCondition.NameMode
static class	MetaCondition.ValueMode

Nested classes/interfaces inherited from class com.exalead.indexing.analysis.v10.AcceptCondition

AcceptCondition.Transformer<T>

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_NAME_MODE
static java.lang.String	DEFAULT_VALUE_MODE
java.lang.String	name
java.lang.String	nameMode
java.lang.String	value
java.lang.String	valueMode

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
<T> T	accept(AcceptCondition.Transformer<T> transformer, T[] t)
void	check(boolean deep, java.lang.String errorContext) Checks this MetaCondition.
static MetaCondition	fromString(java.lang.String s) String representation of this MetaCondition.
java.lang.String	getName() Name of the meta against which to check.
java.lang.String	getNameMode() Meta name test mode: "equals": Evaluates the DocumentChunk with a name equal to the specified one. "matches": Evaluates the DocumentChunk with a name matching the specified regular expression.The match is case insensitive.
MetaCondition.NameMode	getNameModeAsEnum() Meta name test mode: "equals": Evaluates the DocumentChunk with a name equal to the specified one. "matches": Evaluates the DocumentChunk with a name matching the specified regular expression.The match is case insensitive.
java.lang.String	getValue() The string to check against the value of DocumentChunks.
java.lang.String	getValueMode() Value test mode: "exists": Matches if a DocumentChunk pass the name condition. "equals": Matches if a DocumentChunk pass the name condition and the textual content is equal to the 'value' attribute. "contains": Matches if a DocumentChunk pass the name condition and the textual content contains 'value' (Pure string matching is performed without tokenization). "matches": Matches if a DocumentChunk pass the name condition and the textual content matches the regular expression specified by the 'value' attribute.
MetaCondition.ValueMode	getValueModeAsEnum() Value test mode: "exists": Matches if a DocumentChunk pass the name condition. "equals": Matches if a DocumentChunk pass the name condition and the textual content is equal to the 'value' attribute. "contains": Matches if a DocumentChunk pass the name condition and the textual content contains 'value' (Pure string matching is performed without tokenization). "matches": Matches if a DocumentChunk pass the name condition and the textual content matches the regular expression specified by the 'value' attribute.
static boolean	isA(java.lang.String str, MetaCondition.NameMode item)
static boolean	isA(java.lang.String str, MetaCondition.ValueMode item)
static boolean	isOneOf(java.lang.String str, MetaCondition.NameMode... items)
static boolean	isOneOf(java.lang.String str, MetaCondition.ValueMode... items)
MetaCondition	makeCopy() Creates and returns a deep copy of this MetaCondition.
static MetaCondition	readFrom(java.io.InputStream is) Read this MetaCondition from an XML fragment.
void	setName(java.lang.String name) Name of the meta against which to check.
void	setNameMode(MetaCondition.NameMode item) Meta name test mode: "equals": Evaluates the DocumentChunk with a name equal to the specified one. "matches": Evaluates the DocumentChunk with a name matching the specified regular expression.The match is case insensitive.
void	setNameMode(java.lang.String nameMode) Meta name test mode: "equals": Evaluates the DocumentChunk with a name equal to the specified one. "matches": Evaluates the DocumentChunk with a name matching the specified regular expression.The match is case insensitive.
void	setValue(java.lang.String value) The string to check against the value of DocumentChunks.
void	setValueMode(MetaCondition.ValueMode item) Value test mode: "exists": Matches if a DocumentChunk pass the name condition. "equals": Matches if a DocumentChunk pass the name condition and the textual content is equal to the 'value' attribute. "contains": Matches if a DocumentChunk pass the name condition and the textual content contains 'value' (Pure string matching is performed without tokenization). "matches": Matches if a DocumentChunk pass the name condition and the textual content matches the regular expression specified by the 'value' attribute.
void	setValueMode(java.lang.String valueMode) Value test mode: "exists": Matches if a DocumentChunk pass the name condition. "equals": Matches if a DocumentChunk pass the name condition and the textual content is equal to the 'value' attribute. "contains": Matches if a DocumentChunk pass the name condition and the textual content contains 'value' (Pure string matching is performed without tokenization). "matches": Matches if a DocumentChunk pass the name condition and the textual content matches the regular expression specified by the 'value' attribute.
java.lang.String	toString() String representation of this MetaCondition.
MetaCondition	withName(java.lang.String name)
MetaCondition	withNameMode(java.lang.String nameMode)
MetaCondition	withValue(java.lang.String value)
MetaCondition	withValueMode(java.lang.String valueMode)
void	writeTo(java.io.OutputStream os) Write this MetaCondition as an XML fragment

Methods inherited from class java.lang.Object

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

Field Detail

name

public java.lang.String name

nameMode

public java.lang.String nameMode

DEFAULT_NAME_MODE

public static final java.lang.String DEFAULT_NAME_MODE

See Also:

Constant Field Values

valueMode

public java.lang.String valueMode

DEFAULT_VALUE_MODE

public static final java.lang.String DEFAULT_VALUE_MODE

See Also:

Constant Field Values

value

public java.lang.String value

Constructor Detail

MetaCondition

public MetaCondition()

MetaCondition

public MetaCondition(MetaCondition o)

Copy constructor

Method Detail

isA

public static boolean isA(java.lang.String str,
                          MetaCondition.NameMode item)

isOneOf

public static boolean isOneOf(java.lang.String str,
                              MetaCondition.NameMode... items)

setNameMode

public void setNameMode(MetaCondition.NameMode item)

Meta name test mode:

• "equals": Evaluates the DocumentChunk with a name equal to the specified one.
• "matches": Evaluates the DocumentChunk with a name matching the specified regular expression.The match is case insensitive.

getNameModeAsEnum

public MetaCondition.NameMode getNameModeAsEnum()

Meta name test mode:

• "equals": Evaluates the DocumentChunk with a name equal to the specified one.
• "matches": Evaluates the DocumentChunk with a name matching the specified regular expression.The match is case insensitive.

isA

public static boolean isA(java.lang.String str,
                          MetaCondition.ValueMode item)

isOneOf

public static boolean isOneOf(java.lang.String str,
                              MetaCondition.ValueMode... items)

setValueMode

public void setValueMode(MetaCondition.ValueMode item)

Value test mode:

• "exists": Matches if a DocumentChunk pass the name condition.
• "equals": Matches if a DocumentChunk pass the name condition and the textual content is equal to the 'value' attribute.
• "contains": Matches if a DocumentChunk pass the name condition and the textual content contains 'value' (Pure string matching is performed without tokenization).
• "matches": Matches if a DocumentChunk pass the name condition and the textual content matches the regular expression specified by the 'value' attribute. The match is case insensitive.

getValueModeAsEnum

public MetaCondition.ValueMode getValueModeAsEnum()

Value test mode:

• "exists": Matches if a DocumentChunk pass the name condition.
• "equals": Matches if a DocumentChunk pass the name condition and the textual content is equal to the 'value' attribute.
• "contains": Matches if a DocumentChunk pass the name condition and the textual content contains 'value' (Pure string matching is performed without tokenization).
• "matches": Matches if a DocumentChunk pass the name condition and the textual content matches the regular expression specified by the 'value' attribute. The match is case insensitive.

setName

public void setName(java.lang.String name)

Name of the meta against which to check.

getName

public java.lang.String getName()

Name of the meta against which to check.

withName

public MetaCondition withName(java.lang.String name)

setNameMode

public void setNameMode(java.lang.String nameMode)

Meta name test mode:

• "equals": Evaluates the DocumentChunk with a name equal to the specified one.
• "matches": Evaluates the DocumentChunk with a name matching the specified regular expression.The match is case insensitive.

getNameMode

public java.lang.String getNameMode()

Meta name test mode:

• "equals": Evaluates the DocumentChunk with a name equal to the specified one.
• "matches": Evaluates the DocumentChunk with a name matching the specified regular expression.The match is case insensitive.

withNameMode

public MetaCondition withNameMode(java.lang.String nameMode)

setValueMode

public void setValueMode(java.lang.String valueMode)

Value test mode:

• "exists": Matches if a DocumentChunk pass the name condition.
• "equals": Matches if a DocumentChunk pass the name condition and the textual content is equal to the 'value' attribute.
• "contains": Matches if a DocumentChunk pass the name condition and the textual content contains 'value' (Pure string matching is performed without tokenization).
• "matches": Matches if a DocumentChunk pass the name condition and the textual content matches the regular expression specified by the 'value' attribute. The match is case insensitive.

getValueMode

public java.lang.String getValueMode()

Value test mode:

• "exists": Matches if a DocumentChunk pass the name condition.
• "equals": Matches if a DocumentChunk pass the name condition and the textual content is equal to the 'value' attribute.
• "contains": Matches if a DocumentChunk pass the name condition and the textual content contains 'value' (Pure string matching is performed without tokenization).
• "matches": Matches if a DocumentChunk pass the name condition and the textual content matches the regular expression specified by the 'value' attribute. The match is case insensitive.

withValueMode

public MetaCondition withValueMode(java.lang.String valueMode)

setValue

public void setValue(java.lang.String value)

The string to check against the value of DocumentChunks.

getValue

public java.lang.String getValue()

The string to check against the value of DocumentChunks.

withValue

public MetaCondition withValue(java.lang.String value)

makeCopy

public MetaCondition makeCopy()

Creates and returns a deep copy of this MetaCondition.

Overrides:

makeCopy in class AcceptCondition

readFrom

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

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

Overrides:

writeTo in class AcceptCondition

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this MetaCondition.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this MetaCondition.

Overrides:

toString in class AcceptCondition

check

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

Checks this MetaCondition.

Specified by:

check in interface com.exalead.util.Checkable

Overrides:

check in class AcceptCondition

Throws:

com.exalead.util.TypedException

accept

public <T> T accept(AcceptCondition.Transformer<T> transformer,
                    T[] t)
             throws com.exalead.util.TypedException

Specified by:

accept in class AcceptCondition

Throws:

com.exalead.util.TypedException