Column Class Reference

Represents the a Column definition on a result. More...

Methods
String	getSchemaName ()
	Retrieves the name of the Schema where the column is defined. More...
String	getTableName ()
	Retrieves table name where the column is defined. More...
String	getTableLabel ()
	Retrieves table alias where the column is defined. More...
String	getColumnName ()
	Retrieves column name. More...
String	getColumnLabel ()
	Retrieves column alias. More...
Type	getType ()
	Retrieves column Type. More...
Integer	getLength ()
	Retrieves column length. More...
Integer	getFractionalDigits ()
	Retrieves the fractional digits if applicable. More...
Bool	isNumberSigned ()
	Indicates if a numeric column is signed. More...
String	getCollationName ()
	Retrieves the collation name. More...
String	getCharacterSetName ()
	Retrieves the character set name. More...
Bool	isZeroFill ()
	Indicates if zerofill is set for the column. More...
String	getFlags ()
	Retrieves a space separated list of database flags. More...

Properties
	schemaName
	Same as getSchemaName()
	tableName
	Same as getTableName()
	tableLabel
	Same as getTableLabel()
	columnName
	Same as getColumnName()
	columnLabel
	Same as getColumnLabel()
	type
	Same as getType()
	length
	Same as getLength()
	fractionalDigits
	Same as getFractionalDigits()
	numberSigned
	Same as isNumberSigned()
	collationName
	Same as getCollationName()
	characterSetName
	Same as getCharacterSetName()
	zeroFill
	Same as isZeroFill()
	flags
	Same as getFlags()

Detailed Description

Represents the a Column definition on a result.

Member Function Documentation

getSchemaName()

String getSchemaName ( )

inline

Retrieves the name of the Schema where the column is defined.

Returns

a string value representing the owner schema.

getTableName()

String getTableName ( )

inline

Retrieves table name where the column is defined.

Returns

a string value representing the table name.

getTableLabel()

String getTableLabel ( )

inline

Retrieves table alias where the column is defined.

Returns

a string value representing the table alias or the table name if no alias is defined.

getColumnName()

String getColumnName ( )

inline

Retrieves column name.

Returns

a string value representing the column name.

getColumnLabel()

String getColumnLabel ( )

inline

Retrieves column alias.

Returns

a string value representing the column alias or the column name if no alias is defined.

getType()

Type getType ( )

inline

Retrieves column Type.

Returns

a constant value for the supported column types.

getLength()

Integer getLength ( )

inline

Retrieves column length.

Returns

the column length.

getFractionalDigits()

Integer getFractionalDigits ( )

inline

Retrieves the fractional digits if applicable.

Returns

the number of fractional digits, this only applies to specific data types.

isNumberSigned()

Bool isNumberSigned ( )

inline

Indicates if a numeric column is signed.

Returns

a boolean indicating whether a numeric column is signed or not.

getCollationName()

String getCollationName ( )

inline

Retrieves the collation name.

Returns

a String representing the collation name, aplicable only to specific data types.

getCharacterSetName()

String getCharacterSetName ( )

inline

Retrieves the character set name.

Returns

a String representing the character set name, aplicable only to specific data types.

isZeroFill()

Bool isZeroFill ( )

inline

Indicates if zerofill is set for the column.

Returns

a boolean indicating if zerofill flag is set for the column.

getFlags()

String getFlags ( )

inline

Retrieves a space separated list of database flags.

Returns

a space separated list of database flags set for the column.