com.elegantj.data.dataprovider.sql
Class ColumnAttribs

java.lang.Object
  com.elegantj.data.dataprovider.sql.ColumnAttribs

public class ColumnAttribs

extends java.lang.Object

The ColumnAttribs provides the attributes of the column.

Constructor Summary

ColumnAttribs(java.lang.String catalogName, java.lang.String columnClassName, int columnDisplaySize, java.lang.String columnLabel, java.lang.String columnName, int columnType, java.lang.String columnTypeName, int precision, int scale, java.lang.String schemaName, java.lang.String tableName, boolean autoIncrement, boolean caseSensitive, boolean currency, boolean defWritable, int nullable, boolean readOnly, boolean searchable, boolean signed, boolean writable)
Creates a ColumnAttribs with the specified attributes

Method Summary

java.lang.String	getCatalogName() Returns a column's table's catalog name.
java.lang.String	getColumnClassName() Returns the fully qualified column's class name
int	getColumnDisplaySize() Indicates the column's normal max width in chars.
java.lang.String	getColumnLabel() Returns the suggested column title for use in printouts and displays.
java.lang.String	getColumnName() Returns the column's name.
int	getColumnType() Retrieves a column's SQL type.
java.lang.String	getColumnTypeName() Retrieves a column's database-specific type name.
java.lang.String	getName() Returns the column's name with it's catalog, schema and table names
int	getPrecision() Returns a column's number of decimal digits.
int	getScale() Returns a column's number of digits to right of the decimal point.
java.lang.String	getSchemaName() Returns a column's table's schema.
java.lang.String	getTableName() Returns a column's table name.
boolean	isAutoIncrement() Indicates whether the column is automatically numbered, thus read-only.
boolean	isCaseSensitive() Indicates whether the column's case matters.
boolean	isCurrency() Indicates whether the column is a cash value.
boolean	isDefinitelyWritable() Indicates whether a write on the column will definitely succeed.
int	isNullable() Indicates the nullability of values in the designated column.
boolean	isPrimaryKey() Indicates whether the column is a primary key
boolean	isReadOnly() Indicates whether the column is definitely not writable.
boolean	isSearchable() Indicates whether the column can be used in a where clause.
boolean	isSigned() Indicates whether values in the column are signed numbers.
boolean	isUniqueKey() Indicates whether the column is a unique key
boolean	isUpdateable() Indicates whether the column is a updateable
boolean	isWritable() Indicates whether it is possible for a write on the column to succeed.
void	setPrimaryKey(boolean primaryKey) Indicates whether the column is a primary key
void	setUniqueKey(boolean uniqueKey) Indicates whether the column is a unique key
void	setUpdateable(boolean updateable) Indicates whether the column is a updateable
java.lang.String	toString() Returns the string representation of this object

Methods inherited from class java.lang.Object

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

Constructor Detail

ColumnAttribs

public ColumnAttribs(java.lang.String catalogName,
                     java.lang.String columnClassName,
                     int columnDisplaySize,
                     java.lang.String columnLabel,
                     java.lang.String columnName,
                     int columnType,
                     java.lang.String columnTypeName,
                     int precision,
                     int scale,
                     java.lang.String schemaName,
                     java.lang.String tableName,
                     boolean autoIncrement,
                     boolean caseSensitive,
                     boolean currency,
                     boolean defWritable,
                     int nullable,
                     boolean readOnly,
                     boolean searchable,
                     boolean signed,
                     boolean writable)

Creates a ColumnAttribs with the specified attributes

Parameters:

catalogName - the column's table's catalog name

columnClassName - the fully qualified column class name

columnDisplaySize - the column's normal max width in chars

columnLabel - the suggested column title for use in printouts and displays

columnName - the column's name

columnType - the columns's SQL type

columnTypeName - the column's database-specific type name

precision - the column's number of decimal digits

scale - the column's number of digits to right of the decimal point

schemaName - the column's table's schema

tableName - the column's table name

autoIncrement - indicates whether the column is automatically numbered, thus read-only

caseSensitive - indicates whether a column's case matters

currency - indicates whether the column is a cash value

defWritable - indicates whether a write on the column will definitely succeed

nullable - indicates the nullability of values in the designated column

readOnly - indicates whether a column is definitely not writable

searchable - indicates whether the column can be used in a where clause

signed - indicates whether values in the column are signed numbers

writable - indicates whether it is possible for a write on the column to succeed

Method Detail

getName

public java.lang.String getName()

Returns the column's name with it's catalog, schema and table names

Returns:

the column's name

getCatalogName

public java.lang.String getCatalogName()

Returns a column's table's catalog name.

Returns:

the catalog name

getColumnClassName

public java.lang.String getColumnClassName()

Returns the fully qualified column's class name

Returns:

the column's class name

getColumnDisplaySize

public int getColumnDisplaySize()

Indicates the column's normal max width in chars.

Returns:

the display size

getColumnLabel

public java.lang.String getColumnLabel()

Returns the suggested column title for use in printouts and displays.

Returns:

the column label

getColumnName

public java.lang.String getColumnName()

Returns the column's name.

Returns:

the column's name

getColumnType

public int getColumnType()

Retrieves a column's SQL type.

Returns:

the column's type

getColumnTypeName

public java.lang.String getColumnTypeName()

Retrieves a column's database-specific type name.

Returns:

the column's type name

getPrecision

public int getPrecision()

Returns a column's number of decimal digits.

Returns:

the precision

getScale

public int getScale()

Returns a column's number of digits to right of the decimal point.

Returns:

the scale

getSchemaName

public java.lang.String getSchemaName()

Returns a column's table's schema.

Returns:

the schema name

getTableName

public java.lang.String getTableName()

Returns a column's table name.

Returns:

the table name

isAutoIncrement

public boolean isAutoIncrement()

Indicates whether the column is automatically numbered, thus read-only.

Returns:

true if the column is automatically numbered, otherwise false

isCaseSensitive

public boolean isCaseSensitive()

Indicates whether the column's case matters.

Returns:

true if the column's case matters, otherwise false

isCurrency

public boolean isCurrency()

Indicates whether the column is a cash value.

Returns:

true if the column is a cash value, otherwise false

isDefinitelyWritable

public boolean isDefinitelyWritable()

Indicates whether a write on the column will definitely succeed.

Returns:

true if a write on the column will definitely succeed, otherwise false

isNullable

public int isNullable()

Indicates the nullability of values in the designated column.

Returns:

true if the nullability of values in the designated column, otherwise false

isReadOnly

public boolean isReadOnly()

Indicates whether the column is definitely not writable.

Returns:

true if the column is definitely not writable, otherwise false

isSearchable

public boolean isSearchable()

Indicates whether the column can be used in a where clause.

Returns:

true if the column can be used in a where clause, otherwise false

isSigned

public boolean isSigned()

Indicates whether values in the column are signed numbers.

Returns:

true if values in the column are signed numbers, otherwise false

isWritable

public boolean isWritable()

Indicates whether it is possible for a write on the column to succeed.

Returns:

true if it is possible for a write on the column to succeed, otherwise false

setUpdateable

public void setUpdateable(boolean updateable)

Indicates whether the column is a updateable

Parameters:

updateable - true if the column is a updateable, otherwise false

isUpdateable

public boolean isUpdateable()

Indicates whether the column is a updateable

Returns:

true if the column is a updateable, otherwise false

setUniqueKey

public void setUniqueKey(boolean uniqueKey)

Indicates whether the column is a unique key

Parameters:

uniqueKey - true if the column is a unique key, otherwise false

isUniqueKey

public boolean isUniqueKey()

Indicates whether the column is a unique key

Returns:

true if the column is a unique key, otherwise false

setPrimaryKey

public void setPrimaryKey(boolean primaryKey)

Indicates whether the column is a primary key

Parameters:

primaryKey - true if the column is a primary key, otherwise false

isPrimaryKey

public boolean isPrimaryKey()

Indicates whether the column is a primary key

Returns:

true if the column is a primary key, otherwise false

toString

public java.lang.String toString()

Returns the string representation of this object

Returns:

the string