com.exalead.indexing.analysis.v10

Class Phonetizer

java.lang.Object

com.exalead.indexing.analysis.v10.SemanticProcessor

com.exalead.indexing.analysis.v10.Phonetizer

All Implemented Interfaces:

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

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

Creates a phonetic form for each word.
This processor is used:

• as a helper for other processors (like Ontology Matcher, or Semantic Extractor), which need to perform phonetic matches.
• to perform search-time phonetic analysis using the Phonetic expansion module (this creates the dictionary of phonetic forms that will be used by the expansion module at search-time).
• to greatly improve the quality of spell checking.

Annotations generated:

• "phonetic"

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	language
java.lang.String	resourceFile

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
Phonetizer()
Phonetizer(Phonetizer 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 Phonetizer.
static Phonetizer	fromString(java.lang.String s) String representation of this Phonetizer.
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	getResourceFile() URL for the resource (data://, file;// or resource://).
Phonetizer	makeCopy() Creates and returns a deep copy of this Phonetizer.
static Phonetizer	readFrom(java.io.InputStream is) Read this Phonetizer 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	setResourceFile(java.lang.String resourceFile) URL for the resource (data://, file;// or resource://).
java.lang.String	toString() String representation of this Phonetizer.
Phonetizer	withContexts(java.lang.String contexts)
Phonetizer	withDataModelClass(java.lang.String dataModelClass)
Phonetizer	withDataModelProperty(java.lang.String dataModelProperty)
Phonetizer	withDataModelState(java.lang.String dataModelState)
Phonetizer	withDisabled(boolean disabled)
Phonetizer	withDisabled(java.lang.Boolean disabled)
Phonetizer	withFromDataModel(SemanticProcessor fromDataModel)
Phonetizer	withLanguage(java.lang.String language)
Phonetizer	withName(java.lang.String name)
Phonetizer	withResourceFile(java.lang.String resourceFile)
void	writeTo(java.io.OutputStream os) Write this Phonetizer 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

resourceFile

public java.lang.String resourceFile

language

public java.lang.String language

Constructor Detail

Phonetizer

public Phonetizer()

Phonetizer

public Phonetizer(Phonetizer o)

Copy constructor

Method Detail

withName

public Phonetizer withName(java.lang.String name)

Overrides:

withName in class SemanticProcessor

withContexts

public Phonetizer withContexts(java.lang.String contexts)

Overrides:

withContexts in class SemanticProcessor

withFromDataModel

public Phonetizer withFromDataModel(SemanticProcessor fromDataModel)

withDataModelState

public Phonetizer withDataModelState(java.lang.String dataModelState)

Overrides:

withDataModelState in class SemanticProcessor

withDataModelClass

public Phonetizer withDataModelClass(java.lang.String dataModelClass)

Overrides:

withDataModelClass in class SemanticProcessor

withDataModelProperty

public Phonetizer withDataModelProperty(java.lang.String dataModelProperty)

Overrides:

withDataModelProperty in class SemanticProcessor

withDisabled

public Phonetizer withDisabled(boolean disabled)

Overrides:

withDisabled in class SemanticProcessor

withDisabled

public Phonetizer withDisabled(java.lang.Boolean disabled)

Overrides:

withDisabled in class SemanticProcessor

setResourceFile

public void setResourceFile(java.lang.String resourceFile)

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

getResourceFile

public java.lang.String getResourceFile()

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

withResourceFile

public Phonetizer withResourceFile(java.lang.String resourceFile)

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 Phonetizer withLanguage(java.lang.String language)

makeCopy

public Phonetizer makeCopy()

Creates and returns a deep copy of this Phonetizer.

Overrides:

makeCopy in class SemanticProcessor

readFrom

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

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

Overrides:

writeTo in class SemanticProcessor

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this Phonetizer.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this Phonetizer.

Overrides:

toString in class SemanticProcessor

check

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

Checks this Phonetizer.

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