com.exalead.linguistic.v10

Class SQI

java.lang.Object

com.exalead.linguistic.v10.SemanticProcessor

com.exalead.linguistic.v10.SQI

All Implemented Interfaces:

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

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

A SemanticProcessor applies semantic processing on the textual content
of the DocumentChunks.
A Semantic Processor creates SemanticAnnotations on tokens.
These SemanticAnnotations can then be used in the Mapping.

See Also:

Serialized Form

Nested Class Summary

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
java.lang.String	annotateUnusedTokensWith
boolean	breakOnLine
boolean	breakOnParagraph
boolean	breakOnSentence
static boolean	DEFAULT_BREAK_ON_LINE
static boolean	DEFAULT_BREAK_ON_PARAGRAPH
static boolean	DEFAULT_BREAK_ON_SENTENCE
static boolean	DEFAULT_EXPLICIT_ATOM_MATCH
static boolean	DEFAULT_MATCH_ALL_RULES
static boolean	DEFAULT_NO_OVERLAP
boolean	explicitAtomMatch
boolean	matchAllRules
boolean	noOverlap
java.lang.String	prefix
java.lang.String	resourceDir

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

contexts, name, src

Constructor Summary

Constructors

Constructor and Description
SQI()
SQI(SQI 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 SQI.
static SQI	fromString(java.lang.String s) String representation of this SQI.
java.lang.String	getAnnotateUnusedTokensWith() The annotation to set on the non-matching part of the input for postprocessing
java.lang.String	getPrefix() Output annotations prefix
java.lang.String	getResourceDir() URL for the resource (data://, file:// or resource://)
boolean	isBreakOnLine() If true: maximum one match per line, no match inter-line.
boolean	isBreakOnParagraph() If true: maximum one match per paragraph, no match inter-paragraph.
boolean	isBreakOnSentence() If true: maximum one match per sentence, no match inter-sentence. (will add SentenceFinder automatically).
boolean	isExplicitAtomMatch() If set to true, add extra annotations where named atoms have matched.
boolean	isMatchAllRules() If set to true, return the full list of matched rule. If false, return only the first matched rule.
boolean	isNoOverlap() If set to true, don't report overlapping matches, keep the leftmost longest.
SQI	makeCopy() Creates and returns a deep copy of this SQI.
static SQI	readFrom(java.io.InputStream is) Read this SQI from an XML fragment.
void	setAnnotateUnusedTokensWith(java.lang.String annotateUnusedTokensWith) The annotation to set on the non-matching part of the input for postprocessing
void	setBreakOnLine(boolean breakOnLine) If true: maximum one match per line, no match inter-line.
void	setBreakOnParagraph(boolean breakOnParagraph) If true: maximum one match per paragraph, no match inter-paragraph.
void	setBreakOnSentence(boolean breakOnSentence) If true: maximum one match per sentence, no match inter-sentence. (will add SentenceFinder automatically).
void	setExplicitAtomMatch(boolean explicitAtomMatch) If set to true, add extra annotations where named atoms have matched.
void	setMatchAllRules(boolean matchAllRules) If set to true, return the full list of matched rule. If false, return only the first matched rule.
void	setNoOverlap(boolean noOverlap) If set to true, don't report overlapping matches, keep the leftmost longest.
void	setPrefix(java.lang.String prefix) Output annotations prefix
void	setResourceDir(java.lang.String resourceDir) URL for the resource (data://, file:// or resource://)
java.lang.String	toString() String representation of this SQI.
SQI	withAnnotateUnusedTokensWith(java.lang.String annotateUnusedTokensWith)
SQI	withBreakOnLine(boolean breakOnLine)
SQI	withBreakOnLine(java.lang.Boolean breakOnLine)
SQI	withBreakOnParagraph(boolean breakOnParagraph)
SQI	withBreakOnParagraph(java.lang.Boolean breakOnParagraph)
SQI	withBreakOnSentence(boolean breakOnSentence)
SQI	withBreakOnSentence(java.lang.Boolean breakOnSentence)
SQI	withContexts(java.lang.String contexts)
SQI	withExplicitAtomMatch(boolean explicitAtomMatch)
SQI	withExplicitAtomMatch(java.lang.Boolean explicitAtomMatch)
SQI	withMatchAllRules(boolean matchAllRules)
SQI	withMatchAllRules(java.lang.Boolean matchAllRules)
SQI	withName(java.lang.String name)
SQI	withNoOverlap(boolean noOverlap)
SQI	withNoOverlap(java.lang.Boolean noOverlap)
SQI	withPrefix(java.lang.String prefix)
SQI	withResourceDir(java.lang.String resourceDir)
SQI	withSrc(java.lang.String src) Deprecated.
void	writeTo(java.io.OutputStream os) Write this SQI 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

resourceDir

public java.lang.String resourceDir

breakOnSentence

public boolean breakOnSentence

DEFAULT_BREAK_ON_SENTENCE

public static final boolean DEFAULT_BREAK_ON_SENTENCE

See Also:

Constant Field Values

breakOnParagraph

public boolean breakOnParagraph

DEFAULT_BREAK_ON_PARAGRAPH

public static final boolean DEFAULT_BREAK_ON_PARAGRAPH

See Also:

Constant Field Values

breakOnLine

public boolean breakOnLine

DEFAULT_BREAK_ON_LINE

public static final boolean DEFAULT_BREAK_ON_LINE

See Also:

Constant Field Values

matchAllRules

public boolean matchAllRules

DEFAULT_MATCH_ALL_RULES

public static final boolean DEFAULT_MATCH_ALL_RULES

See Also:

Constant Field Values

explicitAtomMatch

public boolean explicitAtomMatch

DEFAULT_EXPLICIT_ATOM_MATCH

public static final boolean DEFAULT_EXPLICIT_ATOM_MATCH

See Also:

Constant Field Values

noOverlap

public boolean noOverlap

DEFAULT_NO_OVERLAP

public static final boolean DEFAULT_NO_OVERLAP

See Also:

Constant Field Values

prefix

public java.lang.String prefix

annotateUnusedTokensWith

public java.lang.String annotateUnusedTokensWith

Constructor Detail

SQI

public SQI()

SQI

public SQI(SQI o)

Copy constructor

Method Detail

withName

public SQI withName(java.lang.String name)

Overrides:

withName in class SemanticProcessor

withContexts

public SQI withContexts(java.lang.String contexts)

Overrides:

withContexts in class SemanticProcessor

withSrc

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

Deprecated.

Overrides:

withSrc in class SemanticProcessor

setResourceDir

public void setResourceDir(java.lang.String resourceDir)

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

getResourceDir

public java.lang.String getResourceDir()

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

withResourceDir

public SQI withResourceDir(java.lang.String resourceDir)

setBreakOnSentence

public void setBreakOnSentence(boolean breakOnSentence)

If true: maximum one match per sentence, no match inter-sentence.
(will add SentenceFinder automatically).

isBreakOnSentence

public boolean isBreakOnSentence()

If true: maximum one match per sentence, no match inter-sentence.
(will add SentenceFinder automatically).

withBreakOnSentence

public SQI withBreakOnSentence(boolean breakOnSentence)

withBreakOnSentence

public SQI withBreakOnSentence(java.lang.Boolean breakOnSentence)

setBreakOnParagraph

public void setBreakOnParagraph(boolean breakOnParagraph)

If true: maximum one match per paragraph, no match inter-paragraph.

isBreakOnParagraph

public boolean isBreakOnParagraph()

If true: maximum one match per paragraph, no match inter-paragraph.

withBreakOnParagraph

public SQI withBreakOnParagraph(boolean breakOnParagraph)

withBreakOnParagraph

public SQI withBreakOnParagraph(java.lang.Boolean breakOnParagraph)

setBreakOnLine

public void setBreakOnLine(boolean breakOnLine)

If true: maximum one match per line, no match inter-line.

isBreakOnLine

public boolean isBreakOnLine()

If true: maximum one match per line, no match inter-line.

withBreakOnLine

public SQI withBreakOnLine(boolean breakOnLine)

withBreakOnLine

public SQI withBreakOnLine(java.lang.Boolean breakOnLine)

setMatchAllRules

public void setMatchAllRules(boolean matchAllRules)

If set to true, return the full list of matched rule.
If false, return only the first matched rule.

isMatchAllRules

public boolean isMatchAllRules()

If set to true, return the full list of matched rule.
If false, return only the first matched rule.

withMatchAllRules

public SQI withMatchAllRules(boolean matchAllRules)

withMatchAllRules

public SQI withMatchAllRules(java.lang.Boolean matchAllRules)

setExplicitAtomMatch

public void setExplicitAtomMatch(boolean explicitAtomMatch)

If set to true, add extra annotations where named atoms have matched.

isExplicitAtomMatch

public boolean isExplicitAtomMatch()

If set to true, add extra annotations where named atoms have matched.

withExplicitAtomMatch

public SQI withExplicitAtomMatch(boolean explicitAtomMatch)

withExplicitAtomMatch

public SQI withExplicitAtomMatch(java.lang.Boolean explicitAtomMatch)

setNoOverlap

public void setNoOverlap(boolean noOverlap)

If set to true, don't report overlapping matches, keep the leftmost longest.

isNoOverlap

public boolean isNoOverlap()

If set to true, don't report overlapping matches, keep the leftmost longest.

withNoOverlap

public SQI withNoOverlap(boolean noOverlap)

withNoOverlap

public SQI withNoOverlap(java.lang.Boolean noOverlap)

setPrefix

public void setPrefix(java.lang.String prefix)

Output annotations prefix

getPrefix

public java.lang.String getPrefix()

Output annotations prefix

withPrefix

public SQI withPrefix(java.lang.String prefix)

setAnnotateUnusedTokensWith

public void setAnnotateUnusedTokensWith(java.lang.String annotateUnusedTokensWith)

The annotation to set on the non-matching part of the input for postprocessing

getAnnotateUnusedTokensWith

public java.lang.String getAnnotateUnusedTokensWith()

The annotation to set on the non-matching part of the input for postprocessing

withAnnotateUnusedTokensWith

public SQI withAnnotateUnusedTokensWith(java.lang.String annotateUnusedTokensWith)

makeCopy

public SQI makeCopy()

Creates and returns a deep copy of this SQI.

Overrides:

makeCopy in class SemanticProcessor

readFrom

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

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

Overrides:

writeTo in class SemanticProcessor

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this SQI.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this SQI.

Overrides:

toString in class SemanticProcessor

check

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

Checks this SQI.

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