oracle.forms.jdapi
Class TranslationTable

java.lang.Object
  |
  +--oracle.forms.jdapi.TranslationTable
All Implemented Interfaces:
java.util.Iterator

public final class TranslationTable
extends java.lang.Object
implements java.util.Iterator

Class representing the translations in a FormModule.

The iterator interface is implemented to allow access to the translations using the standard iterator methods (hasNext, next, and remove).


Field Summary
protected  int[] m_charSetArray
          Array of character sets in the translation table
protected  java.util.Vector m_langArray
          Array of languages in the translation table held in a Vector.
 
Constructor Summary
protected TranslationTable(JdapiModule mod)
          Constructor called by JdapiModule only
 
Method Summary
 int addTranslation(java.lang.String language, int characterSet)
          Adds a translation to the table.
 void deleteTranslation(java.lang.String language)
          Deletes a given language translation from the table.
 int getCharacterSet(java.lang.String language)
          Returns a language's corresponding character set.
 java.lang.String getCurrentLanguageString()
          Returns the Module's current language string.
 java.lang.String getLanguageString(int characterSet)
          Returns a character set's corresponding language.
 JdapiModule getModule()
          Returns the JdapiModule to which this TranslationTable corresponds.
 java.lang.String getString(java.lang.String language, int stringID)
          Returns a String given its stringID for a specified language.
 int getStringCount()
          Returns the number of used strings in the module's string table.
 java.lang.Class getStringObjectClass(int stringID)
          Returns the property number for the string and the given stringID
 int getStringObjectType(int stringID)
          Returns the object type for the string at the given stringID
 int getStringPropertyNumber(int stringID)
          Returns the property number for the string at the given stringID
 void goStart()
          Reset the iterator to the start of the language table
 boolean hasNext()
          Returns true if the iteration has more elements.
 boolean isStringInUse(int stringID)
          Queries whether a given String is in use or not.
 java.lang.Object next()
          Gets the next object.
 void remove()
          Removes the current translation in the iterator using deleteTranslation.
 void setString(java.lang.String language, int stringID, java.lang.String str)
          Sets a String given its stringID and language
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

m_langArray

protected java.util.Vector m_langArray
Array of languages in the translation table held in a Vector.

m_charSetArray

protected int[] m_charSetArray
Array of character sets in the translation table
Constructor Detail

TranslationTable

protected TranslationTable(JdapiModule mod)
Constructor called by JdapiModule only
Method Detail

getModule

public JdapiModule getModule()
Returns the JdapiModule to which this TranslationTable corresponds.
Returns:
JdapiModule

getCharacterSet

public int getCharacterSet(java.lang.String language)
Returns a language's corresponding character set.
Parameters:
language - the Oracle-defined name of the language.
Returns:
integer corresponding to the Oracle name for the character set.
Throws:
JdapiIllegalStateException - if the langauge is not in the table.

getLanguageString

public java.lang.String getLanguageString(int characterSet)
Returns a character set's corresponding language.
Parameters:
characterSet - the Oracle-defined name of the character set.
Returns:
String for the Oracle-defined name of the language.

getCurrentLanguageString

public java.lang.String getCurrentLanguageString()
Returns the Module's current language string.
Returns:
String for the Oracle-defined name of the language.

addTranslation

public int addTranslation(java.lang.String language,
                          int characterSet)
Adds a translation to the table.
Parameters:
language - the Oracle-defined name of the language.
characterSet - the Oracle-defined name of the character set.
Returns:
the index of the new translation

deleteTranslation

public void deleteTranslation(java.lang.String language)
Deletes a given language translation from the table.
Parameters:
language - the Oracle-defined name of the language.
Throws:
JdapiIllegalStateException - if the langauge is not in the table.

getStringCount

public int getStringCount()
Returns the number of used strings in the module's string table.

Note that the string array is 1-indexed rather than zero-indexed, so strings for a given language can be processed as follows:

  for (int i = 1; i <= fmb.getStringCount(); i++)
  {
    String str = fmb.getString(lang, n);
    ...
  }
 

Returns:
the number of used strings as an integer.

isStringInUse

public boolean isStringInUse(int stringID)
Queries whether a given String is in use or not.
Parameters:
stringID - the integer that indexes the string property in the table for the current language.
Returns:
true if the String is in use; false otherwise.

getString

public java.lang.String getString(java.lang.String language,
                                  int stringID)
Returns a String given its stringID for a specified language.
Parameters:
language - the Oracle-defined name of the language.
stringID - the integer that indexes the string property in the table for the current language.
Returns:
String
Throws:
JdapiIllegalStateException - if the langauge isn't in the table.

setString

public void setString(java.lang.String language,
                      int stringID,
                      java.lang.String str)
Sets a String given its stringID and language
Parameters:
language - the Oracle-defined name of the language.
stringID - the integer that indexes the string property in the table for the current language.
str - the string property.
Throws:
JdapiIllegalStateException - if the langauge is not in the table.

getStringPropertyNumber

public int getStringPropertyNumber(int stringID)
Returns the property number for the string at the given stringID
Parameters:
stringID - the integer that indexes the string property in the table for the current language.
Returns:
integer of the property number.

getStringObjectType

public int getStringObjectType(int stringID)
Returns the object type for the string at the given stringID
Parameters:
stringID - the integer that indexes the string property in the table for the current language.
Returns:
int

getStringObjectClass

public java.lang.Class getStringObjectClass(int stringID)
Returns the property number for the string and the given stringID
Parameters:
stringID - the integer that indexes the string property in the table for the current language.
Returns:
Class

hasNext

public boolean hasNext()
Returns true if the iteration has more elements.
Specified by:
hasNext in interface java.util.Iterator
Returns:
boolean

next

public java.lang.Object next()
Gets the next object.
Specified by:
next in interface java.util.Iterator
Returns:
Object

goStart

public void goStart()
Reset the iterator to the start of the language table

remove

public void remove()
Removes the current translation in the iterator using deleteTranslation.
Specified by:
remove in interface java.util.Iterator