Top Description Fields Constructors Methods
org.hsqldb

public Class ColumnSchema

extends ColumnBase
implements SchemaObject
Class Inheritance
All Implemented Interfaces
org.hsqldb.SchemaObject
Imports
org.hsqldb.HsqlNameManager.HsqlName, .RangeGroup.RangeGroupSimple, org.hsqldb.error.Error, .ErrorCode, org.hsqldb.lib.Iterator, .OrderedHashSet, org.hsqldb.rights.Grantee, org.hsqldb.types.Type, .Types

Implementation of SQL table column metadata.

Author
Fred Toussi (fredt@users dot sourceforge.net)
Since
1.9.0
Version
2.7.3

Field Summary

Modifier and TypeField and Description
private Expression
private HsqlNameManager.HsqlName
private Expression
public static final ColumnSchema[]
private OrderedHashSet<HsqlNameManager.HsqlName>
private Expression
private boolean
private OrderedHashSet<HsqlNameManager.HsqlName>
private NumberSequence
private int
private Expression
Inherited from org.hsqldb.ColumnBase:
dataTypeisIdentityisWriteablenullabilityparameterMode

Constructor Summary

AccessConstructor and Description
pack-priv
public
ColumnSchema(HsqlNameManager.HsqlName name, Type type, boolean isNullable, boolean isPrimaryKey, Expression defaultExpression)

Creates a column defined in DDL statement.

Method Summary

Modifier and TypeMethod and Description
public void
compile(Session session, SchemaObject table)

Overrides default org.hsqldb.SchemaObject.compile.

public ColumnSchema
public Expression
public HsqlNameManager.HsqlName
public String
public long
pack-priv Expression
getDefaultExpression()

Returns default expression for the column.

public String
getDefaultSQL()

Returns SQL for default value.

public Object
getDefaultValue(Session session)

Returns default value in the session context.

public OrderedHashSet<HsqlNameManager.HsqlName>
public Object
getGeneratedValue(Session session)

Returns generated value in the session context.

public Expression
getGeneratingExpression()

Returns generated expression for the column.

public NumberSequence
public HsqlNameManager.HsqlName
public String
public byte
public Grantee
public OrderedHashSet<HsqlNameManager.HsqlName>
public HsqlNameManager.HsqlName
public String
public String
public int
getSystemPeriodType()

Returns system period type of the column.

public String
public int
public Expression
public boolean
public boolean
public boolean
public boolean

Returns:

boolean
isNullable
()

Overrides org.hsqldb.ColumnBase.isNullable.

Is column nullable.

public boolean

Returns:

boolean
isPrimaryKey
()

Is this single column primary key of the table.

public boolean
public boolean
public boolean

Returns:

boolean
isWriteable
()

Overrides org.hsqldb.ColumnBase.isWriteable.

Is column writeable or always generated

pack-priv void
pack-priv void
pack-priv void
public void
pack-priv void
setPrimaryKey(boolean value)

Set primary key.

private void
pack-priv void
public void
pack-priv void
public void
setUpdateExpression(Expression updateExpression)

public void
Inherited from org.hsqldb.ColumnBase:
getDataTypegetParameterModeisIdentitysetIdentitysetNullabilitysetNullablesetParameterModesetSearchablesetType

Field Detail

accessorback to summary
private Expression accessor
columnNameback to summary
private HsqlNameManager.HsqlName columnName
defaultExpressionback to summary
private Expression defaultExpression
emptyArrayback to summary
public static final ColumnSchema[] emptyArray

Hides org.hsqldb.SchemaObject.emptyArray.

generatedColumnReferencesback to summary
private OrderedHashSet<HsqlNameManager.HsqlName> generatedColumnReferences
generatingExpressionback to summary
private Expression generatingExpression
isPrimaryKeyback to summary
private boolean isPrimaryKey
referencesback to summary
private OrderedHashSet<HsqlNameManager.HsqlName> references
sequenceback to summary
private NumberSequence sequence
systemPeriodTypeback to summary
private int systemPeriodType
updateExpressionback to summary
private Expression updateExpression

Constructor Detail

ColumnSchemaback to summary
pack-priv ColumnSchema(HsqlNameManager.HsqlName name, Type type)
ColumnSchemaback to summary
public ColumnSchema(HsqlNameManager.HsqlName name, Type type, boolean isNullable, boolean isPrimaryKey, Expression defaultExpression)

Creates a column defined in DDL statement.

Method Detail

compileback to summary
public void compile(Session session, SchemaObject table)

Overrides default org.hsqldb.SchemaObject.compile.

duplicateback to summary
public ColumnSchema duplicate()
getAccessorback to summary
public Expression getAccessor()
getCatalogNameback to summary
public HsqlNameManager.HsqlName getCatalogName()

Implements org.hsqldb.SchemaObject.getCatalogName.

getCatalogNameStringback to summary
public String getCatalogNameString()

Overrides org.hsqldb.ColumnBase.getCatalogNameString.

getChangeTimestampback to summary
public long getChangeTimestamp()

Implements org.hsqldb.SchemaObject.getChangeTimestamp.

getDefaultExpressionback to summary
pack-priv Expression getDefaultExpression()

Returns default expression for the column.

getDefaultSQLback to summary
public String getDefaultSQL()

Returns SQL for default value.

getDefaultValueback to summary
public Object getDefaultValue(Session session)

Returns default value in the session context.

getGeneratedColumnReferencesback to summary
public OrderedHashSet<HsqlNameManager.HsqlName> getGeneratedColumnReferences()
getGeneratedValueback to summary
public Object getGeneratedValue(Session session)

Returns generated value in the session context.

getGeneratingExpressionback to summary
public Expression getGeneratingExpression()

Returns generated expression for the column.

getIdentitySequenceback to summary
public NumberSequence getIdentitySequence()
getNameback to summary
public HsqlNameManager.HsqlName getName()

Implements org.hsqldb.SchemaObject.getName.

getNameStringback to summary
public String getNameString()

Overrides org.hsqldb.ColumnBase.getNameString.

getNullabilityback to summary
public byte getNullability()

Overrides org.hsqldb.ColumnBase.getNullability.

getOwnerback to summary
public Grantee getOwner()

Implements org.hsqldb.SchemaObject.getOwner.

getReferencesback to summary
public OrderedHashSet<HsqlNameManager.HsqlName> getReferences()

Overrides default org.hsqldb.SchemaObject.getReferences.

getSchemaNameback to summary
public HsqlNameManager.HsqlName getSchemaName()

Implements org.hsqldb.SchemaObject.getSchemaName.

getSchemaNameStringback to summary
public String getSchemaNameString()

Overrides org.hsqldb.ColumnBase.getSchemaNameString.

getSQLback to summary
public String getSQL()

Implements org.hsqldb.SchemaObject.getSQL.

getSystemPeriodTypeback to summary
public int getSystemPeriodType()

Returns system period type of the column.

getTableNameStringback to summary
public String getTableNameString()

Overrides org.hsqldb.ColumnBase.getTableNameString.

getTypeback to summary
public int getType()

Implements org.hsqldb.SchemaObject.getType.

getUpdateExpressionback to summary
public Expression getUpdateExpression()
hasDefaultback to summary
public boolean hasDefault()
isAutoUpdateback to summary
public boolean isAutoUpdate()
isGeneratedback to summary
public boolean isGenerated()
isNullableback to summary
public boolean isNullable()

Overrides org.hsqldb.ColumnBase.isNullable.

Is column nullable.

Returns:boolean

boolean

isPrimaryKeyback to summary
public boolean isPrimaryKey()

Is this single column primary key of the table.

Returns:boolean

boolean

isSearchableback to summary
public boolean isSearchable()

Overrides org.hsqldb.ColumnBase.isSearchable.

isSystemPeriodback to summary
public boolean isSystemPeriod()
isWriteableback to summary
public boolean isWriteable()

Overrides org.hsqldb.ColumnBase.isWriteable.

Is column writeable or always generated

Returns:boolean

boolean

setDefaultExpressionback to summary
pack-priv void setDefaultExpression(Expression expr)
setGeneratingExpressionback to summary
pack-priv void setGeneratingExpression(Expression expr)
setIdentityback to summary
pack-priv void setIdentity(NumberSequence sequence)
setNameback to summary
public void setName(HsqlNameManager.HsqlName name)
setPrimaryKeyback to summary
pack-priv void setPrimaryKey(boolean value)

Set primary key.

setReferencesback to summary
private void setReferences()
setSystemPeriodTypeback to summary
pack-priv void setSystemPeriodType(int type)
setTypeback to summary
public void setType(Type type)

Overrides org.hsqldb.ColumnBase.setType.

setTypeback to summary
pack-priv void setType(ColumnSchema other)
setUpdateExpressionback to summary
public void setUpdateExpression(Expression updateExpression)
setWriteableback to summary
public void setWriteable(boolean value)

Overrides org.hsqldb.ColumnBase.setWriteable.