com.exalead.linguistic.v10

Class ChineseWordFinder

java.lang.Object

com.exalead.linguistic.v10.TokenizerPlugin

com.exalead.linguistic.v10.ChineseWordFinder

All Implemented Interfaces:

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

public class ChineseWordFinder
extends TokenizerPlugin
implements com.exalead.util.Checkable, java.io.Serializable

This class performs words detection for Chinese.
Use with a Standard tokenizer.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
boolean	addNGrams
boolean	addSimplified
static boolean	DEFAULT_ADD_N_GRAMS
static boolean	DEFAULT_ADD_SIMPLIFIED
static int	DEFAULT_MAX_N_GRAM_LENGTH
static int	DEFAULT_MIN_N_GRAM_LENGTH
int	maxNGramLength
int	minNGramLength
java.lang.String	resourceDir

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	check(boolean deep, java.lang.String errorContext) Checks this ChineseWordFinder.
static ChineseWordFinder	fromString(java.lang.String s) String representation of this ChineseWordFinder.
int	getMaxNGramLength() Maximum length of NGrams (1: monograms, 2: bigrams...)
int	getMinNGramLength() Minimum length of NGrams (1: monograms, 2: bigrams...)
java.lang.String	getResourceDir() URL for the resource (data://, file;// or resource://) if null, use standard resource of product.
boolean	isAddNGrams() Annotates with NGrams
boolean	isAddSimplified() Annotates each token with its simplified Chinese transliteration, when applicable.
ChineseWordFinder	makeCopy() Creates and returns a deep copy of this ChineseWordFinder.
static ChineseWordFinder	readFrom(java.io.InputStream is) Read this ChineseWordFinder from an XML fragment.
void	setAddNGrams(boolean addNGrams) Annotates with NGrams
void	setAddSimplified(boolean addSimplified) Annotates each token with its simplified Chinese transliteration, when applicable.
void	setMaxNGramLength(int maxNGramLength) Maximum length of NGrams (1: monograms, 2: bigrams...)
void	setMinNGramLength(int minNGramLength) Minimum length of NGrams (1: monograms, 2: bigrams...)
void	setResourceDir(java.lang.String resourceDir) URL for the resource (data://, file;// or resource://) if null, use standard resource of product.
java.lang.String	toString() String representation of this ChineseWordFinder.
ChineseWordFinder	withAddNGrams(boolean addNGrams)
ChineseWordFinder	withAddNGrams(java.lang.Boolean addNGrams)
ChineseWordFinder	withAddSimplified(boolean addSimplified)
ChineseWordFinder	withAddSimplified(java.lang.Boolean addSimplified)
ChineseWordFinder	withMaxNGramLength(int maxNGramLength)
ChineseWordFinder	withMaxNGramLength(java.lang.Integer maxNGramLength)
ChineseWordFinder	withMinNGramLength(int minNGramLength)
ChineseWordFinder	withMinNGramLength(java.lang.Integer minNGramLength)
ChineseWordFinder	withResourceDir(java.lang.String resourceDir)
void	writeTo(java.io.OutputStream os) Write this ChineseWordFinder as an XML fragment

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

addSimplified

public boolean addSimplified

DEFAULT_ADD_SIMPLIFIED

public static final boolean DEFAULT_ADD_SIMPLIFIED

See Also:

Constant Field Values

addNGrams

public boolean addNGrams

DEFAULT_ADD_N_GRAMS

public static final boolean DEFAULT_ADD_N_GRAMS

See Also:

Constant Field Values

minNGramLength

public int minNGramLength

DEFAULT_MIN_N_GRAM_LENGTH

public static final int DEFAULT_MIN_N_GRAM_LENGTH

See Also:

Constant Field Values

maxNGramLength

public int maxNGramLength

DEFAULT_MAX_N_GRAM_LENGTH

public static final int DEFAULT_MAX_N_GRAM_LENGTH

See Also:

Constant Field Values

Constructor Detail

ChineseWordFinder

public ChineseWordFinder()

ChineseWordFinder

public ChineseWordFinder(ChineseWordFinder o)

Copy constructor

Method Detail

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

setAddSimplified

public void setAddSimplified(boolean addSimplified)

Annotates each token with its simplified Chinese transliteration, when applicable.

isAddSimplified

public boolean isAddSimplified()

Annotates each token with its simplified Chinese transliteration, when applicable.

withAddSimplified

public ChineseWordFinder withAddSimplified(boolean addSimplified)

withAddSimplified

public ChineseWordFinder withAddSimplified(java.lang.Boolean addSimplified)

setAddNGrams

public void setAddNGrams(boolean addNGrams)

Annotates with NGrams

isAddNGrams

public boolean isAddNGrams()

Annotates with NGrams

withAddNGrams

public ChineseWordFinder withAddNGrams(boolean addNGrams)

withAddNGrams

public ChineseWordFinder withAddNGrams(java.lang.Boolean addNGrams)

setMinNGramLength

public void setMinNGramLength(int minNGramLength)

Minimum length of NGrams (1: monograms, 2: bigrams...)

getMinNGramLength

public int getMinNGramLength()

Minimum length of NGrams (1: monograms, 2: bigrams...)

withMinNGramLength

public ChineseWordFinder withMinNGramLength(int minNGramLength)

withMinNGramLength

public ChineseWordFinder withMinNGramLength(java.lang.Integer minNGramLength)

setMaxNGramLength

public void setMaxNGramLength(int maxNGramLength)

Maximum length of NGrams (1: monograms, 2: bigrams...)

getMaxNGramLength

public int getMaxNGramLength()

Maximum length of NGrams (1: monograms, 2: bigrams...)

withMaxNGramLength

public ChineseWordFinder withMaxNGramLength(int maxNGramLength)

withMaxNGramLength

public ChineseWordFinder withMaxNGramLength(java.lang.Integer maxNGramLength)

makeCopy

public ChineseWordFinder makeCopy()

Creates and returns a deep copy of this ChineseWordFinder.

Overrides:

makeCopy in class TokenizerPlugin

readFrom

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

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

Overrides:

writeTo in class TokenizerPlugin

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this ChineseWordFinder.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this ChineseWordFinder.

Overrides:

toString in class TokenizerPlugin

check

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

Checks this ChineseWordFinder.

Specified by:

check in interface com.exalead.util.Checkable

Overrides:

check in class TokenizerPlugin

Throws:

com.exalead.util.TypedException