com.exalead.indexing.analysis.v10

Class RulesMatcher

java.lang.Object

com.exalead.indexing.analysis.v10.SemanticProcessor

com.exalead.indexing.analysis.v10.RulesMatcher

All Implemented Interfaces:

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

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

A RuleMatcher applies a rule engine on the textual content of the DocumentChunks.
The rules are defined in a separate XML 'resourceFile' and are a combination of regular expression, word matching and boolean operators over content. Annotations generated:

• The matching rule defined in the XML specifies the annotation to generate

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
java.lang.String	language
java.lang.String	resourceFile

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
RulesMatcher()
RulesMatcher(RulesMatcher 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 RulesMatcher.
static RulesMatcher	fromString(java.lang.String s) String representation of this RulesMatcher.
java.lang.String	getLanguage() Language for which this processor is activated.
java.lang.String	getResourceFile() URL for the resource (data://, file;// or resource://).
RulesMatcher	makeCopy() Creates and returns a deep copy of this RulesMatcher.
static RulesMatcher	readFrom(java.io.InputStream is) Read this RulesMatcher from an XML fragment.
void	setLanguage(java.lang.String language) Language for which this processor is activated.
void	setResourceFile(java.lang.String resourceFile) URL for the resource (data://, file;// or resource://).
java.lang.String	toString() String representation of this RulesMatcher.
RulesMatcher	withContexts(java.lang.String contexts)
RulesMatcher	withDataModelClass(java.lang.String dataModelClass)
RulesMatcher	withDataModelProperty(java.lang.String dataModelProperty)
RulesMatcher	withDataModelState(java.lang.String dataModelState)
RulesMatcher	withDisabled(boolean disabled)
RulesMatcher	withDisabled(java.lang.Boolean disabled)
RulesMatcher	withFromDataModel(SemanticProcessor fromDataModel)
RulesMatcher	withLanguage(java.lang.String language)
RulesMatcher	withName(java.lang.String name)
RulesMatcher	withResourceFile(java.lang.String resourceFile)
void	writeTo(java.io.OutputStream os) Write this RulesMatcher 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

resourceFile

public java.lang.String resourceFile

language

public java.lang.String language

Constructor Detail

RulesMatcher

public RulesMatcher()

RulesMatcher

public RulesMatcher(RulesMatcher o)

Copy constructor

Method Detail

withName

public RulesMatcher withName(java.lang.String name)

Overrides:

withName in class SemanticProcessor

withContexts

public RulesMatcher withContexts(java.lang.String contexts)

Overrides:

withContexts in class SemanticProcessor

withFromDataModel

public RulesMatcher withFromDataModel(SemanticProcessor fromDataModel)

withDataModelState

public RulesMatcher withDataModelState(java.lang.String dataModelState)

Overrides:

withDataModelState in class SemanticProcessor

withDataModelClass

public RulesMatcher withDataModelClass(java.lang.String dataModelClass)

Overrides:

withDataModelClass in class SemanticProcessor

withDataModelProperty

public RulesMatcher withDataModelProperty(java.lang.String dataModelProperty)

Overrides:

withDataModelProperty in class SemanticProcessor

withDisabled

public RulesMatcher withDisabled(boolean disabled)

Overrides:

withDisabled in class SemanticProcessor

withDisabled

public RulesMatcher withDisabled(java.lang.Boolean disabled)

Overrides:

withDisabled in class SemanticProcessor

setResourceFile

public void setResourceFile(java.lang.String resourceFile)

URL for the resource (data://, file;// or resource://).

getResourceFile

public java.lang.String getResourceFile()

URL for the resource (data://, file;// or resource://).

withResourceFile

public RulesMatcher withResourceFile(java.lang.String resourceFile)

setLanguage

public void setLanguage(java.lang.String language)

Language for which this processor is activated.

getLanguage

public java.lang.String getLanguage()

Language for which this processor is activated.

withLanguage

public RulesMatcher withLanguage(java.lang.String language)

makeCopy

public RulesMatcher makeCopy()

Creates and returns a deep copy of this RulesMatcher.

Overrides:

makeCopy in class SemanticProcessor

readFrom

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

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

Overrides:

writeTo in class SemanticProcessor

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this RulesMatcher.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this RulesMatcher.

Overrides:

toString in class SemanticProcessor

check

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

Checks this RulesMatcher.

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