java.lang.Object
- org.lionsoul.jcseg.segmenter.Word

All Implemented Interfaces:

Serializable, Cloneable, IWord
```
public class Word
extends Object
implements IWord, Cloneable, Serializable
```
word class for Jcseg with the IWord interface implemented at 2017/03/29: make the synonym series method getSyn() setSyn(SynonymsEntry) and the part of speech series method getPartSpeech() setPartSpeech(String[]) addPartSpeech(String) and the clone() method synchronized for might happen concurrent access.

Author:

chenxin

See Also:

Serialized Form

Field Summary
- Fields inherited from interface org.lionsoul.jcseg.IWord
  EN_POSPEECH, MIX_POSPEECH, NAME_POSPEECH, NUMERIC_POSPEECH, PPT_POSPEECH, PUNCTUATION, QUANTIFIER, T_BASIC_LATIN, T_CJK_PINYIN, T_CJK_WORD, T_CN_NAME, T_CN_NICKNAME, T_CN_NUMERIC, T_LETTER_NUMBER, T_MIXED_WORD, T_OTHER_NUMBER, T_PUNCTUATION, T_UNRECOGNIZE_WORD, TIME_POSPEECH, UNRECOGNIZE

Constructor Summary

Constructors
Constructor	Description
`Word(String value, int type)`
`Word(String value, int fre, int type)`
`Word(String value, int fre, int type, String[] entity)`	construct method to initialize the newly created Word instance
`Word(String value, int type, String[] entity)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`__toString()`	for debug only
`void`	`addEntity(String e)`	append a new entity
`void`	`addPartSpeech(String ps)`	add a new part to speech to the word.
`IWord`	`clone()`	Interface to clone the current object
`boolean`	`equals(Object o)`	you have to rewrite the #equals method cause the Jcseg require it
`String[]`	`getEntity()`	get the entity name array of the word
`String`	`getEntity(int idx)`	get the specified entity by index
`int`	`getFrequency()`	return the frequency of the word, use only when the word's length is one.
`int`	`getLength()`	return the length of the word
`String`	`getParameter()`	return the additional parameters
`String[]`	`getPartSpeech()`	return the part of speech of the word.
`String`	`getPinyin()`	return the pinyin of the word
`int`	`getPosition()`	return the start position of the word.
`SynonymsEntry`	`getSyn()`	return the Synonyms' entry of the word.
`int`	`getType()`	return the type of the word
`String`	`getValue()`	return the value of the word
`int`	`hashCode()`	rewrite the hash code generate algorithm take the value as the main factor
`void`	`setEntity(String[] entity)`	set the entity name array of the word
`void`	`setEntityForNull(String[] entity)`
`void`	`setFrequency(int freq)`	set the frequency of the word
`void`	`setLength(int length)`	self define the length
`void`	`setParameter(String param)`	set the string parameters
`void`	`setPartSpeech(String[] partSpeech)`
`void`	`setPartSpeechForNull(String[] partSpeech)`
`void`	`setPinyin(String py)`	set the pinyin of the word
`void`	`setPosition(int pos)`	set the position of the word
`void`	`setSyn(SynonymsEntry syn)`
`void`	`setType(int type)`	set the type of the word
`String`	`toString()`

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Word
```
public Word(String value,
            int fre,
            int type,
            String[] entity)
```
    construct method to initialize the newly created Word instance
    
    Parameters:
    
    value -
    
    fre -
    
    type -
    
    entity -
  - Word
```
public Word(String value,
            int fre,
            int type)
```
  - Word
```
public Word(String value,
            int type)
```
  - Word
```
public Word(String value,
            int type,
            String[] entity)
```
- Method Detail
  - getValue
```
public String getValue()
```
    Description copied from interface: IWord
    
    return the value of the word
    
    Specified by:
    
    getValue in interface IWord
    
    See Also:
    
    IWord.getValue()
  - getLength
```
public int getLength()
```
    Description copied from interface: IWord
    
    return the length of the word
    
    Specified by:
    
    getLength in interface IWord
    
    See Also:
    
    IWord.getLength()
  - setLength
```
public void setLength(int length)
```
    Description copied from interface: IWord
    
    self define the length
    
    Specified by:
    
    setLength in interface IWord
    
    See Also:
    
    IWord.setLength(int)
  - getFrequency
```
public int getFrequency()
```
    Description copied from interface: IWord
    
    return the frequency of the word, use only when the word's length is one.
    
    Specified by:
    
    getFrequency in interface IWord
    
    See Also:
    
    IWord.getFrequency()
  - setFrequency
```
public void setFrequency(int freq)
```
    Description copied from interface: IWord
    
    set the frequency of the word
    
    Specified by:
    
    setFrequency in interface IWord
  - getType
```
public int getType()
```
    Description copied from interface: IWord
    
    return the type of the word
    
    Specified by:
    
    getType in interface IWord
    
    See Also:
    
    IWord.getType()
  - setType
```
public void setType(int type)
```
    Description copied from interface: IWord
    
    set the type of the word
    
    Specified by:
    
    setType in interface IWord
    
    See Also:
    
    IWord.setType(int)
  - setPosition
```
public void setPosition(int pos)
```
    Description copied from interface: IWord
    
    set the position of the word
    
    Specified by:
    
    setPosition in interface IWord
    
    See Also:
    
    IWord.setPosition(int)
  - getPosition
```
public int getPosition()
```
    Description copied from interface: IWord
    
    return the start position of the word.
    
    Specified by:
    
    getPosition in interface IWord
    
    See Also:
    
    IWord.getPosition()
  - getEntity
```
public String[] getEntity()
```
    Description copied from interface: IWord
    
    get the entity name array of the word
    
    Specified by:
    
    getEntity in interface IWord
    
    See Also:
    
    IWord.getEntity()
  - getEntity
```
public String getEntity(int idx)
```
    Description copied from interface: IWord
    
    get the specified entity by index
    
    Specified by:
    
    getEntity in interface IWord
    
    See Also:
    
    IWord.getEntity(int)
  - setEntity
```
public void setEntity(String[] entity)
```
    Description copied from interface: IWord
    
    set the entity name array of the word
    
    Specified by:
    
    setEntity in interface IWord
    
    See Also:
    
    IWord.setEntity(String[])
  - setEntityForNull
```
public void setEntityForNull(String[] entity)
```
    Specified by:
    
    setEntityForNull in interface IWord
  - addEntity
```
public void addEntity(String e)
```
    Description copied from interface: IWord
    
    append a new entity
    
    Specified by:
    
    addEntity in interface IWord
    
    See Also:
    
    IWord.addEntity(String)
  - getPinyin
```
public String getPinyin()
```
    Description copied from interface: IWord
    
    return the pinyin of the word
    
    Specified by:
    
    getPinyin in interface IWord
    
    See Also:
    
    IWord.getPinyin()
  - setPinyin
```
public void setPinyin(String py)
```
    Description copied from interface: IWord
    
    set the pinyin of the word
    
    Specified by:
    
    setPinyin in interface IWord
    
    See Also:
    
    IWord.setPinyin(String)
  - getSyn
```
public SynonymsEntry getSyn()
```
    Description copied from interface: IWord
    
    return the Synonyms' entry of the word.
    
    Specified by:
    
    getSyn in interface IWord
    
    See Also:
    
    IWord.getSyn()
  - setSyn
```
public void setSyn(SynonymsEntry syn)
```
    Specified by:
    
    setSyn in interface IWord
  - getPartSpeech
```
public String[] getPartSpeech()
```
    Description copied from interface: IWord
    
    return the part of speech of the word.
    
    Specified by:
    
    getPartSpeech in interface IWord
    
    See Also:
    
    IWord.getPartSpeech()
  - setPartSpeech
```
public void setPartSpeech(String[] partSpeech)
```
    Specified by:
    
    setPartSpeech in interface IWord
  - setPartSpeechForNull
```
public void setPartSpeechForNull(String[] partSpeech)
```
    Specified by:
    
    setPartSpeechForNull in interface IWord
  - addPartSpeech
```
public void addPartSpeech(String ps)
```
    Description copied from interface: IWord
    
    add a new part to speech to the word.
    
    Specified by:
    
    addPartSpeech in interface IWord
    
    See Also:
    
    IWord.addPartSpeech(String)
  - getParameter
```
public String getParameter()
```
    Description copied from interface: IWord
    
    return the additional parameters
    
    Specified by:
    
    getParameter in interface IWord
  - setParameter
```
public void setParameter(String param)
```
    Description copied from interface: IWord
    
    set the string parameters
    
    Specified by:
    
    setParameter in interface IWord
  - clone
```
public IWord clone()
```
    Interface to clone the current object
    
    Specified by:
    
    clone in interface IWord
    
    Overrides:
    
    clone in class Object
    
    Returns:
    
    IWord
  - equals
```
public boolean equals(Object o)
```
    Description copied from interface: IWord
    
    you have to rewrite the #equals method cause the Jcseg require it
    
    Specified by:
    
    equals in interface IWord
    
    Overrides:
    
    equals in class Object
    
    See Also:
    
    Object.equals(Object), IWord.equals(Object)
  - __toString
```
public String __toString()
```
    for debug only
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
    
    See Also:
    
    Object.toString()
  - hashCode
```
public int hashCode()
```
    rewrite the hash code generate algorithm take the value as the main factor
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    int

Class Word

Field Summary

Fields inherited from interface org.lionsoul.jcseg.IWord

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Word

Word

Word

Word

Method Detail

getValue

getLength

setLength

getFrequency

setFrequency

getType

setType

setPosition

getPosition

getEntity

getEntity

setEntity

setEntityForNull

addEntity

getPinyin

setPinyin

getSyn

setSyn

getPartSpeech

setPartSpeech

setPartSpeechForNull

addPartSpeech

getParameter

setParameter

clone

equals

__toString

toString

hashCode