net.ajaest.jdk.data.kanji
Class RadicalTag

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

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

Immutable class that stores information about a radical. Because the only attribute shared between radical's variants are the radical number, further information about the radical must be searched in the specific variant.

Author:
Luis Alfonso Arce González

Field Summary
protected  java.lang.Integer radicalNumber
           
protected  java.util.Map<KanjiEnums.RadicalTypeEnum,java.util.Set<RadicalVariantTag>> radsTypes
           
protected  java.util.List<RadicalVariantTag> radsVars
           
 
Constructor Summary
protected RadicalTag(java.lang.Integer number)
           
 
Method Summary
 int compareTo(RadicalTag other)
           
 java.lang.Integer getNumber()
          Returns the radical indexing number in classic radical list.
 RadicalVariantTag getRadicalVariant(java.lang.Integer variantNumber)
          Returns the radical variant specified by it's radical variant number.
 java.util.Set<RadicalVariantTag> getRadicalVariant(KanjiEnums.RadicalTypeEnum rte)
          Returns this radical's variants specified by it's type
 java.util.List<RadicalVariantTag> getVariants()
          Returns all the variants of this radical.
 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

radsVars

protected java.util.List<RadicalVariantTag> radsVars

radsTypes

protected java.util.Map<KanjiEnums.RadicalTypeEnum,java.util.Set<RadicalVariantTag>> radsTypes
Constructor Detail

RadicalTag

protected RadicalTag(java.lang.Integer number)
Method Detail

getNumber

public java.lang.Integer getNumber()
Returns the radical indexing number in classic radical list.

Returns:
and integer representing the number of this radical

getRadicalVariant

public RadicalVariantTag getRadicalVariant(java.lang.Integer variantNumber)
Returns the radical variant specified by it's radical variant number.

Parameters:
variantNumber - the variant number of the radical variant to be retrieved
Returns:
this radical's specified variant

getRadicalVariant

public java.util.Set<RadicalVariantTag> getRadicalVariant(KanjiEnums.RadicalTypeEnum rte)
Returns this radical's variants specified by it's type

Parameters:
rte - the radical type of the radical variant to be retrieved
Returns:
this radical's variants which are of the specified type

getVariants

public java.util.List<RadicalVariantTag> getVariants()
Returns all the variants of this radical.

Returns:
all the variants of this radical.

compareTo

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

toString

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