com.baseprogramming.lang
Class TranslationPacket

java.lang.Object
  extended by com.baseprogramming.lang.WordReferencePacket
      extended by com.baseprogramming.lang.TranslationPacket

public class TranslationPacket
extends WordReferencePacket

A translation packet--contains translation data categories. (e.g. PrincipalTranslations (terms0..term[n]), Compounds (original).


Field Summary
 
Fields inherited from class com.baseprogramming.lang.WordReferencePacket
PacketType
 
Constructor Summary
TranslationPacket()
          Default instance
 
Method Summary
 void addCategory(java.lang.String name, java.util.List<Translation> translations)
          Add a list of translations for a category
 void addTranslation(TranslationCategories category, Translation translation)
          Add a translation to the named category of translations.
static TranslationPacket createInstance(java.lang.String name, com.google.gson.JsonObject json)
          Create a TranslationPacket instnace from this JsonObject.
 java.util.List<Translation> getAditionalTranslations()
          Get additional translations category
 java.util.List<Translation> getAllTranslations()
           
 int getCategoryCount()
           
 java.util.Set<java.lang.String> getCategoryNames()
          Get Translation category names
 java.util.List<Translation> getCompounds()
          Get Compounds translations category
 java.util.List<Translation> getEntries()
          Get Entries translations category
 java.lang.String getName()
           
 java.util.List<Translation> getOtherSideEntries()
          Get OtherSideEntries translations category
 java.util.List<Translation> getPrincipalTranslations()
          Get principal translations category
 Translation getTranslation()
          Get the first translation in the Principals category
 Translation getTranslation(int index)
          Get the category with given index in the PrincipalTranslations category
 Translation getTranslation(TranslationCategories category)
          Returns the first translation in this category
 Translation getTranslation(TranslationCategories category, int index)
          get the translation in this category with given index
 java.util.List<Translation> getTranslations(TranslationCategories category)
          Get named translation category
 void setName(java.lang.String name)
           
 
Methods inherited from class com.baseprogramming.lang.WordReferencePacket
getPacketType, setPacketType
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

TranslationPacket

public TranslationPacket()
Default instance

Method Detail

getAllTranslations

public java.util.List<Translation> getAllTranslations()

getCategoryCount

public int getCategoryCount()

setName

public void setName(java.lang.String name)

getName

public java.lang.String getName()

getCategoryNames

public java.util.Set<java.lang.String> getCategoryNames()
Get Translation category names

Returns:

addCategory

public void addCategory(java.lang.String name,
                        java.util.List<Translation> translations)
Add a list of translations for a category

Parameters:
name -
translation -

addTranslation

public void addTranslation(TranslationCategories category,
                           Translation translation)
Add a translation to the named category of translations. if the category does not exits, it is created

Parameters:
name -
translation -

getTranslation

public Translation getTranslation()
Get the first translation in the Principals category

Returns:
translation

getTranslation

public Translation getTranslation(int index)
Get the category with given index in the PrincipalTranslations category

Parameters:
index -
Returns:

getTranslation

public Translation getTranslation(TranslationCategories category)
                           throws java.lang.IllegalAccessException
Returns the first translation in this category

Parameters:
category -
Returns:
Throws:
java.lang.IllegalAccessException

getTranslation

public Translation getTranslation(TranslationCategories category,
                                  int index)
                           throws java.lang.IllegalArgumentException,
                                  java.lang.IndexOutOfBoundsException
get the translation in this category with given index

Parameters:
category -
index -
Returns:
Throws:
java.lang.IllegalArgumentException
java.lang.IndexOutOfBoundsException

getTranslations

public java.util.List<Translation> getTranslations(TranslationCategories category)
                                            throws java.lang.IllegalArgumentException
Get named translation category

Parameters:
category-category - name
Returns:
Translation
Throws:
java.lang.IllegalArgumentException

getPrincipalTranslations

public java.util.List<Translation> getPrincipalTranslations()
Get principal translations category

Returns:
List of translations

getAditionalTranslations

public java.util.List<Translation> getAditionalTranslations()
Get additional translations category

Returns:
List of translations

getEntries

public java.util.List<Translation> getEntries()
Get Entries translations category

Returns:
List of translations

getOtherSideEntries

public java.util.List<Translation> getOtherSideEntries()
Get OtherSideEntries translations category

Returns:
List of translations

getCompounds

public java.util.List<Translation> getCompounds()
Get Compounds translations category

Returns:
List of translations

createInstance

public static TranslationPacket createInstance(java.lang.String name,
                                               com.google.gson.JsonObject json)
                                        throws java.io.IOException
Create a TranslationPacket instnace from this JsonObject.

Parameters:
name -
json -
Returns:
Throws:
java.io.IOException