e4s.db.dict
Class E4DBDict

java.lang.Object
  e4s.util.E4Object
      e4s.db.dict.E4DBDict

public class E4DBDict
extends E4Object

Part of the datadictionary: holds information of the database and types definition.

Since:

JDK 1.4

See Also:

E4DBDatabase, E4DBTypes

Field Summary

static java.lang.String	_XML_TAG_CREATED Specify the XML tag in the XML file (used for holding the datadictionary information) for the creation date of the table.
static java.lang.String	_XML_TAG_MODIFIED Specify the XML tag in the XML file (used for holding the datadictionary information) for the creation date of the table.
static java.lang.String	_XML_TAG_REM Specify the XML tag in the XML file (used for holding the datadictionary information) for the remark to the table.
static java.lang.String	DICT_APP
static java.lang.String	DICT_SYS
static java.lang.String	DICT_VERSION

Fields inherited from class e4s.util.E4Object

CRLF, E4S_CORE_SYSTEM_LANGUAGE, NBSP, NULLSTR, URL_ENCODING_CHARSET

Method Summary

static void	_executeSQL(E4DBConnectionDefault con, E4User user, E4DBTableName name, java.lang.String sql)
static java.lang.String	_getSVNVersionString()
static void	DEBUG()
static void	executeSQL(E4DBConnectionDefault con, E4User user, E4DBTableName name, java.lang.String sql)
E4DBDatabase	getDatabase()
static E4DBDict	getDict(boolean check_file_date) Read the data dictionary if it has not been read.
static E4DBDict	getInstance() Read the data dictionary if it has not been read or the file is out of date.
AEP_DictionaryPlugIn	getPlugin(java.lang.Class clazz) Get a particular installed plug in identified by it's class name.
AEP_DictionaryPlugIn	getPlugin(java.lang.Class clazz, boolean is_e4s_system) Get a particular installed plug in identified by it's class name.
AEP_DictionaryPlugIn	getPlugin(java.lang.String clazz, boolean is_e4s_system) Get a particular installed plug in identified by it's class name.
AEP_DictionaryPlugIn[]	getPlugins_APP() Get installed plug ins for the Application dictionary.
AEP_DictionaryPlugIn[]	getPlugins_E4S() Get installed plug ins for the E4S dictionary.
static E4DBTypes	getTypes()
void	readDictionary()
void	saveDictionary(java.lang.String application)
static void	toXml_Dates(E4PrintStream pstr, java.util.Date created, java.util.Date modified)
static void	toXml_Rem(E4PrintStream pstr, java.lang.String rem)

Methods inherited from class e4s.util.E4Object

Calendar, CName, CName, E4LabelApp, E4LabelApp, E4LabelApp, E4LabelApp, E4LabelApp, E4LabelApp, E4LabelNone, E4LabelNone, E4LabelNone, E4LabelNone, E4LabelSys, E4LabelSys, e4sCopyright, e4sVersion, encode, encode, encode, encodeHtml, encodeHtml, encodeHtml, encodeURL, encodeURL, encodeURL, finalize, getLINE, getTRACE, getTRACE, getTRACE, getTRACE, getTRACE, getTRACE, getTraceMemory, HtmlEncode, HtmlEncode, HtmlEncode, isdecimal, isdigit, isnotok, isnotok, isnumeric, isok, isok, isok, isok, lastCallingFunction, lastCallingFunction, lastCallingFunction, lastCallingFunction, lastCallingStack, mkdirs, null2nbsp, null2nbsp, null2nbsp, ok, ok, ok, ok, outPrintln, setLogFile4Trace, setTraceMemory, STACKTRACE, toDebug, toDouble, toFloat, toFloat, toString, TRACE_CALLS, TRACE, TRACE, TRACE, TRACE, TRACE, TRACE, TRACE, TRACE, TRACE, TRACE, TRACE, TRACE, wait

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

DICT_VERSION

public static final java.lang.String DICT_VERSION

See Also:

Constant Field Values

DICT_SYS

public static final java.lang.String DICT_SYS

See Also:

Constant Field Values

DICT_APP

public static final java.lang.String DICT_APP

See Also:

Constant Field Values

_XML_TAG_CREATED

public static final java.lang.String _XML_TAG_CREATED

Specify the XML tag in the XML file (used for holding the datadictionary information) for the creation date of the table.

See Also:

E4DBTable._XML_TAG_TABLE, E4DBType._XML_TAG_TYPE, Constant Field Values

_XML_TAG_MODIFIED

public static final java.lang.String _XML_TAG_MODIFIED

Specify the XML tag in the XML file (used for holding the datadictionary information) for the creation date of the table.

See Also:

E4DBTable._XML_TAG_TABLE, E4DBType._XML_TAG_TYPE, Constant Field Values

_XML_TAG_REM

public static final java.lang.String _XML_TAG_REM

Specify the XML tag in the XML file (used for holding the datadictionary information) for the remark to the table.

See Also:

E4DBTable._XML_TAG_TABLE, E4DBColumn._XML_TAG_COLUMN, E4DBType._XML_TAG_TYPE, Constant Field Values

Method Detail

getInstance

public static E4DBDict getInstance()
                            throws E4DBException

Read the data dictionary if it has not been read or the file is out of date.

Throws:

E4DBException

getDict

public static E4DBDict getDict(boolean check_file_date)
                        throws E4DBException

Read the data dictionary if it has not been read.

Parameters:

check_file_date - true enforces an file date/time check against the current data in memory

Throws:

E4DBException

getTypes

public static E4DBTypes getTypes()
                          throws E4DBException

Throws:

E4DBException

getDatabase

public E4DBDatabase getDatabase()

readDictionary

public void readDictionary()
                    throws E4DBException

Throws:

E4DBException

saveDictionary

public void saveDictionary(java.lang.String application)
                    throws java.io.IOException,
                           java.lang.Exception

Throws:

java.io.IOException

java.lang.Exception

toXml_Dates

public static void toXml_Dates(E4PrintStream pstr,
                               java.util.Date created,
                               java.util.Date modified)

toXml_Rem

public static void toXml_Rem(E4PrintStream pstr,
                             java.lang.String rem)

DEBUG

public static void DEBUG()

getPlugin

public AEP_DictionaryPlugIn getPlugin(java.lang.Class clazz,
                                      boolean is_e4s_system)

Get a particular installed plug in identified by it's class name.

Returns:

null if not found or the plugin.

See Also:

getPlugin(String,boolean), getPlugin(Class), getPlugins_APP(), getPlugins_E4S()

getPlugin

public AEP_DictionaryPlugIn getPlugin(java.lang.Class clazz)

Get a particular installed plug in identified by it's class name. Look for E4S system declarations if E4DBSettings.getDictSystemMode() is true.

Returns:

null if not found or the plugin.

See Also:

getPlugin(String,boolean), getPlugin(Class,boolean), getPlugins_APP(), getPlugins_E4S()

getPlugin

public AEP_DictionaryPlugIn getPlugin(java.lang.String clazz,
                                      boolean is_e4s_system)

Get a particular installed plug in identified by it's class name.

Returns:

null if not found or the plugin.

See Also:

getPlugin(Class), #getPlugins()

getPlugins_E4S

public AEP_DictionaryPlugIn[] getPlugins_E4S()

Get installed plug ins for the E4S dictionary.

Returns:

null if no plugin is installed or an array of installed plugins.

See Also:

getPlugin(Class), #getPlugin(String)

getPlugins_APP

public AEP_DictionaryPlugIn[] getPlugins_APP()

Get installed plug ins for the Application dictionary.

Returns:

null if no plugin is installed or an array of installed plugins.

See Also:

getPlugin(Class), #getPlugin(String)

executeSQL

public static void executeSQL(E4DBConnectionDefault con,
                              E4User user,
                              E4DBTableName name,
                              java.lang.String sql)
                       throws E4DBException

Throws:

E4DBException

_executeSQL

public static void _executeSQL(E4DBConnectionDefault con,
                               E4User user,
                               E4DBTableName name,
                               java.lang.String sql)
                        throws E4DBException

Throws:

E4DBException

_getSVNVersionString

public static java.lang.String _getSVNVersionString()