com.exalead.mot.components.fastrules

Class Rule

java.lang.Object

com.exalead.linguistic.v10.Modifiable

com.exalead.mot.components.fastrules.Rule

All Implemented Interfaces:

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

public class Rule
extends Modifiable
implements com.exalead.util.Checkable, java.io.Serializable

A rule expressing constraints on a document content

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DEFAULT_EXCEPTION_RULE
static java.lang.String	DEFAULT_LANG
boolean	exceptionRule
java.lang.String	lang
java.lang.String	value

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

modifiedAt, modifiedBy

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	check(boolean deep, java.lang.String errorContext) Checks this Rule.
static Rule	fromString(java.lang.String s) String representation of this Rule.
java.lang.String	getLang() Restrict this query to a specific language
java.lang.String	getValue() A query defined with a subset of Exalead User Query Language
boolean	isExceptionRule() Makes the rule an exception rule instead of a normal rule. When any of the exception rules of a category matches, the category is not assigned to the document, even if some of its normal rules match.
Rule	makeCopy() Creates and returns a deep copy of this Rule.
static Rule	readFrom(java.io.InputStream is) Read this Rule from an XML fragment.
void	setExceptionRule(boolean exceptionRule) Makes the rule an exception rule instead of a normal rule. When any of the exception rules of a category matches, the category is not assigned to the document, even if some of its normal rules match.
void	setLang(java.lang.String lang) Restrict this query to a specific language
void	setValue(java.lang.String value) A query defined with a subset of Exalead User Query Language
java.lang.String	toString() String representation of this Rule.
Rule	withExceptionRule(boolean exceptionRule)
Rule	withExceptionRule(java.lang.Boolean exceptionRule)
Rule	withLang(java.lang.String lang)
Rule	withModifiedAt(java.lang.Long modifiedAt)
Rule	withModifiedBy(java.lang.String modifiedBy)
Rule	withValue(java.lang.String value)
void	writeTo(java.io.OutputStream os) Write this Rule as an XML fragment

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

value

public java.lang.String value

exceptionRule

public boolean exceptionRule

DEFAULT_EXCEPTION_RULE

public static final boolean DEFAULT_EXCEPTION_RULE

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

Constructor Detail

Rule

public Rule()

Rule

public Rule(Rule o)

Copy constructor

Method Detail

withModifiedBy

public Rule withModifiedBy(java.lang.String modifiedBy)

Overrides:

withModifiedBy in class Modifiable

withModifiedAt

public Rule withModifiedAt(java.lang.Long modifiedAt)

Overrides:

withModifiedAt in class Modifiable

setValue

public void setValue(java.lang.String value)

A query defined with a subset of Exalead User Query Language

getValue

public java.lang.String getValue()

A query defined with a subset of Exalead User Query Language

withValue

public Rule withValue(java.lang.String value)

setExceptionRule

public void setExceptionRule(boolean exceptionRule)

Makes the rule an exception rule instead of a normal rule.
When any of the exception rules of a category matches, the category is not assigned to the document, even if some of its normal rules match.

isExceptionRule

public boolean isExceptionRule()

Makes the rule an exception rule instead of a normal rule.
When any of the exception rules of a category matches, the category is not assigned to the document, even if some of its normal rules match.

withExceptionRule

public Rule withExceptionRule(boolean exceptionRule)

withExceptionRule

public Rule withExceptionRule(java.lang.Boolean exceptionRule)

setLang

public void setLang(java.lang.String lang)

Restrict this query to a specific language

getLang

public java.lang.String getLang()

Restrict this query to a specific language

withLang

public Rule withLang(java.lang.String lang)

makeCopy

public Rule makeCopy()

Creates and returns a deep copy of this Rule.

Overrides:

makeCopy in class Modifiable

readFrom

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

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

Overrides:

writeTo in class Modifiable

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this Rule.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this Rule.

Overrides:

toString in class Modifiable

check

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

Checks this Rule.

Specified by:

check in interface com.exalead.util.Checkable

Overrides:

check in class Modifiable

Throws:

com.exalead.util.TypedException