com.exalead.mot.components.sqi

Class Rule

java.lang.Object

com.exalead.mot.components.sqi.Rule

All Implemented Interfaces:

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

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

No documentation for this element.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_TRUST_LEVEL
java.lang.String	language
java.lang.String	mode
java.lang.String	name
java.lang.String	output
java.lang.String	postProcessorClass
int	trustLevel
java.lang.String	unusedWordPolicy
java.lang.String	value

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	getLanguage() language on which this rule is active
java.lang.String	getMode() mode=(match|filter)
java.lang.String	getName() rule name
java.lang.String	getOutput() output value of rule
java.lang.String	getPostProcessorClass() post processor class to apply on output of rule Must implement SQIPostProcessor interface
int	getTrustLevel() trust level of the output annotation
java.lang.String	getUnusedWordPolicy() Unused query word policy.
java.lang.String	getValue() Value of string using Semantic Query Interpreter Language See TRAC documentation for defails
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	setLanguage(java.lang.String language) language on which this rule is active
void	setMode(java.lang.String mode) mode=(match|filter)
void	setName(java.lang.String name) rule name
void	setOutput(java.lang.String output) output value of rule
void	setPostProcessorClass(java.lang.String postProcessorClass) post processor class to apply on output of rule Must implement SQIPostProcessor interface
void	setTrustLevel(int trustLevel) trust level of the output annotation
void	setUnusedWordPolicy(java.lang.String unusedWordPolicy) Unused query word policy.
void	setValue(java.lang.String value) Value of string using Semantic Query Interpreter Language See TRAC documentation for defails
java.lang.String	toString() String representation of this Rule.
Rule	withLanguage(java.lang.String language)
Rule	withMode(java.lang.String mode)
Rule	withName(java.lang.String name)
Rule	withOutput(java.lang.String output)
Rule	withPostProcessorClass(java.lang.String postProcessorClass)
Rule	withTrustLevel(int trustLevel)
Rule	withTrustLevel(java.lang.Integer trustLevel)
Rule	withUnusedWordPolicy(java.lang.String unusedWordPolicy)
Rule	withValue(java.lang.String value)
void	writeTo(java.io.OutputStream os) Write this Rule 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

mode

public java.lang.String mode

value

public java.lang.String value

output

public java.lang.String output

unusedWordPolicy

public java.lang.String unusedWordPolicy

language

public java.lang.String language

trustLevel

public int trustLevel

DEFAULT_TRUST_LEVEL

public static final int DEFAULT_TRUST_LEVEL

See Also:

Constant Field Values

postProcessorClass

public java.lang.String postProcessorClass

Constructor Detail

Rule

public Rule()

Rule

public Rule(Rule o)

Copy constructor

Method Detail

setName

public void setName(java.lang.String name)

rule name

getName

public java.lang.String getName()

rule name

withName

public Rule withName(java.lang.String name)

setMode

public void setMode(java.lang.String mode)

mode=(match|filter)

getMode

public java.lang.String getMode()

mode=(match|filter)

withMode

public Rule withMode(java.lang.String mode)

setValue

public void setValue(java.lang.String value)

Value of string using Semantic Query Interpreter Language
See TRAC documentation for defails

getValue

public java.lang.String getValue()

Value of string using Semantic Query Interpreter Language
See TRAC documentation for defails

withValue

public Rule withValue(java.lang.String value)

setOutput

public void setOutput(java.lang.String output)

output value of rule

getOutput

public java.lang.String getOutput()

output value of rule

withOutput

public Rule withOutput(java.lang.String output)

setUnusedWordPolicy

public void setUnusedWordPolicy(java.lang.String unusedWordPolicy)

Unused query word policy. If defined, overrides general value when this rule fires

getUnusedWordPolicy

public java.lang.String getUnusedWordPolicy()

Unused query word policy. If defined, overrides general value when this rule fires

withUnusedWordPolicy

public Rule withUnusedWordPolicy(java.lang.String unusedWordPolicy)

setLanguage

public void setLanguage(java.lang.String language)

language on which this rule is active

getLanguage

public java.lang.String getLanguage()

language on which this rule is active

withLanguage

public Rule withLanguage(java.lang.String language)

setTrustLevel

public void setTrustLevel(int trustLevel)

trust level of the output annotation

getTrustLevel

public int getTrustLevel()

trust level of the output annotation

withTrustLevel

public Rule withTrustLevel(int trustLevel)

withTrustLevel

public Rule withTrustLevel(java.lang.Integer trustLevel)

setPostProcessorClass

public void setPostProcessorClass(java.lang.String postProcessorClass)

post processor class to apply on output of rule
Must implement SQIPostProcessor interface

getPostProcessorClass

public java.lang.String getPostProcessorClass()

post processor class to apply on output of rule
Must implement SQIPostProcessor interface

withPostProcessorClass

public Rule withPostProcessorClass(java.lang.String postProcessorClass)

makeCopy

public Rule makeCopy()

Creates and returns a deep copy of this Rule.

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

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 java.lang.Object

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

Throws:

com.exalead.util.TypedException