Top Description Fields Constructors Methods
org.apache.derby.impl.sql.execute

public Class ColumnInfo

extends Object
implements Formatable
Class Inheritance
All Implemented Interfaces
org.apache.derby.iapi.services.io.Formatable, org.apache.derby.iapi.services.io.TypedFormat, java.io.Externalizable, java.io.Serializable
Imports
org.apache.derby.shared.common.util.ArrayUtil, org.apache.derby.iapi.services.io.Formatable, .StoredFormatIds, .FormatableArrayHolder, .FormatableHashtable, .FormatableLongHolder, org.apache.derby.iapi.types.DataTypeDescriptor, .DataValueDescriptor, org.apache.derby.iapi.sql.depend.ProviderInfo, org.apache.derby.shared.common.sanity.SanityManager, org.apache.derby.catalog.DefaultInfo, .UUID, java.io.ObjectOutput, .ObjectInput, .IOException

This is the Column descriptor that is passed from Compilation to Execution for CREATE TABLE statements.
Version
0.1

Field Summary

Modifier and TypeField and Description
pack-priv int
action

This class implements Formatable.

pack-priv long
pack-priv boolean
pack-priv long
pack-priv long
public static final int
pack-priv DataTypeDescriptor
pack-priv DefaultInfo
pack-priv DataValueDescriptor
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
pack-priv String
pack-priv UUID
pack-priv UUID
pack-priv ProviderInfo[]

Constructor Summary

AccessConstructor and Description
public
ColumnInfo()

Public niladic constructor.

public
ColumnInfo(String
Column name.
name
,
DataTypeDescriptor
Column type.
dataType
,
DataValueDescriptor
Column default value.
defaultValue
,
DefaultInfo
Column default info.
defaultInfo
,
ProviderInfo[]
Array of providers that this column depends on.
providers
,
UUID
New UUID for default.
newDefaultUUID
,
UUID
Old UUID for default.
oldDefaultUUID
,
int
Action (create, modify default, etc.)
action
,
long
Start of autoincrement values.
autoincStart
,
long
Increment of autoincrement values-- if parameter is 0, it implies that this is not an autoincrement value.
autoincInc
,
boolean autoincCycle, long autoinc_create_or_modify_Start_Increment)

Make one of these puppies.

Method Summary

Modifier and TypeMethod and Description
public DataTypeDescriptor
public int

Returns:

the formatID of this class
getTypeFormatId
()

Implements org.apache.derby.iapi.services.io.TypedFormat.getTypeFormatId.

Get the formatID which corresponds to this class.

public void
readExternal(ObjectInput
read this.
in
)

Implements java.io.Externalizable.readExternal.

Read this object from a stream of stored objects.

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

public void
writeExternal(ObjectOutput
write bytes here.
out
)

Implements java.io.Externalizable.writeExternal.

Write this object to a stream of stored objects.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAllwaitwaitwait

Field Detail

actionback to summary
pack-priv int action

This class implements Formatable. That means that it can write itself to and from a formatted stream. If you add more fields to this class, make sure that you also write/read them with the writeExternal()/readExternal() methods. If, inbetween releases, you add more fields to this class, then you should bump the version number emitted by the getTypeFormatId() method.

autoinc_create_or_modify_Start_Incrementback to summary
pack-priv long autoinc_create_or_modify_Start_Increment
autoincCycleback to summary
pack-priv boolean autoincCycle
autoincIncback to summary
pack-priv long autoincInc
autoincStartback to summary
pack-priv long autoincStart
CREATEback to summary
public static final int CREATE
dataTypeback to summary
pack-priv DataTypeDescriptor dataType
defaultInfoback to summary
pack-priv DefaultInfo defaultInfo
defaultValueback to summary
pack-priv DataValueDescriptor defaultValue
DROPback to summary
public static final int DROP
MODIFY_COLUMN_CONSTRAINTback to summary
public static final int MODIFY_COLUMN_CONSTRAINT
MODIFY_COLUMN_CONSTRAINT_NOT_NULLback to summary
public static final int MODIFY_COLUMN_CONSTRAINT_NOT_NULL
MODIFY_COLUMN_DEFAULT_CYCLEback to summary
public static final int MODIFY_COLUMN_DEFAULT_CYCLE
MODIFY_COLUMN_DEFAULT_INCREMENTback to summary
public static final int MODIFY_COLUMN_DEFAULT_INCREMENT
MODIFY_COLUMN_DEFAULT_RESTARTback to summary
public static final int MODIFY_COLUMN_DEFAULT_RESTART
MODIFY_COLUMN_DEFAULT_VALUEback to summary
public static final int MODIFY_COLUMN_DEFAULT_VALUE
MODIFY_COLUMN_GENERATED_ALWAYSback to summary
public static final int MODIFY_COLUMN_GENERATED_ALWAYS
MODIFY_COLUMN_GENERATED_BY_DEFAULTback to summary
public static final int MODIFY_COLUMN_GENERATED_BY_DEFAULT
MODIFY_COLUMN_TYPEback to summary
public static final int MODIFY_COLUMN_TYPE
nameback to summary
pack-priv String name
newDefaultUUIDback to summary
pack-priv UUID newDefaultUUID
oldDefaultUUIDback to summary
pack-priv UUID oldDefaultUUID
providersback to summary
pack-priv ProviderInfo[] providers

Constructor Detail

ColumnInfoback to summary
public ColumnInfo()

Public niladic constructor. Needed for Formatable interface to work.

ColumnInfoback to summary
public ColumnInfo(String name, DataTypeDescriptor dataType, DataValueDescriptor defaultValue, DefaultInfo defaultInfo, ProviderInfo[] providers, UUID newDefaultUUID, UUID oldDefaultUUID, int action, long autoincStart, long autoincInc, boolean autoincCycle, long autoinc_create_or_modify_Start_Increment)

Make one of these puppies.

Parameters
name:String

Column name.

dataType:DataTypeDescriptor

Column type.

defaultValue:DataValueDescriptor

Column default value.

defaultInfo:DefaultInfo

Column default info.

providers:ProviderInfo[]

Array of providers that this column depends on.

newDefaultUUID:UUID

New UUID for default.

oldDefaultUUID:UUID

Old UUID for default.

action:int

Action (create, modify default, etc.)

autoincStart:long

Start of autoincrement values.

autoincInc:long

Increment of autoincrement values-- if parameter is 0, it implies that this is not an autoincrement value.

Method Detail

getDataTypeback to summary
public DataTypeDescriptor getDataType()
getTypeFormatIdback to summary
public int getTypeFormatId()

Implements org.apache.derby.iapi.services.io.TypedFormat.getTypeFormatId.

Get the formatID which corresponds to this class.

Returns:int

the formatID of this class

readExternalback to summary
public void readExternal(ObjectInput in) throws IOException, ClassNotFoundException

Implements java.io.Externalizable.readExternal.

Read this object from a stream of stored objects.

Parameters
in:ObjectInput

read this.

Exceptions
IOException:
thrown on error
ClassNotFoundException:
thrown on error
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

writeExternalback to summary
public void writeExternal(ObjectOutput out) throws IOException

Implements java.io.Externalizable.writeExternal.

Write this object to a stream of stored objects.

Parameters
out:ObjectOutput

write bytes here.

Exceptions
IOException:
thrown on error