e4s.db
Class E4DBColumnInfo

java.lang.Object
  e4s.util.E4Object
      e4s.db.E4DBColumnInfo

All Implemented Interfaces:

E4InputFieldName_Intf, java.lang.Comparable

Direct Known Subclasses:

E4DBColumn, E4EditingDefinitionDataField

public class E4DBColumnInfo
extends E4Object
implements E4InputFieldName_Intf

Column information for database table columns. Holds information such as the column name, datatype but is also very related to the generated user defined types.

Since:

JDK 1.4

See Also:

E4DBColumn, E4DBColumnName, E4EditingDefinitionDataField, E4ModuleDictionaryTables, E4DBType

Field Summary

protected java.lang.Class	m_ColumnBaseType
protected E4DBColumnName	m_ColumnName
protected E4DBColumnType	m_ColumnType

Fields inherited from class e4s.util.E4Object

CRLF, E4S_CORE_SYSTEM_LANGUAGE, NBSP, NULLSTR, URL_ENCODING_CHARSET

Constructor Summary

protected	E4DBColumnInfo()
	E4DBColumnInfo(E4DBColumnInfo ci)
protected	E4DBColumnInfo(E4DBColumnName name)
	E4DBColumnInfo(E4DBColumnName name, E4DBColumnType type)
	E4DBColumnInfo(E4DBColumnName name, E4DBColumnType type, boolean autoincrement)
	E4DBColumnInfo(E4DBColumnName name, E4DBColumnType type, boolean autoincrement, java.lang.Class basetype)
	E4DBColumnInfo(E4DBColumnName name, E4DBColumnType type, boolean autoincrement, java.lang.Class basetype, int len)
	E4DBColumnInfo(E4DBColumnName name, E4DBColumnType type, boolean autoincrement, java.lang.Class basetype, int len, java.lang.String rem)
	E4DBColumnInfo(E4DBColumnName name, E4DBColumnType type, boolean autoincrement, java.lang.Class basetype, java.lang.String rem)
	E4DBColumnInfo(E4DBColumnName name, E4DBColumnType type, boolean autoincrement, int len)
	E4DBColumnInfo(E4DBColumnName name, E4DBColumnType type, boolean autoincrement, int len, java.lang.String rem)
	E4DBColumnInfo(E4DBColumnName name, E4DBColumnType type, boolean autoincrement, java.lang.String rem)
	E4DBColumnInfo(E4DBColumnName name, E4DBColumnType type, java.lang.Class basetype)
	E4DBColumnInfo(E4DBColumnName name, E4DBColumnType type, java.lang.Class basetype, int len)
	E4DBColumnInfo(E4DBColumnName name, E4DBColumnType type, java.lang.Class basetype, int len, java.lang.String rem)
	E4DBColumnInfo(E4DBColumnName name, E4DBColumnType type, java.lang.Class basetype, java.lang.String rem)
	E4DBColumnInfo(E4DBColumnName name, E4DBColumnType type, int len)
	E4DBColumnInfo(E4DBColumnName name, E4DBColumnType type, int len, java.lang.String rem)
	E4DBColumnInfo(E4DBColumnName name, E4DBColumnType type, java.lang.String rem)

Method Summary

static java.lang.String	_getSVNVersionString()
int	compareTo(java.lang.Object o)
boolean	equals(E4InputFieldName_Intf name2) Test, if this fieldname equals the specified name.
boolean	equalsIgnoreCase(E4InputFieldName_Intf name2)
java.lang.Class	getColumnBaseClass() Get the base class for a column.
E4DBColumnName	getColumnName() Get the name of the column.
E4DBColumnType	getColumnType() Get the datatype of the column.
java.lang.String	getHtmlParamName() Get the name for the input field when used in an HTML context for input fields.
int	getLen() Get the length of the column.
java.lang.String	getName() Get the column name as string.
java.lang.String	getRem() Get the remark of the column.
boolean	is_E4Date() Detect, if this column is defined as E4Date.
boolean	is_E4Long() Detect, if this column is defined as E4Long.
boolean	is_E4String() Detect, if this column is defined as E4String.
boolean	is_E4StringImage() Detect, if this column is defined as E4StringImage.
boolean	isAutoincrement()
boolean	isBoolean()
boolean	isColumnType(E4DBColumnType compare) Check, if the column is of a particluar type.
boolean	isDate()
boolean	isString()
boolean	isText()
java.lang.String	makeXmlString_Dictionary()
java.lang.String	makeXmlString_Export()
void	setAutoincrement(boolean autoincrement)
void	setLen(int len) Set the length of the column.
void	setRem(java.lang.String rem) Set the remark of the column.
boolean	sqlRequiresQuotes() Check, if this columntype requires quotes when a database query will be constructed.
java.lang.String	toString()

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, 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

m_ColumnName

protected E4DBColumnName m_ColumnName

m_ColumnType

protected E4DBColumnType m_ColumnType

m_ColumnBaseType

protected java.lang.Class m_ColumnBaseType

Constructor Detail

E4DBColumnInfo

protected E4DBColumnInfo()

E4DBColumnInfo

protected E4DBColumnInfo(E4DBColumnName name)

E4DBColumnInfo

public E4DBColumnInfo(E4DBColumnName name,
                      E4DBColumnType type,
                      java.lang.Class basetype,
                      int len,
                      java.lang.String rem)

E4DBColumnInfo

public E4DBColumnInfo(E4DBColumnName name,
                      E4DBColumnType type)

E4DBColumnInfo

public E4DBColumnInfo(E4DBColumnName name,
                      E4DBColumnType type,
                      java.lang.Class basetype,
                      java.lang.String rem)

E4DBColumnInfo

public E4DBColumnInfo(E4DBColumnName name,
                      E4DBColumnType type,
                      java.lang.Class basetype)

E4DBColumnInfo

public E4DBColumnInfo(E4DBColumnName name,
                      E4DBColumnType type,
                      boolean autoincrement,
                      java.lang.Class basetype,
                      int len,
                      java.lang.String rem)

E4DBColumnInfo

public E4DBColumnInfo(E4DBColumnName name,
                      E4DBColumnType type,
                      boolean autoincrement,
                      java.lang.Class basetype,
                      java.lang.String rem)

E4DBColumnInfo

public E4DBColumnInfo(E4DBColumnName name,
                      E4DBColumnType type,
                      boolean autoincrement,
                      java.lang.Class basetype)

E4DBColumnInfo

public E4DBColumnInfo(E4DBColumnName name,
                      E4DBColumnType type,
                      boolean autoincrement,
                      int len,
                      java.lang.String rem)

E4DBColumnInfo

public E4DBColumnInfo(E4DBColumnName name,
                      E4DBColumnType type,
                      java.lang.Class basetype,
                      int len)

E4DBColumnInfo

public E4DBColumnInfo(E4DBColumnName name,
                      E4DBColumnType type,
                      boolean autoincrement,
                      java.lang.Class basetype,
                      int len)

E4DBColumnInfo

public E4DBColumnInfo(E4DBColumnName name,
                      E4DBColumnType type,
                      int len)

E4DBColumnInfo

public E4DBColumnInfo(E4DBColumnName name,
                      E4DBColumnType type,
                      int len,
                      java.lang.String rem)

E4DBColumnInfo

public E4DBColumnInfo(E4DBColumnName name,
                      E4DBColumnType type,
                      java.lang.String rem)

E4DBColumnInfo

public E4DBColumnInfo(E4DBColumnName name,
                      E4DBColumnType type,
                      boolean autoincrement,
                      int len)

E4DBColumnInfo

public E4DBColumnInfo(E4DBColumnName name,
                      E4DBColumnType type,
                      boolean autoincrement)

E4DBColumnInfo

public E4DBColumnInfo(E4DBColumnName name,
                      E4DBColumnType type,
                      boolean autoincrement,
                      java.lang.String rem)

E4DBColumnInfo

public E4DBColumnInfo(E4DBColumnInfo ci)

Method Detail

getColumnName

public E4DBColumnName getColumnName()

Get the name of the column.

Returns:

name of the column

See Also:

getName(), #getHtmlName()

getColumnType

public E4DBColumnType getColumnType()

Get the datatype of the column.

Returns:

datatype of the column

See Also:

getColumnBaseClass()

isColumnType

public boolean isColumnType(E4DBColumnType compare)

Check, if the column is of a particluar type.

Parameters:

compare - the column type to be compared with

Returns:

true if matching

getColumnBaseClass

public java.lang.Class getColumnBaseClass()

Get the base class for a column. A column can be of one of the simple types but it also can be one of the user generated types. In this case, the user generated type has a baseclass, e.g. E4String. Instead, getColumnType() returns the name of the user defined class, not the underlying class which is covered here.

Returns:

null if not a user defined class, or the base class for the definition. This can be E4String, E4Long or E4StringImage

See Also:

getColumnType(), E4Long, E4String, E4StringImage, E4DBColumnType.is_e4sDefinedType(), E4DBType

is_E4String

public boolean is_E4String()

Detect, if this column is defined as E4String.

is_E4Date

public boolean is_E4Date()

Detect, if this column is defined as E4Date.

is_E4StringImage

public boolean is_E4StringImage()

Detect, if this column is defined as E4StringImage.

is_E4Long

public boolean is_E4Long()

Detect, if this column is defined as E4Long.

getLen

public int getLen()

Get the length of the column.

Returns:

length of the column

See Also:

#setLen()

getRem

public java.lang.String getRem()

Get the remark of the column. The remark is an information stored along with the column, it has no other reason rather than information.

Returns:

remark associated with the column

See Also:

#setRem()

setAutoincrement

public void setAutoincrement(boolean autoincrement)

isAutoincrement

public boolean isAutoincrement()

setRem

public void setRem(java.lang.String rem)

Set the remark of the column. The remark is an information stored along with the column, it has no other reason rather than information.

Parameters:

rem - the remark to be associated with the column

See Also:

getRem()

setLen

public void setLen(int len)

Set the length of the column.

Parameters:

len - length of the column

See Also:

getLen()

toString

public java.lang.String toString()

Overrides:

toString in class E4Object

makeXmlString_Export

public java.lang.String makeXmlString_Export()

makeXmlString_Dictionary

public java.lang.String makeXmlString_Dictionary()

getName

public java.lang.String getName()

Get the column name as string. Simar to getColumnName() and returns the same result as getHtmlParamName(). Use getColumnName(), this function is for compatibility with the interface only.

Specified by:

getName in interface E4InputFieldName_Intf

Returns:

the column name.

See Also:

getColumnName()

getHtmlParamName

public java.lang.String getHtmlParamName()

Get the name for the input field when used in an HTML context for input fields. This is the same as getName().

Specified by:

getHtmlParamName in interface E4InputFieldName_Intf

Returns:

the name

compareTo

public int compareTo(java.lang.Object o)

Specified by:

compareTo in interface java.lang.Comparable

equalsIgnoreCase

public boolean equalsIgnoreCase(E4InputFieldName_Intf name2)

Specified by:

equalsIgnoreCase in interface E4InputFieldName_Intf

equals

public boolean equals(E4InputFieldName_Intf name2)

Description copied from interface: E4InputFieldName_Intf

Test, if this fieldname equals the specified name.

Specified by:

equals in interface E4InputFieldName_Intf

Parameters:

name2 - the name to be checked

Returns:

true, if E4InputFieldName_Intf.getName() matches.

sqlRequiresQuotes

public boolean sqlRequiresQuotes()

Check, if this columntype requires quotes when a database query will be constructed. This is the case for E4DBColumnType._DATATYPE_STRING, E4DBColumnType._DATATYPE_TEXT and E4DBColumnType._DATATYPE_DATE types as well as user defined types based on E4String or E4StringImage.

Returns:

true if quotes are required (String datatypes in database)

isString

public boolean isString()

isText

public boolean isText()

isDate

public boolean isDate()

isBoolean

public boolean isBoolean()

_getSVNVersionString

public static java.lang.String _getSVNVersionString()