com.exalead.linguistic.v10

Class RulesMatcher

java.lang.Object

com.exalead.linguistic.v10.SemanticProcessor

com.exalead.linguistic.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 detects 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 expressions, word matching
and Boolean operators over content.
Please refer to the CloudView Configuration Reference for details.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RulesMatcher.MatchingPolicy

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

SemanticProcessor.Transformer<T>, SemanticProcessor.Visitor

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_MATCHING_POLICY
java.lang.String	language
java.lang.String	matchingPolicy
java.lang.String	resourceFile

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

contexts, name, src

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 the rules matcher is activated.
java.lang.String	getMatchingPolicy() Matching policy (longest, shortest).
RulesMatcher.MatchingPolicy	getMatchingPolicyAsEnum() Matching policy (longest, shortest).
java.lang.String	getResourceFile() URL for the resource (data://, file;// or resource://)
static boolean	isA(java.lang.String str, RulesMatcher.MatchingPolicy item)
static boolean	isOneOf(java.lang.String str, RulesMatcher.MatchingPolicy... items)
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 the rules matcher is activated.
void	setMatchingPolicy(RulesMatcher.MatchingPolicy item) Matching policy (longest, shortest).
void	setMatchingPolicy(java.lang.String matchingPolicy) Matching policy (longest, shortest).
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	withLanguage(java.lang.String language)
RulesMatcher	withMatchingPolicy(java.lang.String matchingPolicy)
RulesMatcher	withName(java.lang.String name)
RulesMatcher	withResourceFile(java.lang.String resourceFile)
RulesMatcher	withSrc(java.lang.String src) Deprecated.
void	writeTo(java.io.OutputStream os) Write this RulesMatcher as an XML fragment

Methods inherited from class com.exalead.linguistic.v10.SemanticProcessor

getContexts, getName, getSrc, setContexts, setName, setSrc

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

matchingPolicy

public java.lang.String matchingPolicy

DEFAULT_MATCHING_POLICY

public static final java.lang.String DEFAULT_MATCHING_POLICY

See Also:

Constant Field Values

language

public java.lang.String language

Constructor Detail

RulesMatcher

public RulesMatcher()

RulesMatcher

public RulesMatcher(RulesMatcher o)

Copy constructor

Method Detail

isA

public static boolean isA(java.lang.String str,
                          RulesMatcher.MatchingPolicy item)

isOneOf

public static boolean isOneOf(java.lang.String str,
                              RulesMatcher.MatchingPolicy... items)

setMatchingPolicy

public void setMatchingPolicy(RulesMatcher.MatchingPolicy item)

Matching policy (longest, shortest).

getMatchingPolicyAsEnum

public RulesMatcher.MatchingPolicy getMatchingPolicyAsEnum()

Matching policy (longest, shortest).

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

withSrc

@Deprecated
public RulesMatcher withSrc(java.lang.String src)

Deprecated.

Overrides:

withSrc 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)

setMatchingPolicy

public void setMatchingPolicy(java.lang.String matchingPolicy)

Matching policy (longest, shortest).

getMatchingPolicy

public java.lang.String getMatchingPolicy()

Matching policy (longest, shortest).

withMatchingPolicy

public RulesMatcher withMatchingPolicy(java.lang.String matchingPolicy)

setLanguage

public void setLanguage(java.lang.String language)

Language for which the rules matcher is activated.

getLanguage

public java.lang.String getLanguage()

Language for which the rules matcher 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