com.exalead.mercury.mami.search.v20

Class PhoneticModule

java.lang.Object

com.exalead.mercury.mami.search.v20.QueryExpansionModule

com.exalead.mercury.mami.search.v20.PhoneticModule

All Implemented Interfaces:

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

public class PhoneticModule
extends QueryExpansionModule
implements com.exalead.util.Checkable, java.io.Serializable

Expands the query using a phonetic resource.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.exalead.mercury.mami.search.v20.QueryExpansionModule

QueryExpansionModule.Transformer<T>, QueryExpansionModule.Visitor

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	language
java.lang.String	resourceFile

Fields inherited from class com.exalead.mercury.mami.search.v20.QueryExpansionModule

name

Constructor Summary

Constructors

Constructor and Description
PhoneticModule()
PhoneticModule(PhoneticModule o) Copy constructor

Method Summary

Modifier and Type	Method and Description
<T> T	accept(QueryExpansionModule.Transformer<T> transformer, T[] t)
void	accept(QueryExpansionModule.Visitor visitor)
void	check(boolean deep, java.lang.String errorContext) Checks this PhoneticModule.
static PhoneticModule	fromString(java.lang.String s) String representation of this PhoneticModule.
java.lang.String	getLanguage() Optional language code.
java.lang.String	getResourceFile() Optional phonetic rules file.
PhoneticModule	makeCopy() Creates and returns a deep copy of this PhoneticModule.
static PhoneticModule	readFrom(java.io.InputStream is) Read this PhoneticModule from an XML fragment.
void	setLanguage(java.lang.String language) Optional language code.
void	setResourceFile(java.lang.String resourceFile) Optional phonetic rules file.
java.lang.String	toString() String representation of this PhoneticModule.
PhoneticModule	withLanguage(java.lang.String language)
PhoneticModule	withName(java.lang.String name)
PhoneticModule	withResourceFile(java.lang.String resourceFile)
void	writeTo(java.io.OutputStream os) Write this PhoneticModule as an XML fragment

Methods inherited from class com.exalead.mercury.mami.search.v20.QueryExpansionModule

getName, setName

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

language

public java.lang.String language

resourceFile

public java.lang.String resourceFile

Constructor Detail

PhoneticModule

public PhoneticModule()

PhoneticModule

public PhoneticModule(PhoneticModule o)

Copy constructor

Method Detail

withName

public PhoneticModule withName(java.lang.String name)

Overrides:

withName in class QueryExpansionModule

setLanguage

public void setLanguage(java.lang.String language)

Optional language code. If not specified, all are supported.

getLanguage

public java.lang.String getLanguage()

Optional language code. If not specified, all are supported.

withLanguage

public PhoneticModule withLanguage(java.lang.String language)

setResourceFile

public void setResourceFile(java.lang.String resourceFile)

Optional phonetic rules file. If not specified, the default rules file is used.

getResourceFile

public java.lang.String getResourceFile()

Optional phonetic rules file. If not specified, the default rules file is used.

withResourceFile

public PhoneticModule withResourceFile(java.lang.String resourceFile)

makeCopy

public PhoneticModule makeCopy()

Creates and returns a deep copy of this PhoneticModule.

Overrides:

makeCopy in class QueryExpansionModule

readFrom

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

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

Overrides:

writeTo in class QueryExpansionModule

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this PhoneticModule.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this PhoneticModule.

Overrides:

toString in class QueryExpansionModule

check

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

Checks this PhoneticModule.

Specified by:

check in interface com.exalead.util.Checkable

Overrides:

check in class QueryExpansionModule

Throws:

com.exalead.util.TypedException

accept

public void accept(QueryExpansionModule.Visitor visitor)
            throws com.exalead.util.TypedException

Specified by:

accept in class QueryExpansionModule

Throws:

com.exalead.util.TypedException

accept

public <T> T accept(QueryExpansionModule.Transformer<T> transformer,
                    T[] t)
             throws com.exalead.util.TypedException

Specified by:

accept in class QueryExpansionModule

Throws:

com.exalead.util.TypedException