org.hsqldb

Class ColumnSchema

java.lang.Object

org.hsqldb.ColumnBase

org.hsqldb.ColumnSchema

All Implemented Interfaces:

SchemaObject

public final class ColumnSchema
extends ColumnBase
implements SchemaObject

Implementation of SQL table column metadata.

Since:

1.9.0

Nested Class Summary

Nested classes/interfaces inherited from interface org.hsqldb.SchemaObject

SchemaObject.ConstraintTypes, SchemaObject.Deferable, SchemaObject.Nullability, SchemaObject.ParameterModes, SchemaObject.ReferentialAction, SchemaObject.ViewCheckModes

Field Summary

Fields

Modifier and Type	Field and Description
static ColumnSchema[]	emptyArray

Fields inherited from interface org.hsqldb.SchemaObject

ASSERTION, CATALOG, CHARSET, COLLATION, COLUMN, CONSTRAINT, CURSOR, DOMAIN, FUNCTION, GRANTEE, INDEX, LABEL, PARAMETER, PROCEDURE, ROUTINE, SCHEMA, SEARCH, SEQUENCE, SERVER, SPECIFIC_ROUTINE, SUBQUERY, TABLE, TRANSITION, TRIGGER, TYPE, VARIABLE, VIEW, WRAPPER

Constructor Summary

Constructors

Constructor and Description
ColumnSchema(HsqlNameManager.HsqlName name, Type type, boolean isNullable, boolean isPrimaryKey, Expression defaultExpression) Creates a column defined in DDL statement.

Method Summary

Modifier and Type	Method and Description
void	compile(Session session, SchemaObject table)
ColumnSchema	duplicate()
Expression	getAccessor()
HsqlNameManager.HsqlName	getCatalogName()
java.lang.String	getCatalogNameString()
long	getChangeTimestamp()
OrderedHashSet	getComponents()
java.lang.String	getDefaultSQL() Returns SQL for default value.
java.lang.Object	getDefaultValue(Session session) Returns default value in the session context.
OrderedHashSet	getGeneratedColumnReferences()
java.lang.Object	getGeneratedValue(Session session) Returns generated value in the session context.
Expression	getGeneratingExpression() Returns generated expression for the column.
NumberSequence	getIdentitySequence()
HsqlNameManager.HsqlName	getName()
java.lang.String	getNameString()
byte	getNullability()
Grantee	getOwner()
OrderedHashSet	getReferences()
HsqlNameManager.HsqlName	getSchemaName()
java.lang.String	getSchemaNameString()
java.lang.String	getSQL()
java.lang.String	getTableNameString()
int	getType()
boolean	hasDefault()
boolean	isGenerated()
boolean	isNullable() Is column nullable.
boolean	isPrimaryKey() Is this single column primary key of the table.
boolean	isSearchable()
boolean	isWriteable() Is column writeable or always generated
void	setName(HsqlNameManager.HsqlName name)
void	setType(Type type)
void	setWriteable(boolean value)

Methods inherited from class org.hsqldb.ColumnBase

getDataType, getParameterMode, isIdentity, setIdentity, setNullability, setParameterMode, setSearchable

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

emptyArray

public static final ColumnSchema[] emptyArray

Constructor Detail

ColumnSchema

public ColumnSchema(HsqlNameManager.HsqlName name,
                    Type type,
                    boolean isNullable,
                    boolean isPrimaryKey,
                    Expression defaultExpression)

Creates a column defined in DDL statement.

Method Detail

getType

public int getType()

Specified by:

getType in interface SchemaObject

getName

public HsqlNameManager.HsqlName getName()

Specified by:

getName in interface SchemaObject

getNameString

public java.lang.String getNameString()

Overrides:

getNameString in class ColumnBase

getTableNameString

public java.lang.String getTableNameString()

Overrides:

getTableNameString in class ColumnBase

getSchemaName

public HsqlNameManager.HsqlName getSchemaName()

Specified by:

getSchemaName in interface SchemaObject

getSchemaNameString

public java.lang.String getSchemaNameString()

Overrides:

getSchemaNameString in class ColumnBase

getCatalogName

public HsqlNameManager.HsqlName getCatalogName()

Specified by:

getCatalogName in interface SchemaObject

getCatalogNameString

public java.lang.String getCatalogNameString()

Overrides:

getCatalogNameString in class ColumnBase

getOwner

public Grantee getOwner()

Specified by:

getOwner in interface SchemaObject

getReferences

public OrderedHashSet getReferences()

Specified by:

getReferences in interface SchemaObject

getComponents

public OrderedHashSet getComponents()

Specified by:

getComponents in interface SchemaObject

compile

public void compile(Session session,
                    SchemaObject table)

Specified by:

compile in interface SchemaObject

getSQL

public java.lang.String getSQL()

Specified by:

getSQL in interface SchemaObject

getChangeTimestamp

public long getChangeTimestamp()

Specified by:

getChangeTimestamp in interface SchemaObject

setType

public void setType(Type type)

Overrides:

setType in class ColumnBase

setName

public void setName(HsqlNameManager.HsqlName name)

getIdentitySequence

public NumberSequence getIdentitySequence()

isNullable

public boolean isNullable()

Is column nullable.

Overrides:

isNullable in class ColumnBase

Returns:

boolean

getNullability

public byte getNullability()

Overrides:

getNullability in class ColumnBase

isGenerated

public boolean isGenerated()

hasDefault

public boolean hasDefault()

isWriteable

public boolean isWriteable()

Is column writeable or always generated

Overrides:

isWriteable in class ColumnBase

Returns:

boolean

setWriteable

public void setWriteable(boolean value)

Overrides:

setWriteable in class ColumnBase

isSearchable

public boolean isSearchable()

Overrides:

isSearchable in class ColumnBase

isPrimaryKey

public boolean isPrimaryKey()

Is this single column primary key of the table.

Returns:

boolean

getDefaultValue

public java.lang.Object getDefaultValue(Session session)

Returns default value in the session context.

getGeneratedValue

public java.lang.Object getGeneratedValue(Session session)

Returns generated value in the session context.

getDefaultSQL

public java.lang.String getDefaultSQL()

Returns SQL for default value.

getGeneratingExpression

public Expression getGeneratingExpression()

Returns generated expression for the column.

duplicate

public ColumnSchema duplicate()

getAccessor

public Expression getAccessor()

getGeneratedColumnReferences

public OrderedHashSet getGeneratedColumnReferences()