net.ajaest.jdk.data.kanji
Class RadicalVariantTag

java.lang.Object
  extended by net.ajaest.jdk.data.kanji.RadicalVariantTag
All Implemented Interfaces:
java.lang.Comparable<RadicalVariantTag>
Direct Known Subclasses:
RadicalVariant

public class RadicalVariantTag
extends java.lang.Object
implements java.lang.Comparable<RadicalVariantTag>

Mutable class that stores information about a radical variant and provides methods to build radical variant information objects. The only attribute shared between radical's variants are the radical number this class contains much further information about the radical than the basic Radical class

Author:
Luis Alfonso Arce González

Field Summary
protected  java.lang.Integer auxNumber
           
protected  java.lang.Integer kangxiUnicode
           
protected  java.util.List<java.lang.String> names
           
protected  java.lang.Integer radicalNumber
           
 KanjiEnums.RadicalTypeEnum radicalType
           
protected  java.lang.Integer unicode
           
protected  java.lang.String unicodeName
           
 
Constructor Summary
protected RadicalVariantTag(java.lang.Integer radicalNumber)
           
 
Method Summary
 int compareTo(RadicalVariantTag o)
           
 java.lang.Integer getAuxNumber()
          The radical auxiliary number is used to discern between the different shapes of the radical depending on the kanji which owns it.
 java.lang.Integer getKangxiUnicode()
          Returns the radical variant's character secondary representation code point in the unicode standard.
 java.util.List<java.lang.String> getNames()
          Returns the names in Japanese of this radical variant.
 java.lang.Integer getNumber()
          Returns this radical's index number in classic radical list.
 KanjiEnums.RadicalTypeEnum getRadicalType()
           
 java.lang.Integer getUnicode()
          Returns the radical variant's character main representation code point in the unicode standard.
 java.lang.String getUnicodeName()
          Returns the unicode name of the character which code point equals the returned value of the method getUnicode()
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

radicalNumber

protected java.lang.Integer radicalNumber

auxNumber

protected java.lang.Integer auxNumber

unicodeName

protected java.lang.String unicodeName

names

protected java.util.List<java.lang.String> names

unicode

protected java.lang.Integer unicode

kangxiUnicode

protected java.lang.Integer kangxiUnicode

radicalType

public KanjiEnums.RadicalTypeEnum radicalType
Constructor Detail

RadicalVariantTag

protected RadicalVariantTag(java.lang.Integer radicalNumber)
Method Detail

getAuxNumber

public java.lang.Integer getAuxNumber()
The radical auxiliary number is used to discern between the different shapes of the radical depending on the kanji which owns it.

Returns:
the auxiliary radical number of this variant

getUnicodeName

public java.lang.String getUnicodeName()
Returns the unicode name of the character which code point equals the returned value of the method getUnicode()

Returns:
the unicode name of this radical unicode character

getNames

public java.util.List<java.lang.String> getNames()
Returns the names in Japanese of this radical variant. A radical can have many names.

Returns:
the names list of this radical variant

getUnicode

public java.lang.Integer getUnicode()
Returns the radical variant's character main representation code point in the unicode standard. A radical can have more than one representation in unicode standard, the main ones are generally in plane 1.

Returns:
the main unicode code point of this radical variant
See Also:
getKangxiUnicode()

getKangxiUnicode

public java.lang.Integer getKangxiUnicode()
Returns the radical variant's character secondary representation code point in the unicode standard. A radical can have more than one representation in unicode standard, the secondary ones can be either in plane 1 or 2

Returns:
the secondary unicode code point of this radical variant
See Also:
getUnicode()

getRadicalType

public KanjiEnums.RadicalTypeEnum getRadicalType()
Returns:
the type of this radical variant
See Also:
KanjiEnums.RadicalTypeEnum

getNumber

public java.lang.Integer getNumber()
Returns this radical's index number in classic radical list.

Returns:
an Integer representing this radical variant number
See Also:
getAuxNumber()

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object

compareTo

public int compareTo(RadicalVariantTag o)
Specified by:
compareTo in interface java.lang.Comparable<RadicalVariantTag>