com.exalead.indexing.analysis.v10

Class FastRulesMatcher

java.lang.Object

com.exalead.indexing.analysis.v10.SemanticProcessor

com.exalead.indexing.analysis.v10.FastRulesMatcher

All Implemented Interfaces:

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

public class FastRulesMatcher
extends SemanticProcessor
implements com.exalead.util.Checkable, java.io.Serializable

Annotates a document using a set of XML rules, compiled for efficiency.
The rules are described with the query language using the AND, OR and NOT operators, as well as 'context' matching operators.
The rules can also match whole chunks (and not just words) per regular expressions. Annotations generated:

• Depending on the resources (See FastRulesDefinition)

See Also:

Serialized Form

Nested Class Summary

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

SemanticProcessor.FromDataModel, SemanticProcessor.Transformer<T>, SemanticProcessor.Visitor

Field Summary

Fields

Modifier and Type	Field and Description
boolean	allowsExprStartingBySeparators
static boolean	DEFAULT_ALLOWS_EXPR_STARTING_BY_SEPARATORS
java.lang.String	resourceDir

Fields inherited from class com.exalead.indexing.analysis.v10.SemanticProcessor

contexts, dataModelClass, dataModelProperty, dataModelState, DEFAULT_DISABLED, disabled, fromDataModel, name

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
<T> T	accept(SemanticProcessor.Transformer<T> transformer, T[] t)
void	accept(SemanticProcessor.Visitor visitor)
void	check(boolean deep, java.lang.String errorContext) Checks this FastRulesMatcher.
static FastRulesMatcher	fromString(java.lang.String s) String representation of this FastRulesMatcher.
java.lang.String	getResourceDir() Directory containing the matcher resources.
boolean	isAllowsExprStartingBySeparators() If you have expressions starting with a separator (",", ";", "&", ...), then you must set this option to true.
FastRulesMatcher	makeCopy() Creates and returns a deep copy of this FastRulesMatcher.
static FastRulesMatcher	readFrom(java.io.InputStream is) Read this FastRulesMatcher from an XML fragment.
void	setAllowsExprStartingBySeparators(boolean allowsExprStartingBySeparators) If you have expressions starting with a separator (",", ";", "&", ...), then you must set this option to true.
void	setResourceDir(java.lang.String resourceDir) Directory containing the matcher resources.
java.lang.String	toString() String representation of this FastRulesMatcher.
FastRulesMatcher	withAllowsExprStartingBySeparators(boolean allowsExprStartingBySeparators)
FastRulesMatcher	withAllowsExprStartingBySeparators(java.lang.Boolean allowsExprStartingBySeparators)
FastRulesMatcher	withContexts(java.lang.String contexts)
FastRulesMatcher	withDataModelClass(java.lang.String dataModelClass)
FastRulesMatcher	withDataModelProperty(java.lang.String dataModelProperty)
FastRulesMatcher	withDataModelState(java.lang.String dataModelState)
FastRulesMatcher	withDisabled(boolean disabled)
FastRulesMatcher	withDisabled(java.lang.Boolean disabled)
FastRulesMatcher	withFromDataModel(SemanticProcessor fromDataModel)
FastRulesMatcher	withName(java.lang.String name)
FastRulesMatcher	withResourceDir(java.lang.String resourceDir)
void	writeTo(java.io.OutputStream os) Write this FastRulesMatcher as an XML fragment

Methods inherited from class com.exalead.indexing.analysis.v10.SemanticProcessor

getContexts, getDataModelClass, getDataModelProperty, getDataModelState, getFromDataModel, getName, isDisabled, setContexts, setDataModelClass, setDataModelProperty, setDataModelState, setDisabled, setFromDataModel, setName

Methods inherited from class java.lang.Object

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

Field Detail

resourceDir

public java.lang.String resourceDir

allowsExprStartingBySeparators

public boolean allowsExprStartingBySeparators

DEFAULT_ALLOWS_EXPR_STARTING_BY_SEPARATORS

public static final boolean DEFAULT_ALLOWS_EXPR_STARTING_BY_SEPARATORS

See Also:

Constant Field Values

Constructor Detail

FastRulesMatcher

public FastRulesMatcher()

FastRulesMatcher

public FastRulesMatcher(FastRulesMatcher o)

Copy constructor

Method Detail

withName

public FastRulesMatcher withName(java.lang.String name)

Overrides:

withName in class SemanticProcessor

withContexts

public FastRulesMatcher withContexts(java.lang.String contexts)

Overrides:

withContexts in class SemanticProcessor

withFromDataModel

public FastRulesMatcher withFromDataModel(SemanticProcessor fromDataModel)

withDataModelState

public FastRulesMatcher withDataModelState(java.lang.String dataModelState)

Overrides:

withDataModelState in class SemanticProcessor

withDataModelClass

public FastRulesMatcher withDataModelClass(java.lang.String dataModelClass)

Overrides:

withDataModelClass in class SemanticProcessor

withDataModelProperty

public FastRulesMatcher withDataModelProperty(java.lang.String dataModelProperty)

Overrides:

withDataModelProperty in class SemanticProcessor

withDisabled

public FastRulesMatcher withDisabled(boolean disabled)

Overrides:

withDisabled in class SemanticProcessor

withDisabled

public FastRulesMatcher withDisabled(java.lang.Boolean disabled)

Overrides:

withDisabled in class SemanticProcessor

setResourceDir

public void setResourceDir(java.lang.String resourceDir)

Directory containing the matcher resources. Must not be empty.

getResourceDir

public java.lang.String getResourceDir()

Directory containing the matcher resources. Must not be empty.

withResourceDir

public FastRulesMatcher withResourceDir(java.lang.String resourceDir)

setAllowsExprStartingBySeparators

public void setAllowsExprStartingBySeparators(boolean allowsExprStartingBySeparators)

If you have expressions starting with a separator (",", ";", "&", ...), then you must set this option to true.

isAllowsExprStartingBySeparators

public boolean isAllowsExprStartingBySeparators()

If you have expressions starting with a separator (",", ";", "&", ...), then you must set this option to true.

withAllowsExprStartingBySeparators

public FastRulesMatcher withAllowsExprStartingBySeparators(boolean allowsExprStartingBySeparators)

withAllowsExprStartingBySeparators

public FastRulesMatcher withAllowsExprStartingBySeparators(java.lang.Boolean allowsExprStartingBySeparators)

makeCopy

public FastRulesMatcher makeCopy()

Creates and returns a deep copy of this FastRulesMatcher.

Overrides:

makeCopy in class SemanticProcessor

readFrom

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

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

Overrides:

writeTo in class SemanticProcessor

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this FastRulesMatcher.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this FastRulesMatcher.

Overrides:

toString in class SemanticProcessor

check

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

Checks this FastRulesMatcher.

Specified by:

check in interface com.exalead.util.Checkable

Overrides:

check in class SemanticProcessor

Throws:

com.exalead.util.TypedException

accept

public void accept(SemanticProcessor.Visitor visitor)
            throws com.exalead.util.TypedException

Specified by:

accept in class SemanticProcessor

Throws:

com.exalead.util.TypedException

accept

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

Specified by:

accept in class SemanticProcessor

Throws:

com.exalead.util.TypedException