com.exalead.indexing.analysis.v10

Class SemanticExtractor

java.lang.Object

com.exalead.indexing.analysis.v10.SemanticProcessor

com.exalead.indexing.analysis.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

The resource describes the features to extract, with their term, type and range for numerical values according to a set of rules. Annotations generated:

• Depending on the resource (See SemanticExtractorConfig)

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	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_MATCH_ALL_RULES
static boolean	DEFAULT_OVERLAPPING_MATCHES
java.lang.String	language
boolean	matchAllRules
boolean	overlappingMatches
java.lang.String	prefix
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
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() Used in the context of query rewriting by the Semantic Query Analyzer.
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 of the compiled semantic extractor file.
boolean	isBreakOnLine() If true, there will be maximum one match per line, and no match for inter-line.
boolean	isBreakOnParagraph() If true, there will be maximum one match per paragraph, and no match for inter-paragraph.
boolean	isBreakOnSentence() If true, there will be maximum one match per sentence, and no match for inter-sentence. This option will add the SentenceFinder automatically.
boolean	isMatchAllRules() If true, it returns the full list of matched rules. If false, it returns only the first matched rule.
boolean	isOverlappingMatches() If true, reports all matches even if their locations overlap. Only makes sense when matchAllRules is true.
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	setAnnotateUnusedTokensWith(java.lang.String annotateUnusedTokensWith) Used in the context of query rewriting by the Semantic Query Analyzer.
void	setBreakOnLine(boolean breakOnLine) If true, there will be maximum one match per line, and no match for inter-line.
void	setBreakOnParagraph(boolean breakOnParagraph) If true, there will be maximum one match per paragraph, and no match for inter-paragraph.
void	setBreakOnSentence(boolean breakOnSentence) If true, there will be maximum one match per sentence, and no match for inter-sentence. This option will add the 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) If true, it returns the full list of matched rules. If false, it returns only the first matched rule.
void	setOverlappingMatches(boolean overlappingMatches) If true, reports all matches even if their locations overlap. Only makes sense when matchAllRules is true.
void	setPrefix(java.lang.String prefix) Output annotations prefix
void	setResourceDir(java.lang.String resourceDir) URL of the compiled semantic extractor file.
java.lang.String	toString() String representation of this SemanticExtractor.
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	withDataModelClass(java.lang.String dataModelClass)
SemanticExtractor	withDataModelProperty(java.lang.String dataModelProperty)
SemanticExtractor	withDataModelState(java.lang.String dataModelState)
SemanticExtractor	withDisabled(boolean disabled)
SemanticExtractor	withDisabled(java.lang.Boolean disabled)
SemanticExtractor	withFromDataModel(SemanticProcessor fromDataModel)
SemanticExtractor	withLanguage(java.lang.String language)
SemanticExtractor	withMatchAllRules(boolean matchAllRules)
SemanticExtractor	withMatchAllRules(java.lang.Boolean matchAllRules)
SemanticExtractor	withName(java.lang.String name)
SemanticExtractor	withOverlappingMatches(boolean overlappingMatches)
SemanticExtractor	withOverlappingMatches(java.lang.Boolean overlappingMatches)
SemanticExtractor	withPrefix(java.lang.String prefix)
SemanticExtractor	withResourceDir(java.lang.String resourceDir)
void	writeTo(java.io.OutputStream os) Write this SemanticExtractor 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

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

language

public java.lang.String language

annotateUnusedTokensWith

public java.lang.String annotateUnusedTokensWith

overlappingMatches

public boolean overlappingMatches

DEFAULT_OVERLAPPING_MATCHES

public static final boolean DEFAULT_OVERLAPPING_MATCHES

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

withFromDataModel

public SemanticExtractor withFromDataModel(SemanticProcessor fromDataModel)

withDataModelState

public SemanticExtractor withDataModelState(java.lang.String dataModelState)

Overrides:

withDataModelState in class SemanticProcessor

withDataModelClass

public SemanticExtractor withDataModelClass(java.lang.String dataModelClass)

Overrides:

withDataModelClass in class SemanticProcessor

withDataModelProperty

public SemanticExtractor withDataModelProperty(java.lang.String dataModelProperty)

Overrides:

withDataModelProperty in class SemanticProcessor

withDisabled

public SemanticExtractor withDisabled(boolean disabled)

Overrides:

withDisabled in class SemanticProcessor

withDisabled

public SemanticExtractor withDisabled(java.lang.Boolean disabled)

Overrides:

withDisabled in class SemanticProcessor

setResourceDir

public void setResourceDir(java.lang.String resourceDir)

URL of the compiled semantic extractor file. Use the format data://, file:// or resource://.

getResourceDir

public java.lang.String getResourceDir()

URL of the compiled semantic extractor file. Use the format data://, file:// or resource://.

withResourceDir

public SemanticExtractor withResourceDir(java.lang.String resourceDir)

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, there will be maximum one match per sentence, and no match for inter-sentence.
This option will add the SentenceFinder automatically.

isBreakOnSentence

public boolean isBreakOnSentence()

If true, there will be maximum one match per sentence, and no match for inter-sentence.
This option will add the SentenceFinder automatically.

withBreakOnSentence

public SemanticExtractor withBreakOnSentence(boolean breakOnSentence)

withBreakOnSentence

public SemanticExtractor withBreakOnSentence(java.lang.Boolean breakOnSentence)

setBreakOnParagraph

public void setBreakOnParagraph(boolean breakOnParagraph)

If true, there will be maximum one match per paragraph, and no match for inter-paragraph.

isBreakOnParagraph

public boolean isBreakOnParagraph()

If true, there will be maximum one match per paragraph, and no match for inter-paragraph.

withBreakOnParagraph

public SemanticExtractor withBreakOnParagraph(boolean breakOnParagraph)

withBreakOnParagraph

public SemanticExtractor withBreakOnParagraph(java.lang.Boolean breakOnParagraph)

setBreakOnLine

public void setBreakOnLine(boolean breakOnLine)

If true, there will be maximum one match per line, and no match for inter-line.

isBreakOnLine

public boolean isBreakOnLine()

If true, there will be maximum one match per line, and no match for inter-line.

withBreakOnLine

public SemanticExtractor withBreakOnLine(boolean breakOnLine)

withBreakOnLine

public SemanticExtractor withBreakOnLine(java.lang.Boolean breakOnLine)

setMatchAllRules

public void setMatchAllRules(boolean matchAllRules)

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

isMatchAllRules

public boolean isMatchAllRules()

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

withMatchAllRules

public SemanticExtractor withMatchAllRules(boolean matchAllRules)

withMatchAllRules

public SemanticExtractor withMatchAllRules(java.lang.Boolean matchAllRules)

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)

setAnnotateUnusedTokensWith

public void setAnnotateUnusedTokensWith(java.lang.String annotateUnusedTokensWith)

Used in the context of query rewriting by the Semantic Query Analyzer.

getAnnotateUnusedTokensWith

public java.lang.String getAnnotateUnusedTokensWith()

Used in the context of query rewriting by the Semantic Query Analyzer.

withAnnotateUnusedTokensWith

public SemanticExtractor withAnnotateUnusedTokensWith(java.lang.String annotateUnusedTokensWith)

setOverlappingMatches

public void setOverlappingMatches(boolean overlappingMatches)

If true, reports all matches even if their locations overlap.
Only makes sense when matchAllRules is true.

isOverlappingMatches

public boolean isOverlappingMatches()

If true, reports all matches even if their locations overlap.
Only makes sense when matchAllRules is true.

withOverlappingMatches

public SemanticExtractor withOverlappingMatches(boolean overlappingMatches)

withOverlappingMatches

public SemanticExtractor withOverlappingMatches(java.lang.Boolean overlappingMatches)

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