com.exalead.linguistic.v10

Class NamedEntitiesMatcher

java.lang.Object

com.exalead.linguistic.v10.SemanticProcessor

com.exalead.linguistic.v10.NamedEntitiesMatcher

All Implemented Interfaces:

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

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

A NamedEntitesMatcher detects 'named entities' (People, Organizations, Places)
in the textual content of the DocumentChunks.

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
static boolean	DEFAULT_FILTER
static java.lang.String	DEFAULT_PREFIX
static java.lang.String	DEFAULT_RULES
static boolean	DEFAULT_USE_KNOWN_WORDS_FOR_DISAMBIGUISATION
java.lang.String	excludedLanguages
boolean	filter
java.lang.String	language
java.lang.String	prefix
java.lang.String	resourceDir
java.lang.String	rules
boolean	useKnownWordsForDisambiguisation

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

contexts, name, src

Constructor Summary

Constructors

Constructor and Description
NamedEntitiesMatcher()
NamedEntitiesMatcher(NamedEntitiesMatcher 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 NamedEntitiesMatcher.
static NamedEntitiesMatcher	fromString(java.lang.String s) String representation of this NamedEntitiesMatcher.
java.lang.String	getExcludedLanguages() Languages for which the processor is disabled.
java.lang.String	getLanguage() Languages for which the processor is activated; if no language is specified, the processor is activated for all languages.
java.lang.String	getPrefix() Prefix to add in front of each annotation generated by the Named Entity Matcher.
java.lang.String	getResourceDir() URL for the resource (data://, file;// or resource://) if null, use standard resource of product.
java.lang.String	getRules() Set of rules
boolean	isFilter() Filter out dubious named entities using part-of-speech.
boolean	isUseKnownWordsForDisambiguisation() Use a resource of known words to disambiguate named entities candidates.
NamedEntitiesMatcher	makeCopy() Creates and returns a deep copy of this NamedEntitiesMatcher.
static NamedEntitiesMatcher	readFrom(java.io.InputStream is) Read this NamedEntitiesMatcher from an XML fragment.
void	setExcludedLanguages(java.lang.String excludedLanguages) Languages for which the processor is disabled.
void	setFilter(boolean filter) Filter out dubious named entities using part-of-speech.
void	setLanguage(java.lang.String language) Languages for which the processor is activated; if no language is specified, the processor is activated for all languages.
void	setPrefix(java.lang.String prefix) Prefix to add in front of each annotation generated by the Named Entity Matcher.
void	setResourceDir(java.lang.String resourceDir) URL for the resource (data://, file;// or resource://) if null, use standard resource of product.
void	setRules(java.lang.String rules) Set of rules
void	setUseKnownWordsForDisambiguisation(boolean useKnownWordsForDisambiguisation) Use a resource of known words to disambiguate named entities candidates.
java.lang.String	toString() String representation of this NamedEntitiesMatcher.
NamedEntitiesMatcher	withContexts(java.lang.String contexts)
NamedEntitiesMatcher	withExcludedLanguages(java.lang.String excludedLanguages)
NamedEntitiesMatcher	withFilter(boolean filter)
NamedEntitiesMatcher	withFilter(java.lang.Boolean filter)
NamedEntitiesMatcher	withLanguage(java.lang.String language)
NamedEntitiesMatcher	withName(java.lang.String name)
NamedEntitiesMatcher	withPrefix(java.lang.String prefix)
NamedEntitiesMatcher	withResourceDir(java.lang.String resourceDir)
NamedEntitiesMatcher	withRules(java.lang.String rules)
NamedEntitiesMatcher	withSrc(java.lang.String src) Deprecated.
NamedEntitiesMatcher	withUseKnownWordsForDisambiguisation(boolean useKnownWordsForDisambiguisation)
NamedEntitiesMatcher	withUseKnownWordsForDisambiguisation(java.lang.Boolean useKnownWordsForDisambiguisation)
void	writeTo(java.io.OutputStream os) Write this NamedEntitiesMatcher 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

rules

public java.lang.String rules

DEFAULT_RULES

public static final java.lang.String DEFAULT_RULES

See Also:

Constant Field Values

prefix

public java.lang.String prefix

DEFAULT_PREFIX

public static final java.lang.String DEFAULT_PREFIX

See Also:

Constant Field Values

filter

public boolean filter

DEFAULT_FILTER

public static final boolean DEFAULT_FILTER

See Also:

Constant Field Values

language

public java.lang.String language

excludedLanguages

public java.lang.String excludedLanguages

useKnownWordsForDisambiguisation

public boolean useKnownWordsForDisambiguisation

DEFAULT_USE_KNOWN_WORDS_FOR_DISAMBIGUISATION

public static final boolean DEFAULT_USE_KNOWN_WORDS_FOR_DISAMBIGUISATION

See Also:

Constant Field Values

Constructor Detail

NamedEntitiesMatcher

public NamedEntitiesMatcher()

NamedEntitiesMatcher

public NamedEntitiesMatcher(NamedEntitiesMatcher o)

Copy constructor

Method Detail

withName

public NamedEntitiesMatcher withName(java.lang.String name)

Overrides:

withName in class SemanticProcessor

withContexts

public NamedEntitiesMatcher withContexts(java.lang.String contexts)

Overrides:

withContexts in class SemanticProcessor

withSrc

@Deprecated
public NamedEntitiesMatcher 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://)
if null, use standard resource of product.

getResourceDir

public java.lang.String getResourceDir()

URL for the resource (data://, file;// or resource://)
if null, use standard resource of product.

withResourceDir

public NamedEntitiesMatcher withResourceDir(java.lang.String resourceDir)

setRules

public void setRules(java.lang.String rules)

Set of rules

getRules

public java.lang.String getRules()

Set of rules

withRules

public NamedEntitiesMatcher withRules(java.lang.String rules)

setPrefix

public void setPrefix(java.lang.String prefix)

Prefix to add in front of each annotation generated by the Named Entity Matcher.

getPrefix

public java.lang.String getPrefix()

Prefix to add in front of each annotation generated by the Named Entity Matcher.

withPrefix

public NamedEntitiesMatcher withPrefix(java.lang.String prefix)

setFilter

public void setFilter(boolean filter)

Filter out dubious named entities using part-of-speech.

isFilter

public boolean isFilter()

Filter out dubious named entities using part-of-speech.

withFilter

public NamedEntitiesMatcher withFilter(boolean filter)

withFilter

public NamedEntitiesMatcher withFilter(java.lang.Boolean filter)

setLanguage

public void setLanguage(java.lang.String language)

Languages for which the processor is activated;
if no language is specified, the processor is activated for all languages.

getLanguage

public java.lang.String getLanguage()

Languages for which the processor is activated;
if no language is specified, the processor is activated for all languages.

withLanguage

public NamedEntitiesMatcher withLanguage(java.lang.String language)

setExcludedLanguages

public void setExcludedLanguages(java.lang.String excludedLanguages)

Languages for which the processor is disabled.

getExcludedLanguages

public java.lang.String getExcludedLanguages()

Languages for which the processor is disabled.

withExcludedLanguages

public NamedEntitiesMatcher withExcludedLanguages(java.lang.String excludedLanguages)

setUseKnownWordsForDisambiguisation

public void setUseKnownWordsForDisambiguisation(boolean useKnownWordsForDisambiguisation)

Use a resource of known words to disambiguate named entities candidates.

isUseKnownWordsForDisambiguisation

public boolean isUseKnownWordsForDisambiguisation()

Use a resource of known words to disambiguate named entities candidates.

withUseKnownWordsForDisambiguisation

public NamedEntitiesMatcher withUseKnownWordsForDisambiguisation(boolean useKnownWordsForDisambiguisation)

withUseKnownWordsForDisambiguisation

public NamedEntitiesMatcher withUseKnownWordsForDisambiguisation(java.lang.Boolean useKnownWordsForDisambiguisation)

makeCopy

public NamedEntitiesMatcher makeCopy()

Creates and returns a deep copy of this NamedEntitiesMatcher.

Overrides:

makeCopy in class SemanticProcessor

readFrom

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

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

Overrides:

writeTo in class SemanticProcessor

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this NamedEntitiesMatcher.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this NamedEntitiesMatcher.

Overrides:

toString in class SemanticProcessor

check

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

Checks this NamedEntitiesMatcher.

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