com.exalead.linguistic.v10

Class SemanticExtractor

java.lang.Object

com.exalead.linguistic.v10.SemanticProcessor

com.exalead.linguistic.v10.SemanticExtractor

All Implemented Interfaces:

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

public class SemanticExtractor
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
boolean	allowOverlap
java.lang.String	annotateUnusedTokensWith
boolean	breakOnLine
boolean	breakOnParagraph
boolean	breakOnSentence
static boolean	DEFAULT_ALLOW_OVERLAP
static boolean	DEFAULT_BREAK_ON_LINE
static boolean	DEFAULT_BREAK_ON_PARAGRAPH
static boolean	DEFAULT_BREAK_ON_SENTENCE
static boolean	DEFAULT_MATCH_ALL_RULES
java.lang.String	language
boolean	matchAllRules
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
SemanticExtractor()
SemanticExtractor(SemanticExtractor 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 SemanticExtractor.
static SemanticExtractor	fromString(java.lang.String s) String representation of this SemanticExtractor.
java.lang.String	getAnnotateUnusedTokensWith() The annotation to set on the non-matching part of the input for postprocessing
java.lang.String	getLanguage() Language for which the extractor is activated. If null, all languages are activated.
java.lang.String	getPrefix() Output annotations prefix
java.lang.String	getResourceDir() URL for the resource (data://, file:// or resource://)
boolean	isAllowOverlap() If true, reports matches from different rules even if they overlap
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	isMatchAllRules() Returns the full list of matched rules. If false, returns only the first matched rule.
SemanticExtractor	makeCopy() Creates and returns a deep copy of this SemanticExtractor.
static SemanticExtractor	readFrom(java.io.InputStream is) Read this SemanticExtractor from an XML fragment.
void	setAllowOverlap(boolean allowOverlap) If true, reports matches from different rules even if they overlap
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	setLanguage(java.lang.String language) Language for which the extractor is activated. If null, all languages are activated.
void	setMatchAllRules(boolean matchAllRules) Returns the full list of matched rules. If false, returns only the first matched rule.
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 SemanticExtractor.
SemanticExtractor	withAllowOverlap(boolean allowOverlap)
SemanticExtractor	withAllowOverlap(java.lang.Boolean allowOverlap)
SemanticExtractor	withAnnotateUnusedTokensWith(java.lang.String annotateUnusedTokensWith)
SemanticExtractor	withBreakOnLine(boolean breakOnLine)
SemanticExtractor	withBreakOnLine(java.lang.Boolean breakOnLine)
SemanticExtractor	withBreakOnParagraph(boolean breakOnParagraph)
SemanticExtractor	withBreakOnParagraph(java.lang.Boolean breakOnParagraph)
SemanticExtractor	withBreakOnSentence(boolean breakOnSentence)
SemanticExtractor	withBreakOnSentence(java.lang.Boolean breakOnSentence)
SemanticExtractor	withContexts(java.lang.String contexts)
SemanticExtractor	withLanguage(java.lang.String language)
SemanticExtractor	withMatchAllRules(boolean matchAllRules)
SemanticExtractor	withMatchAllRules(java.lang.Boolean matchAllRules)
SemanticExtractor	withName(java.lang.String name)
SemanticExtractor	withPrefix(java.lang.String prefix)
SemanticExtractor	withResourceDir(java.lang.String resourceDir)
SemanticExtractor	withSrc(java.lang.String src) Deprecated.
void	writeTo(java.io.OutputStream os) Write this SemanticExtractor 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

language

public java.lang.String language

prefix

public java.lang.String prefix

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

annotateUnusedTokensWith

public java.lang.String annotateUnusedTokensWith

allowOverlap

public boolean allowOverlap

DEFAULT_ALLOW_OVERLAP

public static final boolean DEFAULT_ALLOW_OVERLAP

See Also:

Constant Field Values

Constructor Detail

SemanticExtractor

public SemanticExtractor()

SemanticExtractor

public SemanticExtractor(SemanticExtractor o)

Copy constructor

Method Detail

withName

public SemanticExtractor withName(java.lang.String name)

Overrides:

withName in class SemanticProcessor

withContexts

public SemanticExtractor withContexts(java.lang.String contexts)

Overrides:

withContexts in class SemanticProcessor

withSrc

@Deprecated
public SemanticExtractor 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 SemanticExtractor withResourceDir(java.lang.String resourceDir)

setLanguage

public void setLanguage(java.lang.String language)

Language for which the extractor is activated.
If null, all languages are activated.

getLanguage

public java.lang.String getLanguage()

Language for which the extractor is activated.
If null, all languages are activated.

withLanguage

public SemanticExtractor withLanguage(java.lang.String language)

setPrefix

public void setPrefix(java.lang.String prefix)

Output annotations prefix

getPrefix

public java.lang.String getPrefix()

Output annotations prefix

withPrefix

public SemanticExtractor withPrefix(java.lang.String prefix)

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 SemanticExtractor withBreakOnSentence(boolean breakOnSentence)

withBreakOnSentence

public SemanticExtractor 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 SemanticExtractor withBreakOnParagraph(boolean breakOnParagraph)

withBreakOnParagraph

public SemanticExtractor 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 SemanticExtractor withBreakOnLine(boolean breakOnLine)

withBreakOnLine

public SemanticExtractor withBreakOnLine(java.lang.Boolean breakOnLine)

setMatchAllRules

public void setMatchAllRules(boolean matchAllRules)

Returns the full list of matched rules.
If false, returns only the first matched rule.

isMatchAllRules

public boolean isMatchAllRules()

Returns the full list of matched rules.
If false, returns only the first matched rule.

withMatchAllRules

public SemanticExtractor withMatchAllRules(boolean matchAllRules)

withMatchAllRules

public SemanticExtractor withMatchAllRules(java.lang.Boolean matchAllRules)

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 SemanticExtractor withAnnotateUnusedTokensWith(java.lang.String annotateUnusedTokensWith)

setAllowOverlap

public void setAllowOverlap(boolean allowOverlap)

If true, reports matches from different rules even if they overlap

isAllowOverlap

public boolean isAllowOverlap()

If true, reports matches from different rules even if they overlap

withAllowOverlap

public SemanticExtractor withAllowOverlap(boolean allowOverlap)

withAllowOverlap

public SemanticExtractor withAllowOverlap(java.lang.Boolean allowOverlap)

makeCopy

public SemanticExtractor makeCopy()

Creates and returns a deep copy of this SemanticExtractor.

Overrides:

makeCopy in class SemanticProcessor

readFrom

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

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

Overrides:

writeTo in class SemanticProcessor

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this SemanticExtractor.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this SemanticExtractor.

Overrides:

toString in class SemanticProcessor

check

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

Checks this SemanticExtractor.

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