com.exalead.mot.components.semanticextractor

Class Rule

java.lang.Object

com.exalead.linguistic.v10.Modifiable

com.exalead.mot.components.semanticextractor.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 semantic extraction rule.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Rule.Mode

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_MODE
static int	DEFAULT_TRUST_LEVEL
java.lang.String	id
java.lang.String	language
java.lang.String	mode
java.lang.String	name
java.lang.String	output
java.lang.String	pattern
int	trustLevel
java.lang.String	unusedWordPolicy
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	getId() Unique rule reference.
java.lang.String	getLanguage() Which language the rule should be applied to.
java.lang.String	getMode() Rule mode.
Rule.Mode	getModeAsEnum() Rule mode.
java.lang.String	getName() Rule name.
java.lang.String	getOutput() Rule output name.
java.lang.String	getPattern() Rule pattern
int	getTrustLevel() Rule trust level.
java.lang.String	getUnusedWordPolicy() Unused query word policy.
java.lang.String	getValue() Rule value.
static boolean	isA(java.lang.String str, Rule.Mode item)
static boolean	isOneOf(java.lang.String str, Rule.Mode... items)
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	setId(java.lang.String id) Unique rule reference.
void	setLanguage(java.lang.String language) Which language the rule should be applied to.
void	setMode(Rule.Mode item) Rule mode.
void	setMode(java.lang.String mode) Rule mode.
void	setName(java.lang.String name) Rule name.
void	setOutput(java.lang.String output) Rule output name.
void	setPattern(java.lang.String pattern) Rule pattern
void	setTrustLevel(int trustLevel) Rule trust level.
void	setUnusedWordPolicy(java.lang.String unusedWordPolicy) Unused query word policy.
void	setValue(java.lang.String value) Rule value.
java.lang.String	toString() String representation of this Rule.
Rule	withId(java.lang.String id)
Rule	withLanguage(java.lang.String language)
Rule	withMode(java.lang.String mode)
Rule	withModifiedAt(java.lang.Long modifiedAt)
Rule	withModifiedBy(java.lang.String modifiedBy)
Rule	withName(java.lang.String name)
Rule	withOutput(java.lang.String output)
Rule	withPattern(java.lang.String pattern)
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 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

id

public java.lang.String id

name

public java.lang.String name

mode

public java.lang.String mode

DEFAULT_MODE

public static final java.lang.String DEFAULT_MODE

See Also:

Constant Field Values

pattern

public java.lang.String pattern

output

public java.lang.String output

unusedWordPolicy

public java.lang.String unusedWordPolicy

trustLevel

public int trustLevel

DEFAULT_TRUST_LEVEL

public static final int DEFAULT_TRUST_LEVEL

See Also:

Constant Field Values

language

public java.lang.String language

value

public java.lang.String value

Constructor Detail

Rule

public Rule()

Rule

public Rule(Rule o)

Copy constructor

Method Detail

isA

public static boolean isA(java.lang.String str,
                          Rule.Mode item)

isOneOf

public static boolean isOneOf(java.lang.String str,
                              Rule.Mode... items)

setMode

public void setMode(Rule.Mode item)

Rule mode.

getModeAsEnum

public Rule.Mode getModeAsEnum()

Rule mode.

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

setId

public void setId(java.lang.String id)

Unique rule reference. Only used by the GUI.

getId

public java.lang.String getId()

Unique rule reference. Only used by the GUI.

withId

public Rule withId(java.lang.String id)

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)

Rule mode.

getMode

public java.lang.String getMode()

Rule mode.

withMode

public Rule withMode(java.lang.String mode)

setPattern

public void setPattern(java.lang.String pattern)

Rule pattern

getPattern

public java.lang.String getPattern()

Rule pattern

withPattern

public Rule withPattern(java.lang.String pattern)

setOutput

public void setOutput(java.lang.String output)

Rule output name.

getOutput

public java.lang.String getOutput()

Rule output name.

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)

setTrustLevel

public void setTrustLevel(int trustLevel)

Rule trust level. A percentage showing this rule's relevance compared to others.

getTrustLevel

public int getTrustLevel()

Rule trust level. A percentage showing this rule's relevance compared to others.

withTrustLevel

public Rule withTrustLevel(int trustLevel)

withTrustLevel

public Rule withTrustLevel(java.lang.Integer trustLevel)

setLanguage

public void setLanguage(java.lang.String language)

Which language the rule should be applied to.

getLanguage

public java.lang.String getLanguage()

Which language the rule should be applied to.

withLanguage

public Rule withLanguage(java.lang.String language)

setValue

public void setValue(java.lang.String value)

Rule value.

getValue

public java.lang.String getValue()

Rule value.

withValue

public Rule withValue(java.lang.String value)

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