org.plasma.provisioning.rdb.mysql.v5_5
Interface TableColumn

All Superinterfaces:

DataObject, PlasmaDataObject, Serializable

All Known Implementing Classes:

TableColumnImpl

public interface TableColumn
extends PlasmaDataObject

Represents a system column definition which is linked to its system Table definition by association.

Generated interface representing the domain model entity TableColumn. This SDO interface directly reflects the class (single or multiple) inheritance lattice of the source domain model(s) and is part of namespace http://org.plasma/sdo/mysql/5_5 defined within the Configuration.

Data Store Mapping: Corresponds to the physical data store entity COLUMNS.

See Also:

Table

Nested Class Summary

static class

TableColumn.PROPERTY The declared logical property names for this Type.

Field Summary

static String	NAMESPACE_URI The SDO namespace URI associated with the Type for this class.
static String	TYPE_NAME_TABLE_COLUMN The entity or Type logical name associated with this class.

Method Summary

Table	createTable() Creates and returns a new instance of Type Table automatically establishing a containment relationship through the object's reference property, table.
String	getCharacterSetName() Returns the value of the characterSetName property.
int	getCharMaxLength() Returns the value of the charMaxLength property.
String	getColumnComment() Returns the value of the columnComment property.
String	getColumnKey() Returns the value of the columnKey property.
String	getColumnName() Returns the value of the columnName property.
String	getColumnType() Returns the value of the columnType property.
int	getDataPrecision() Returns the value of the dataPrecision property.
int	getDataScale() Returns the value of the dataScale property.
String	getDataType() Returns the value of the dataType property.
String	getNullable() Returns the value of the nullable property.
int	getOctetMaxLength() Returns the value of the octetMaxLength property.
String	getOwner() Returns the value of the owner property.
Table	getTable() Returns the value of the table property.
boolean	isSetCharacterSetName() Returns true if the characterSetName property is set.
boolean	isSetCharMaxLength() Returns true if the charMaxLength property is set.
boolean	isSetColumnComment() Returns true if the columnComment property is set.
boolean	isSetColumnKey() Returns true if the columnKey property is set.
boolean	isSetColumnName() Returns true if the columnName property is set.
boolean	isSetColumnType() Returns true if the columnType property is set.
boolean	isSetDataPrecision() Returns true if the dataPrecision property is set.
boolean	isSetDataScale() Returns true if the dataScale property is set.
boolean	isSetDataType() Returns true if the dataType property is set.
boolean	isSetNullable() Returns true if the nullable property is set.
boolean	isSetOctetMaxLength() Returns true if the octetMaxLength property is set.
boolean	isSetOwner() Returns true if the owner property is set.
boolean	isSetTable() Returns true if the table property is set.
void	setCharacterSetName(String value) Sets the value of the characterSetName property to the given value.
void	setCharMaxLength(int value) Sets the value of the charMaxLength property to the given value.
void	setColumnComment(String value) Sets the value of the columnComment property to the given value.
void	setColumnKey(String value) Sets the value of the columnKey property to the given value.
void	setColumnName(String value) Sets the value of the columnName property to the given value.
void	setColumnType(String value) Sets the value of the columnType property to the given value.
void	setDataPrecision(int value) Sets the value of the dataPrecision property to the given value.
void	setDataScale(int value) Sets the value of the dataScale property to the given value.
void	setDataType(String value) Sets the value of the dataType property to the given value.
void	setNullable(String value) Sets the value of the nullable property to the given value.
void	setOctetMaxLength(int value) Sets the value of the octetMaxLength property to the given value.
void	setOwner(String value) Sets the value of the owner property to the given value.
void	setTable(Table value) Sets the value of the table property to the given value.
void	unsetCharacterSetName() Unsets the characterSetName property, the value of the property of the object being set to the property's default value.
void	unsetCharMaxLength() Unsets the charMaxLength property, the value of the property of the object being set to the property's default value.
void	unsetColumnComment() Unsets the columnComment property, the value of the property of the object being set to the property's default value.
void	unsetColumnKey() Unsets the columnKey property, the value of the property of the object being set to the property's default value.
void	unsetColumnName() Unsets the columnName property, the value of the property of the object being set to the property's default value.
void	unsetColumnType() Unsets the columnType property, the value of the property of the object being set to the property's default value.
void	unsetDataPrecision() Unsets the dataPrecision property, the value of the property of the object being set to the property's default value.
void	unsetDataScale() Unsets the dataScale property, the value of the property of the object being set to the property's default value.
void	unsetDataType() Unsets the dataType property, the value of the property of the object being set to the property's default value.
void	unsetNullable() Unsets the nullable property, the value of the property of the object being set to the property's default value.
void	unsetOctetMaxLength() Unsets the octetMaxLength property, the value of the property of the object being set to the property's default value.
void	unsetOwner() Unsets the owner property, the value of the property of the object being set to the property's default value.
void	unsetTable() Unsets the table property, the value of the property of the object being set to the property's default value.

Methods inherited from interface org.plasma.sdo.PlasmaDataObject

accept, accept, accept, acceptDepthFirst, add, contains, dump, dumpDepthFirst, find, getDataObject, getUUID, getUUIDAsString, remove, remove, reset, resetUUID, setContainer, setContainmentProperty, setDataGraph

Methods inherited from interface commonj.sdo.DataObject

createDataObject, createDataObject, createDataObject, createDataObject, createDataObject, createDataObject, delete, detach, get, get, get, getBigDecimal, getBigDecimal, getBigDecimal, getBigInteger, getBigInteger, getBigInteger, getBoolean, getBoolean, getBoolean, getByte, getByte, getByte, getBytes, getBytes, getBytes, getChangeSummary, getChar, getChar, getChar, getContainer, getContainmentProperty, getDataGraph, getDataObject, getDataObject, getDataObject, getDate, getDate, getDate, getDouble, getDouble, getDouble, getFloat, getFloat, getFloat, getInstanceProperties, getInstanceProperty, getInt, getInt, getInt, getList, getList, getList, getLong, getLong, getLong, getProperty, getRootObject, getSequence, getSequence, getSequence, getSequence, getShort, getShort, getShort, getString, getString, getString, getType, isSet, isSet, isSet, set, set, set, setBigDecimal, setBigDecimal, setBigDecimal, setBigInteger, setBigInteger, setBigInteger, setBoolean, setBoolean, setBoolean, setByte, setByte, setByte, setBytes, setBytes, setBytes, setChar, setChar, setChar, setDataObject, setDataObject, setDataObject, setDate, setDate, setDate, setDouble, setDouble, setDouble, setFloat, setFloat, setFloat, setInt, setInt, setInt, setList, setList, setList, setLong, setLong, setLong, setShort, setShort, setShort, setString, setString, setString, unset, unset, unset

Field Detail

NAMESPACE_URI

static final String NAMESPACE_URI

The SDO namespace URI associated with the Type for this class.

See Also:

Constant Field Values

TYPE_NAME_TABLE_COLUMN

static final String TYPE_NAME_TABLE_COLUMN

The entity or Type logical name associated with this class.

See Also:

Constant Field Values

Method Detail

isSetColumnName

boolean isSetColumnName()

Returns true if the columnName property is set.

Property Definition: See getColumnName or setColumnName(...) for a definition of property columnName

Returns:

true if the columnName property is set.

unsetColumnName

void unsetColumnName()

Unsets the columnName property, the value of the property of the object being set to the property's default value. The property will no longer be considered set.

Property Definition: See getColumnName or setColumnName(...) for a definition of property columnName

getColumnName

String getColumnName()

Returns the value of the columnName property.

Property Definition: Column name

Returns:

the value of the columnName property.

setColumnName

void setColumnName(String value)

Sets the value of the columnName property to the given value.

Property Definition: Column name

isSetDataType

boolean isSetDataType()

Returns true if the dataType property is set.

Property Definition: See getDataType or setDataType(...) for a definition of property dataType

Returns:

true if the dataType property is set.

unsetDataType

void unsetDataType()

Unsets the dataType property, the value of the property of the object being set to the property's default value. The property will no longer be considered set.

Property Definition: See getDataType or setDataType(...) for a definition of property dataType

getDataType

String getDataType()

Returns the value of the dataType property.

Property Definition: Datatype of the column

Returns:

the value of the dataType property.

setDataType

void setDataType(String value)

Sets the value of the dataType property to the given value.

Property Definition: Datatype of the column

Enumeration Constraints:

     name: SysDataType
     URI:http://org.plasma/sdo/mysql/5_5

isSetNullable

boolean isSetNullable()

Returns true if the nullable property is set.

Property Definition: See getNullable or setNullable(...) for a definition of property nullable

Returns:

true if the nullable property is set.

unsetNullable

void unsetNullable()

Unsets the nullable property, the value of the property of the object being set to the property's default value. The property will no longer be considered set.

Property Definition: See getNullable or setNullable(...) for a definition of property nullable

getNullable

String getNullable()

Returns the value of the nullable property.

Property Definition: Specifies whether a column allows NULLs. Value is N if there is a NOT NULL constraint on the column or if the column is part of a PRIMARY KEY. The constraint should be in an ENABLE VALIDATE state.

Returns:

the value of the nullable property.

setNullable

void setNullable(String value)

Sets the value of the nullable property to the given value.

Property Definition: Specifies whether a column allows NULLs. Value is N if there is a NOT NULL constraint on the column or if the column is part of a PRIMARY KEY. The constraint should be in an ENABLE VALIDATE state.

isSetCharMaxLength

boolean isSetCharMaxLength()

Returns true if the charMaxLength property is set.

Property Definition: See getCharMaxLength or setCharMaxLength(...) for a definition of property charMaxLength

Returns:

true if the charMaxLength property is set.

unsetCharMaxLength

void unsetCharMaxLength()

Unsets the charMaxLength property, the value of the property of the object being set to the property's default value. The property will no longer be considered set.

Property Definition: See getCharMaxLength or setCharMaxLength(...) for a definition of property charMaxLength

getCharMaxLength

int getCharMaxLength()

Returns the value of the charMaxLength property.

Property Definition: Length of the column (in bytes)

Returns:

the value of the charMaxLength property.

setCharMaxLength

void setCharMaxLength(int value)

Sets the value of the charMaxLength property to the given value.

Property Definition: Length of the column (in bytes)

isSetDataPrecision

boolean isSetDataPrecision()

Returns true if the dataPrecision property is set.

Property Definition: See getDataPrecision or setDataPrecision(...) for a definition of property dataPrecision

Returns:

true if the dataPrecision property is set.

unsetDataPrecision

void unsetDataPrecision()

Unsets the dataPrecision property, the value of the property of the object being set to the property's default value. The property will no longer be considered set.

Property Definition: See getDataPrecision or setDataPrecision(...) for a definition of property dataPrecision

getDataPrecision

int getDataPrecision()

Returns the value of the dataPrecision property.

Property Definition: Decimal precision (total number of digits) for NUMBER datatype; binary precision for FLOAT datatype, null for all other datatypes.

Returns:

the value of the dataPrecision property.

setDataPrecision

void setDataPrecision(int value)

Sets the value of the dataPrecision property to the given value.

Property Definition: Decimal precision (total number of digits) for NUMBER datatype; binary precision for FLOAT datatype, null for all other datatypes.

isSetDataScale

boolean isSetDataScale()

Returns true if the dataScale property is set.

Property Definition: See getDataScale or setDataScale(...) for a definition of property dataScale

Returns:

true if the dataScale property is set.

unsetDataScale

void unsetDataScale()

Unsets the dataScale property, the value of the property of the object being set to the property's default value. The property will no longer be considered set.

Property Definition: See getDataScale or setDataScale(...) for a definition of property dataScale

getDataScale

int getDataScale()

Returns the value of the dataScale property.

Property Definition: Digits to right of decimal point in a number

Returns:

the value of the dataScale property.

setDataScale

void setDataScale(int value)

Sets the value of the dataScale property to the given value.

Property Definition: Digits to right of decimal point in a number

isSetColumnKey

boolean isSetColumnKey()

Returns true if the columnKey property is set.

Property Definition: See getColumnKey or setColumnKey(...) for a definition of property columnKey

Returns:

true if the columnKey property is set.

unsetColumnKey

void unsetColumnKey()

Unsets the columnKey property, the value of the property of the object being set to the property's default value. The property will no longer be considered set.

Property Definition: See getColumnKey or setColumnKey(...) for a definition of property columnKey

getColumnKey

String getColumnKey()

Returns the value of the columnKey property.

Property Definition: Default value for the column

Returns:

the value of the columnKey property.

setColumnKey

void setColumnKey(String value)

Sets the value of the columnKey property to the given value.

Property Definition: Default value for the column

Enumeration Constraints:

     name: ColumnKeyType
     URI:http://org.plasma/sdo/mysql/5_5

isSetCharacterSetName

boolean isSetCharacterSetName()

Returns true if the characterSetName property is set.

Property Definition: See getCharacterSetName or setCharacterSetName(...) for a definition of property characterSetName

Returns:

true if the characterSetName property is set.

unsetCharacterSetName

void unsetCharacterSetName()

Unsets the characterSetName property, the value of the property of the object being set to the property's default value. The property will no longer be considered set.

Property Definition: See getCharacterSetName or setCharacterSetName(...) for a definition of property characterSetName

getCharacterSetName

String getCharacterSetName()

Returns the value of the characterSetName property.

Property Definition: Name of the character set: CHAR_CS or NCHAR_CS

Returns:

the value of the characterSetName property.

setCharacterSetName

void setCharacterSetName(String value)

Sets the value of the characterSetName property to the given value.

Property Definition: Name of the character set: CHAR_CS or NCHAR_CS

isSetOwner

boolean isSetOwner()

Returns true if the owner property is set.

Property Definition: See getOwner or setOwner(...) for a definition of property owner

Returns:

true if the owner property is set.

unsetOwner

void unsetOwner()

Unsets the owner property, the value of the property of the object being set to the property's default value. The property will no longer be considered set.

Property Definition: See getOwner or setOwner(...) for a definition of property owner

getOwner

String getOwner()

Returns the value of the owner property.

Property Definition: Owner of the table, view, or cluster

Returns:

the value of the owner property.

setOwner

void setOwner(String value)

Sets the value of the owner property to the given value.

Property Definition: Owner of the table, view, or cluster

isSetColumnComment

boolean isSetColumnComment()

Returns true if the columnComment property is set.

Returns:

true if the columnComment property is set.

unsetColumnComment

void unsetColumnComment()

Unsets the columnComment property, the value of the property of the object being set to the property's default value. The property will no longer be considered set.

getColumnComment

String getColumnComment()

Returns the value of the columnComment property.

Returns:

the value of the columnComment property.

setColumnComment

void setColumnComment(String value)

Sets the value of the columnComment property to the given value.

isSetTable

boolean isSetTable()

Returns true if the table property is set.

Returns:

true if the table property is set.

unsetTable

void unsetTable()

Unsets the table property, the value of the property of the object being set to the property's default value. The property will no longer be considered set.

createTable

Table createTable()

Creates and returns a new instance of Type Table automatically establishing a containment relationship through the object's reference property, table.

Returns:

a new instance of Type Table automatically establishing a containment relationship through the object's reference property table.

getTable

Table getTable()

Returns the value of the table property.

Returns:

the value of the table property.

setTable

void setTable(Table value)

Sets the value of the table property to the given value.

isSetColumnType

boolean isSetColumnType()

Returns true if the columnType property is set.

Returns:

true if the columnType property is set.

unsetColumnType

void unsetColumnType()

Unsets the columnType property, the value of the property of the object being set to the property's default value. The property will no longer be considered set.

getColumnType

String getColumnType()

Returns the value of the columnType property.

Returns:

the value of the columnType property.

setColumnType

void setColumnType(String value)

Sets the value of the columnType property to the given value.

isSetOctetMaxLength

boolean isSetOctetMaxLength()

Returns true if the octetMaxLength property is set.

Property Definition: See getOctetMaxLength or setOctetMaxLength(...) for a definition of property octetMaxLength

Returns:

true if the octetMaxLength property is set.

unsetOctetMaxLength

void unsetOctetMaxLength()

Unsets the octetMaxLength property, the value of the property of the object being set to the property's default value. The property will no longer be considered set.

Property Definition: See getOctetMaxLength or setOctetMaxLength(...) for a definition of property octetMaxLength

getOctetMaxLength

int getOctetMaxLength()

Returns the value of the octetMaxLength property.

Property Definition: Length of the column (in bytes)

Returns:

the value of the octetMaxLength property.

setOctetMaxLength

void setOctetMaxLength(int value)

Sets the value of the octetMaxLength property to the given value.

Property Definition: Length of the column (in bytes)