e4s.db.dict
Class E4DBGeneratedClass

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

Direct Known Subclasses:

E4DBTable, E4DBType, E4DBView

public abstract class E4DBGeneratedClass
extends E4Object

Base class for generated object that holds package information.

Since:

JDK 1.4

See Also:

E4DBTable, E4DBType

Field Summary

static java.lang.String	_XML_ATTR_DEPRECATED Belongs this view/type/table to the e4s?
static java.lang.String	_XML_ATTR_SYSTEM Belongs this view/type/table to the e4s?
static java.lang.String	_XML_TAG_PACKAGE Used for storing package information in the dictionary XML structure.

Fields inherited from class e4s.util.E4Object

CRLF, E4S_CORE_SYSTEM_LANGUAGE, NBSP, NULLSTR, URL_ENCODING_CHARSET

Constructor Summary

E4DBGeneratedClass()

Method Summary

static java.lang.String	_getSVNVersionString() Get version info string from subversion.
java.util.Date	getCreated() Get the date of creation.
boolean	getDeprecated()
java.lang.String	getGenerationOutputPath()
static java.lang.String	getGenerationOutputPath(java.lang.String package_name, boolean create_directory)
java.util.Date	getModified() Get the date of the last modification.
java.lang.String	getPackage(boolean use_default) Get the custom package name.
java.lang.String	getPackagePath()
protected AEP_DictionaryPlugIn[]	getPlugins()
boolean	hasChanged()
protected boolean	isSystem() Is this table or view an E4S system table?
static void	printGenerateHeader(E4DBJavaGeneratorPrintStream out, java.lang.Class clazz)
void	resetChanged()
void	setCreated(java.util.Date created) Set the date of creation.
void	setDeprecated(boolean deprecated)
void	setHasChanged()
void	setModified(java.util.Date modified) Set the date of modification.
void	setPackage(java.lang.String packagename) Set the custom package name.
protected void	setSystem(boolean mode) Internal use of E4S only.
void	toXml_Package(E4PrintStream pstr)

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

_XML_ATTR_SYSTEM

public static final java.lang.String _XML_ATTR_SYSTEM

Belongs this view/type/table to the e4s?

See Also:

Constant Field Values

_XML_ATTR_DEPRECATED

public static final java.lang.String _XML_ATTR_DEPRECATED

Belongs this view/type/table to the e4s?

See Also:

Constant Field Values

_XML_TAG_PACKAGE

public static final java.lang.String _XML_TAG_PACKAGE

Used for storing package information in the dictionary XML structure. This is an attribute, associated with the _XML_TAG_TABLE tag to specify the package's name.

See Also:

E4DBTable._XML_TAG_TABLE, E4DBType._XML_TAG_TYPE, E4DBXmlDictionaryHandler, Constant Field Values

Constructor Detail

E4DBGeneratedClass

public E4DBGeneratedClass()

Method Detail

getPackage

public java.lang.String getPackage(boolean use_default)
                            throws E4DBException

Get the custom package name.

Parameters:

use_default - if the package is not defined on table level, use the package defined global for the data dictionary

Returns:

the package definition

Throws:

E4DBException

See Also:

setPackage(String), E4DBSettings.getDictPackage()

getPackagePath

public java.lang.String getPackagePath()
                                throws java.lang.Exception

Throws:

java.lang.Exception

setPackage

public void setPackage(java.lang.String packagename)

Set the custom package name.

See Also:

setPackage(String)

getGenerationOutputPath

public java.lang.String getGenerationOutputPath()

getGenerationOutputPath

public static java.lang.String getGenerationOutputPath(java.lang.String package_name,
                                                       boolean create_directory)
                                                throws E4DBException

Throws:

E4DBException

toXml_Package

public void toXml_Package(E4PrintStream pstr)
                   throws java.lang.Exception

Throws:

java.lang.Exception

setModified

public void setModified(java.util.Date modified)

Set the date of modification.

Parameters:

modified - date the table has been modified

See Also:

getModified(), setCreated(java.util.Date)

getModified

public java.util.Date getModified()

Get the date of the last modification.

Returns:

the date of modification

See Also:

setModified(java.util.Date), getCreated()

setCreated

public void setCreated(java.util.Date created)

Set the date of creation.

Parameters:

created - date the table has been created

See Also:

getCreated(), setModified(java.util.Date)

getCreated

public java.util.Date getCreated()

Get the date of creation.

Returns:

the date of creation

See Also:

getModified(), setCreated(java.util.Date)

isSystem

protected boolean isSystem()

Is this table or view an E4S system table?

Returns:

true if this table is an E4S system table, which means that it cannot be changed within an application but it must exist within an application.

setSystem

protected void setSystem(boolean mode)

Internal use of E4S only.

See Also:

isSystem()

printGenerateHeader

public static void printGenerateHeader(E4DBJavaGeneratorPrintStream out,
                                       java.lang.Class clazz)

getPlugins

protected AEP_DictionaryPlugIn[] getPlugins()

setDeprecated

public void setDeprecated(boolean deprecated)

getDeprecated

public boolean getDeprecated()

setHasChanged

public void setHasChanged()

resetChanged

public void resetChanged()

hasChanged

public boolean hasChanged()

_getSVNVersionString

public static java.lang.String _getSVNVersionString()

Get version info string from subversion.

Returns:

the version info string.

See Also:

E4Util.getRevisionCodeFromSVN(Class)