com.exalead.indexing.analysis.v10

Class NamedEntitiesMatcher

java.lang.Object

com.exalead.indexing.analysis.v10.SemanticProcessor

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

The Named Entities Matcher detects named entities such as people, organizations, or places, in the textual content of the document.
It generates annotations like NE.person or NE.organization, using ontology-based matching and/or rule-based matching.

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

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
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	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://).
java.lang.String	getRules() Defines which entities will be extracted: The default value, ne triggers the extraction of people, organizations, locations and events. The value ne-all triggers the extraction of all types of entities.
boolean	isPartOfSpeechFiltering() It discards annotations for parts of text made of a name followed by a verb or an adverb with the first letter in uppercase. This filter is useful if your documents contain a lot of titles with several capitalized words (what is called 'Title Case').
boolean	isUseKnownWordsForDisambiguisation() Uses 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	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	setPartOfSpeechFiltering(boolean partOfSpeechFiltering) It discards annotations for parts of text made of a name followed by a verb or an adverb with the first letter in uppercase. This filter is useful if your documents contain a lot of titles with several capitalized words (what is called 'Title Case').
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://).
void	setRules(java.lang.String rules) Defines which entities will be extracted: The default value, ne triggers the extraction of people, organizations, locations and events. The value ne-all triggers the extraction of all types of entities.
void	setUseKnownWordsForDisambiguisation(boolean useKnownWordsForDisambiguisation) Uses 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	withDataModelClass(java.lang.String dataModelClass)
NamedEntitiesMatcher	withDataModelProperty(java.lang.String dataModelProperty)
NamedEntitiesMatcher	withDataModelState(java.lang.String dataModelState)
NamedEntitiesMatcher	withDisabled(boolean disabled)
NamedEntitiesMatcher	withDisabled(java.lang.Boolean disabled)
NamedEntitiesMatcher	withFromDataModel(SemanticProcessor fromDataModel)
NamedEntitiesMatcher	withLanguage(java.lang.String language)
NamedEntitiesMatcher	withName(java.lang.String name)
NamedEntitiesMatcher	withPartOfSpeechFiltering(boolean partOfSpeechFiltering)
NamedEntitiesMatcher	withPartOfSpeechFiltering(java.lang.Boolean partOfSpeechFiltering)
NamedEntitiesMatcher	withPrefix(java.lang.String prefix)
NamedEntitiesMatcher	withResourceDir(java.lang.String resourceDir)
NamedEntitiesMatcher	withRules(java.lang.String rules)
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.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

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

language

public java.lang.String language

partOfSpeechFiltering

public boolean partOfSpeechFiltering

DEFAULT_PART_OF_SPEECH_FILTERING

public static final boolean DEFAULT_PART_OF_SPEECH_FILTERING

See Also:

Constant Field Values

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

withFromDataModel

public NamedEntitiesMatcher withFromDataModel(SemanticProcessor fromDataModel)

withDataModelState

public NamedEntitiesMatcher withDataModelState(java.lang.String dataModelState)

Overrides:

withDataModelState in class SemanticProcessor

withDataModelClass

public NamedEntitiesMatcher withDataModelClass(java.lang.String dataModelClass)

Overrides:

withDataModelClass in class SemanticProcessor

withDataModelProperty

public NamedEntitiesMatcher withDataModelProperty(java.lang.String dataModelProperty)

Overrides:

withDataModelProperty in class SemanticProcessor

withDisabled

public NamedEntitiesMatcher withDisabled(boolean disabled)

Overrides:

withDisabled in class SemanticProcessor

withDisabled

public NamedEntitiesMatcher withDisabled(java.lang.Boolean disabled)

Overrides:

withDisabled 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 NamedEntitiesMatcher withResourceDir(java.lang.String resourceDir)

setRules

public void setRules(java.lang.String rules)

Defines which entities will be extracted:

• The default value, ne triggers the extraction of people, organizations, locations and events.
• The value ne-all triggers the extraction of all types of entities.

getRules

public java.lang.String getRules()

Defines which entities will be extracted:

• The default value, ne triggers the extraction of people, organizations, locations and events.
• The value ne-all triggers the extraction of all types of entities.

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)

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)

setPartOfSpeechFiltering

public void setPartOfSpeechFiltering(boolean partOfSpeechFiltering)

It discards annotations for parts of text made of a name followed by a verb or an adverb with the first letter in uppercase.
This filter is useful if your documents contain a lot of titles with several capitalized words (what is called 'Title Case').
It applies to NE.person, NE.place and NE.organization.

isPartOfSpeechFiltering

public boolean isPartOfSpeechFiltering()

It discards annotations for parts of text made of a name followed by a verb or an adverb with the first letter in uppercase.
This filter is useful if your documents contain a lot of titles with several capitalized words (what is called 'Title Case').
It applies to NE.person, NE.place and NE.organization.

withPartOfSpeechFiltering

public NamedEntitiesMatcher withPartOfSpeechFiltering(boolean partOfSpeechFiltering)

withPartOfSpeechFiltering

public NamedEntitiesMatcher withPartOfSpeechFiltering(java.lang.Boolean partOfSpeechFiltering)

setUseKnownWordsForDisambiguisation

public void setUseKnownWordsForDisambiguisation(boolean useKnownWordsForDisambiguisation)

Uses a resource of known words to disambiguate named entities candidates. It works only for English and French.

isUseKnownWordsForDisambiguisation

public boolean isUseKnownWordsForDisambiguisation()

Uses a resource of known words to disambiguate named entities candidates. It works only for English and French.

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