Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

de.folt.constants
Class OpenTMSVersionConstants

java.lang.Object
  extended by de.folt.constants.OpenTMSVersionConstants

public class OpenTMSVersionConstants
extends java.lang.Object

This class acts as the central version information center of OpenTMS. All applications have to define their version info here. A version info is automatically determined using either getFullVersionString() or getVersionString(). Those methods assume a filed defined like that:
The caller class must implement a file (variable) named with the name of the caller class in this class OpenTMSVersionConstants. Two versions are supported: a) A version with the simple name of the class and a version with the long name of a class. In case of the canonical name the "." in the class name path needs to be replaced with "_". These are two examples: 

 Simple name version:    public final static String OpenTMSServer = "0.9"; where OpenTMSServer is the simple name of the OpenTMSServer class.
 Canonical name version: public final static String de_folt_models_applicationmodel_guimodel_editor_datasourceeditor_DataSourceEditor = "0.4.1"; where OpenTMSServer is the canonical name of the class is used.
Based on this the version is determined using the sun reflection API. See for details the method getFullVersionString(). The version scheme used comes from @see Software version numbering
Examples from there: 
 0.5.2 -> (minor revision increase) -> 0.5.3
 1.0 -> (moderate revision increase) -> 1.1
 2.9 -> (major revision increase) -> 3.0
 1.0.0.9 -> (minor revision increase) -> 1.0.1.0
 1.00.99 -> (moderate revision increase) -> 1.01.00
 5.5 -> (major revision increase) -> 6.0
 1.27g -> (minor revision increase) -> 1.27h
 1.50.4582 -> (build increase) -> 1.50.4583
 5.22.999 -> (build increase) -> 5.22.1000

Author:
klemens

Field Summary
static java.lang.String de_coopmedia_models_documentmodel_tck_Tck
          The version of the de_coopmedia_models_documentmodel_tck_Tck Converter
static java.lang.String de_folt_constants_OpenTMSVersionConstants
          OpenTMSVersionConstants version
static java.lang.String de_folt_models_applicationmodel_guimodel_editor_datasourceeditor_DataSourceEditor
          The version of the data source editor
static java.lang.String de_folt_models_applicationmodel_guimodel_editor_datasourceeditor_DataSourceForm
          The version of the data source form editor
static java.lang.String de_folt_models_datamodel_BasicDataSource
          The version of the BasicDataSource class
static java.lang.String de_folt_models_datamodel_csv_Csv
          The version of the Csv data source
static java.lang.String de_folt_models_datamodel_DataSource
          The version of the DataSource interface
static java.lang.String de_folt_models_datamodel_googletranslate_GoogleTranslate
          The version of the GoogleTranslate class
static java.lang.String de_folt_models_datamodel_iate_IateTerminology
          The version of the IateTerminology class
static java.lang.String de_folt_models_datamodel_microsofttranslate_MicrosoftTranslate
          The version of the MicrosoftTranslate class
static java.lang.String de_folt_models_datamodel_mtmoses_MTMoses
          The version of the Moses MT translation system
static java.lang.String de_folt_models_datamodel_multipledatasource_MultipleDataSource
          The version of the de_folt_models_datamodel_multipledatasource_MultipleDataSource data source
static java.lang.String de_folt_models_datamodel_sql_OpenTMSSQLDataSource
          The version of the OpenTMSSQLDataSource class
static java.lang.String de_folt_models_datamodel_tbxfile_TbxFileDataSource
          The version of the TbxFileDataSource data source
static java.lang.String de_folt_models_datamodel_tmxfile_TmxFileDataSource
          The version of the TmxFileDataSource class
static java.lang.String de_folt_models_datamodel_trados_TradosTMDataSource
          The version of the TradosTMDataSource class
static java.lang.String de_folt_models_datamodel_xlifffile_XliffFileDataSource
          The version of the XliffFileDataSource class
static java.lang.String de_folt_models_documentmodel_xliff_XliffDocument
          The version of the OpenTMS XliffDocument class
static java.lang.String de_folt_rpc_webserver_OpenTMSServer
          The version of the OpenTMS XML RPC Server
static java.lang.String de_folt_rpc_webserver_Shutdown
          The version of the OpenTMS XML RPC Server shut down class
static java.lang.String de_folt_webservices_OpenTMSWebServiceImplementation
          The version of the OpenTMSWebServiceImplementation
static java.lang.String de_folt_webservices_OpenTMSWebServiceInterface
          The version of the de_folt_webservices_OpenTMSWebServiceInterface
static java.lang.String de_folt_webservices_SynchronizeService
          The version of the SynchronizeService
static java.lang.String net_docliff_models_applicationmodel_guimodel_editor_XliffEditor
          The version of the docliff xliff editor class
static java.lang.String net_docliff_models_applicationmodel_guimodel_editor_XliffEditorWindow
          The version of the XliffEditorWindow data source
 
Constructor Summary
OpenTMSVersionConstants()
           
 
Method Summary
static java.util.Vector<java.lang.Class> getAllLoadedClasses()
          getAllLoadedClasses
static java.lang.String[] getAllVersions()
          getAllVersions return all the known version numbers in a string array
static java.util.Hashtable<java.lang.String,java.lang.String> getAllVersionsAsHashtable()
          getAllVersions return all the known version numbers in a string array
static java.lang.String getAllVersionsAsString()
          getAllVersions return all the known version numbers in a string
static java.lang.String getFullVersionString()
          getFullVersionString return the full version string for a (caller) class and the basic version for this class.
static java.lang.String getVersionString()
          getVersionString return the version string of class.
static java.lang.String getVersionString(java.lang.Class classname)
          getVersionString get the version string for a class
static java.lang.String getVersionString(java.lang.String classstringname)
          getVersionString return the version of a class where the class name is a string
static void main(java.lang.String[] args)
           
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

de_coopmedia_models_documentmodel_tck_Tck

public static final java.lang.String de_coopmedia_models_documentmodel_tck_Tck
The version of the de_coopmedia_models_documentmodel_tck_Tck Converter

See Also:
Constant Field Values

de_folt_constants_OpenTMSVersionConstants

public static final java.lang.String de_folt_constants_OpenTMSVersionConstants
OpenTMSVersionConstants version

See Also:
Constant Field Values

de_folt_models_applicationmodel_guimodel_editor_datasourceeditor_DataSourceEditor

public static final java.lang.String de_folt_models_applicationmodel_guimodel_editor_datasourceeditor_DataSourceEditor
The version of the data source editor

See Also:
Constant Field Values

de_folt_models_applicationmodel_guimodel_editor_datasourceeditor_DataSourceForm

public static final java.lang.String de_folt_models_applicationmodel_guimodel_editor_datasourceeditor_DataSourceForm
The version of the data source form editor

See Also:
Constant Field Values

de_folt_models_datamodel_BasicDataSource

public static final java.lang.String de_folt_models_datamodel_BasicDataSource
The version of the BasicDataSource class

See Also:
Constant Field Values

de_folt_models_datamodel_csv_Csv

public static final java.lang.String de_folt_models_datamodel_csv_Csv
The version of the Csv data source

See Also:
Constant Field Values

de_folt_models_datamodel_DataSource

public static final java.lang.String de_folt_models_datamodel_DataSource
The version of the DataSource interface

See Also:
Constant Field Values

de_folt_models_datamodel_googletranslate_GoogleTranslate

public static final java.lang.String de_folt_models_datamodel_googletranslate_GoogleTranslate
The version of the GoogleTranslate class

See Also:
Constant Field Values

de_folt_models_datamodel_iate_IateTerminology

public static final java.lang.String de_folt_models_datamodel_iate_IateTerminology
The version of the IateTerminology class

See Also:
Constant Field Values

de_folt_models_datamodel_microsofttranslate_MicrosoftTranslate

public static final java.lang.String de_folt_models_datamodel_microsofttranslate_MicrosoftTranslate
The version of the MicrosoftTranslate class

See Also:
Constant Field Values

de_folt_models_datamodel_mtmoses_MTMoses

public static final java.lang.String de_folt_models_datamodel_mtmoses_MTMoses
The version of the Moses MT translation system

See Also:
Constant Field Values

de_folt_models_datamodel_multipledatasource_MultipleDataSource

public static final java.lang.String de_folt_models_datamodel_multipledatasource_MultipleDataSource
The version of the de_folt_models_datamodel_multipledatasource_MultipleDataSource data source

See Also:
Constant Field Values

de_folt_models_datamodel_sql_OpenTMSSQLDataSource

public static final java.lang.String de_folt_models_datamodel_sql_OpenTMSSQLDataSource
The version of the OpenTMSSQLDataSource class

See Also:
Constant Field Values

de_folt_models_datamodel_tbxfile_TbxFileDataSource

public static final java.lang.String de_folt_models_datamodel_tbxfile_TbxFileDataSource
The version of the TbxFileDataSource data source

See Also:
Constant Field Values

de_folt_models_datamodel_tmxfile_TmxFileDataSource

public static final java.lang.String de_folt_models_datamodel_tmxfile_TmxFileDataSource
The version of the TmxFileDataSource class

See Also:
Constant Field Values

de_folt_models_datamodel_trados_TradosTMDataSource

public static final java.lang.String de_folt_models_datamodel_trados_TradosTMDataSource
The version of the TradosTMDataSource class

See Also:
Constant Field Values

de_folt_models_datamodel_xlifffile_XliffFileDataSource

public static final java.lang.String de_folt_models_datamodel_xlifffile_XliffFileDataSource
The version of the XliffFileDataSource class

See Also:
Constant Field Values

de_folt_models_documentmodel_xliff_XliffDocument

public static final java.lang.String de_folt_models_documentmodel_xliff_XliffDocument
The version of the OpenTMS XliffDocument class

See Also:
Constant Field Values

de_folt_rpc_webserver_OpenTMSServer

public static final java.lang.String de_folt_rpc_webserver_OpenTMSServer
The version of the OpenTMS XML RPC Server

See Also:
Constant Field Values

de_folt_rpc_webserver_Shutdown

public static final java.lang.String de_folt_rpc_webserver_Shutdown
The version of the OpenTMS XML RPC Server shut down class

See Also:
Constant Field Values

net_docliff_models_applicationmodel_guimodel_editor_XliffEditor

public static final java.lang.String net_docliff_models_applicationmodel_guimodel_editor_XliffEditor
The version of the docliff xliff editor class

See Also:
Constant Field Values

net_docliff_models_applicationmodel_guimodel_editor_XliffEditorWindow

public static final java.lang.String net_docliff_models_applicationmodel_guimodel_editor_XliffEditorWindow
The version of the XliffEditorWindow data source

See Also:
Constant Field Values

de_folt_webservices_SynchronizeService

public static final java.lang.String de_folt_webservices_SynchronizeService
The version of the SynchronizeService

See Also:
Constant Field Values

de_folt_webservices_OpenTMSWebServiceImplementation

public static final java.lang.String de_folt_webservices_OpenTMSWebServiceImplementation
The version of the OpenTMSWebServiceImplementation

See Also:
Constant Field Values

de_folt_webservices_OpenTMSWebServiceInterface

public static final java.lang.String de_folt_webservices_OpenTMSWebServiceInterface
The version of the de_folt_webservices_OpenTMSWebServiceInterface

See Also:
Constant Field Values
Constructor Detail

OpenTMSVersionConstants

public OpenTMSVersionConstants()
Method Detail

getAllLoadedClasses

public static java.util.Vector<java.lang.Class> getAllLoadedClasses()
getAllLoadedClasses

getAllVersions

public static java.lang.String[] getAllVersions()
getAllVersions return all the known version numbers in a string array

Returns:
the versions in a field

getAllVersionsAsHashtable

public static java.util.Hashtable<java.lang.String,java.lang.String> getAllVersionsAsHashtable()
getAllVersions return all the known version numbers in a string array

Returns:
the versions in a hash table (key: simple class name; value: version)

getAllVersionsAsString

public static java.lang.String getAllVersionsAsString()
getAllVersions return all the known version numbers in a string

Returns:
the versions in a field

getFullVersionString

public static java.lang.String getFullVersionString()
getFullVersionString return the full version string for a (caller) class and the basic version for this class. It automatically determines the version by using the follwoing steps: 
 Class classname = sun.reflect.Reflection.getCallerClass(2);
 String callingClassName = classname.getSimpleName();
 Date compileDate = de.folt.util.OpenTMSSupportFunctions.getCompileDate(classname);
 String versionInfoString = "No version found";
 Field field = OpenTMSVersionConstants.class.getField(callingClassName);
 versionInfoString = (String) field.get(null);
 return versionInfoString + " (" + compileDate.toString() + ")";
Example returned: xmlRpcServerVersion = "0.4 (Tue Jul 07 16:13:12 CEST 2009)"

Returns:
the full version string or "No version found" if the version could not be determined.

getVersionString

public static java.lang.String getVersionString()
getVersionString return the version string of class. Method as follows: 
 String versionInfoString = "No version found";
 Class classname = sun.reflect.Reflection.getCallerClass(2);
 String callingClassName = classname.getSimpleName();
 Field field = OpenTMSVersionConstants.class.getField(callingClassName);
 versionInfoString = (String) field.get(null);

Returns:
the version string or "No version found" if the version could not be determined.

getVersionString

public static java.lang.String getVersionString(java.lang.Class classname)
getVersionString get the version string for a class

Parameters:
classname - the class to search for the version
Returns:
the version string

getVersionString

public static java.lang.String getVersionString(java.lang.String classstringname)
getVersionString return the version of a class where the class name is a string

Parameters:
classstringname - the class name as a string e.g. de.folt.models.datamodel.googletranslate.GoogleTranslate
Returns:
the version of the class a string

main

public static void main(java.lang.String[] args)
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD