com.exalead.linguistic.v10

Class JapaneseWordFinder

java.lang.Object

com.exalead.linguistic.v10.TokenizerPlugin

com.exalead.linguistic.v10.JapaneseWordFinder

All Implemented Interfaces:

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

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

Performs words detection for Japanese.
Use with a Standard tokenizer.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
boolean	addCharset
boolean	addNGrams
boolean	addPartOfSpeech
boolean	addRomaji
boolean	addTransliterations
static boolean	DEFAULT_ADD_CHARSET
static boolean	DEFAULT_ADD_N_GRAMS
static boolean	DEFAULT_ADD_PART_OF_SPEECH
static boolean	DEFAULT_ADD_ROMAJI
static boolean	DEFAULT_ADD_TRANSLITERATIONS
static int	DEFAULT_MAX_N_GRAM_LENGTH
static int	DEFAULT_MIN_N_GRAM_LENGTH
static boolean	DEFAULT_PROCESS_ROMAJI
int	maxNGramLength
int	minNGramLength
boolean	processRomaji
java.lang.String	resourceDir

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	check(boolean deep, java.lang.String errorContext) Checks this JapaneseWordFinder.
static JapaneseWordFinder	fromString(java.lang.String s) String representation of this JapaneseWordFinder.
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	isAddCharset() Annotates with charset
boolean	isAddNGrams() Annotates with NGrams
boolean	isAddPartOfSpeech() Annotates with part of speech.
boolean	isAddRomaji() Annotates each token with its romaji transliteration, when applicable.
boolean	isAddTransliterations() Annotates with transliterations (kanji, katakana, hiragana, romaji).
boolean	isProcessRomaji() Processes romaji tokens
JapaneseWordFinder	makeCopy() Creates and returns a deep copy of this JapaneseWordFinder.
static JapaneseWordFinder	readFrom(java.io.InputStream is) Read this JapaneseWordFinder from an XML fragment.
void	setAddCharset(boolean addCharset) Annotates with charset
void	setAddNGrams(boolean addNGrams) Annotates with NGrams
void	setAddPartOfSpeech(boolean addPartOfSpeech) Annotates with part of speech.
void	setAddRomaji(boolean addRomaji) Annotates each token with its romaji transliteration, when applicable.
void	setAddTransliterations(boolean addTransliterations) Annotates with transliterations (kanji, katakana, hiragana, romaji).
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	setProcessRomaji(boolean processRomaji) Processes romaji tokens
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 JapaneseWordFinder.
JapaneseWordFinder	withAddCharset(boolean addCharset)
JapaneseWordFinder	withAddCharset(java.lang.Boolean addCharset)
JapaneseWordFinder	withAddNGrams(boolean addNGrams)
JapaneseWordFinder	withAddNGrams(java.lang.Boolean addNGrams)
JapaneseWordFinder	withAddPartOfSpeech(boolean addPartOfSpeech)
JapaneseWordFinder	withAddPartOfSpeech(java.lang.Boolean addPartOfSpeech)
JapaneseWordFinder	withAddRomaji(boolean addRomaji)
JapaneseWordFinder	withAddRomaji(java.lang.Boolean addRomaji)
JapaneseWordFinder	withAddTransliterations(boolean addTransliterations)
JapaneseWordFinder	withAddTransliterations(java.lang.Boolean addTransliterations)
JapaneseWordFinder	withMaxNGramLength(int maxNGramLength)
JapaneseWordFinder	withMaxNGramLength(java.lang.Integer maxNGramLength)
JapaneseWordFinder	withMinNGramLength(int minNGramLength)
JapaneseWordFinder	withMinNGramLength(java.lang.Integer minNGramLength)
JapaneseWordFinder	withProcessRomaji(boolean processRomaji)
JapaneseWordFinder	withProcessRomaji(java.lang.Boolean processRomaji)
JapaneseWordFinder	withResourceDir(java.lang.String resourceDir)
void	writeTo(java.io.OutputStream os) Write this JapaneseWordFinder 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

processRomaji

public boolean processRomaji

DEFAULT_PROCESS_ROMAJI

public static final boolean DEFAULT_PROCESS_ROMAJI

See Also:

Constant Field Values

addRomaji

public boolean addRomaji

DEFAULT_ADD_ROMAJI

public static final boolean DEFAULT_ADD_ROMAJI

See Also:

Constant Field Values

addCharset

public boolean addCharset

DEFAULT_ADD_CHARSET

public static final boolean DEFAULT_ADD_CHARSET

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

addTransliterations

public boolean addTransliterations

DEFAULT_ADD_TRANSLITERATIONS

public static final boolean DEFAULT_ADD_TRANSLITERATIONS

See Also:

Constant Field Values

addPartOfSpeech

public boolean addPartOfSpeech

DEFAULT_ADD_PART_OF_SPEECH

public static final boolean DEFAULT_ADD_PART_OF_SPEECH

See Also:

Constant Field Values

Constructor Detail

JapaneseWordFinder

public JapaneseWordFinder()

JapaneseWordFinder

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

setProcessRomaji

public void setProcessRomaji(boolean processRomaji)

Processes romaji tokens

isProcessRomaji

public boolean isProcessRomaji()

Processes romaji tokens

withProcessRomaji

public JapaneseWordFinder withProcessRomaji(boolean processRomaji)

withProcessRomaji

public JapaneseWordFinder withProcessRomaji(java.lang.Boolean processRomaji)

setAddRomaji

public void setAddRomaji(boolean addRomaji)

Annotates each token with its romaji transliteration, when applicable.

isAddRomaji

public boolean isAddRomaji()

Annotates each token with its romaji transliteration, when applicable.

withAddRomaji

public JapaneseWordFinder withAddRomaji(boolean addRomaji)

withAddRomaji

public JapaneseWordFinder withAddRomaji(java.lang.Boolean addRomaji)

setAddCharset

public void setAddCharset(boolean addCharset)

Annotates with charset

isAddCharset

public boolean isAddCharset()

Annotates with charset

withAddCharset

public JapaneseWordFinder withAddCharset(boolean addCharset)

withAddCharset

public JapaneseWordFinder withAddCharset(java.lang.Boolean addCharset)

setAddNGrams

public void setAddNGrams(boolean addNGrams)

Annotates with NGrams

isAddNGrams

public boolean isAddNGrams()

Annotates with NGrams

withAddNGrams

public JapaneseWordFinder withAddNGrams(boolean addNGrams)

withAddNGrams

public JapaneseWordFinder 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 JapaneseWordFinder withMinNGramLength(int minNGramLength)

withMinNGramLength

public JapaneseWordFinder 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 JapaneseWordFinder withMaxNGramLength(int maxNGramLength)

withMaxNGramLength

public JapaneseWordFinder withMaxNGramLength(java.lang.Integer maxNGramLength)

setAddTransliterations

public void setAddTransliterations(boolean addTransliterations)

Annotates with transliterations (kanji, katakana, hiragana, romaji).

isAddTransliterations

public boolean isAddTransliterations()

Annotates with transliterations (kanji, katakana, hiragana, romaji).

withAddTransliterations

public JapaneseWordFinder withAddTransliterations(boolean addTransliterations)

withAddTransliterations

public JapaneseWordFinder withAddTransliterations(java.lang.Boolean addTransliterations)

setAddPartOfSpeech

public void setAddPartOfSpeech(boolean addPartOfSpeech)

Annotates with part of speech.

isAddPartOfSpeech

public boolean isAddPartOfSpeech()

Annotates with part of speech.

withAddPartOfSpeech

public JapaneseWordFinder withAddPartOfSpeech(boolean addPartOfSpeech)

withAddPartOfSpeech

public JapaneseWordFinder withAddPartOfSpeech(java.lang.Boolean addPartOfSpeech)

makeCopy

public JapaneseWordFinder makeCopy()

Creates and returns a deep copy of this JapaneseWordFinder.

Overrides:

makeCopy in class TokenizerPlugin

readFrom

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

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

Overrides:

writeTo in class TokenizerPlugin

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this JapaneseWordFinder.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this JapaneseWordFinder.

Overrides:

toString in class TokenizerPlugin

check

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

Checks this JapaneseWordFinder.

Specified by:

check in interface com.exalead.util.Checkable

Overrides:

check in class TokenizerPlugin

Throws:

com.exalead.util.TypedException