dk.eobjects.metamodel.schema
Class Column

java.lang.Object
  dk.eobjects.metamodel.schema.Column

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Column>

Direct Known Subclasses:

JdbcColumn

public class Column
extends java.lang.Object
implements java.io.Serializable, java.lang.Comparable<Column>

Represents a column and it's metadata description. Columns reside within a Table and can be used as keys for relationships between tables.

See Also:

Table, Relationship, Serialized Form

Constructor Summary

Column()

Column(java.lang.String name)

Column(java.lang.String name, ColumnType type)

Column(java.lang.String name, ColumnType type, Table table, int columnNumber, java.lang.Boolean nullable)

Method Summary

int	compareTo(Column that)
boolean	equals(java.lang.Object obj)
protected void	fireTableChanged() Tells the column object that the table it belongs to have changed.
int	getColumnNumber() Returns the column number or index.
java.lang.Integer	getColumnSize()
java.lang.String	getName() Returns the Column Name
java.lang.String	getNativeType()
java.lang.String	getQualifiedLabel() Gets a label with a simple dot-separated qualified name such as "MY_SCHEMA.MY_TABLE.MY_COLUMN".
java.lang.String	getQuote()
java.lang.String	getQuotedName()
java.lang.String	getRemarks()
Table	getTable() Gets the table for which this column belong
ColumnType	getType() Gets the type of the column
int	hashCode()
boolean	isIndexed()
java.lang.Boolean	isNullable()
Column	setColumnNumber(int columnNumber)
Column	setColumnSize(java.lang.Integer columnSize)
Column	setIndexed(boolean indexed)
Column	setName(java.lang.String name)
Column	setNativeType(java.lang.String nativeType)
Column	setNullable(java.lang.Boolean nullable)
Column	setQuote(java.lang.String quoteString)
void	setRemarks(java.lang.String remarks)
Column	setTable(Table table)
Column	setType(ColumnType type)
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Column

public Column()

Column

public Column(java.lang.String name)

Column

public Column(java.lang.String name,
              ColumnType type)

Column

public Column(java.lang.String name,
              ColumnType type,
              Table table,
              int columnNumber,
              java.lang.Boolean nullable)

Method Detail

getColumnNumber

public int getColumnNumber()

Returns the column number or index. Note: This column number is 0-based whereas the JDBC is 1-based.

setColumnNumber

public Column setColumnNumber(int columnNumber)

getName

public java.lang.String getName()

Returns the Column Name

getQualifiedLabel

public java.lang.String getQualifiedLabel()

Gets a label with a simple dot-separated qualified name such as "MY_SCHEMA.MY_TABLE.MY_COLUMN". The qualified label can be used as a unique identifier for the column but is not necessarily directly transferable to SQL syntax.

Returns:

a qualified label

setName

public Column setName(java.lang.String name)

getType

public ColumnType getType()

Gets the type of the column

setType

public Column setType(ColumnType type)

getTable

public Table getTable()

Gets the table for which this column belong

setTable

public Column setTable(Table table)

isNullable

public java.lang.Boolean isNullable()

setNullable

public Column setNullable(java.lang.Boolean nullable)

getRemarks

public java.lang.String getRemarks()

setRemarks

public void setRemarks(java.lang.String remarks)

getColumnSize

public java.lang.Integer getColumnSize()

setColumnSize

public Column setColumnSize(java.lang.Integer columnSize)

getNativeType

public java.lang.String getNativeType()

setNativeType

public Column setNativeType(java.lang.String nativeType)

isIndexed

public boolean isIndexed()

setIndexed

public Column setIndexed(boolean indexed)

getQuote

public java.lang.String getQuote()

setQuote

public Column setQuote(java.lang.String quoteString)

getQuotedName

public java.lang.String getQuotedName()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

compareTo

public int compareTo(Column that)

Specified by:

compareTo in interface java.lang.Comparable<Column>

fireTableChanged

protected void fireTableChanged()

Tells the column object that the table it belongs to have changed. This is typically done if the table is being renamed or similar.