Top Description Fields
org.apache.derby.iapi.services.io

public Interface StoredFormatIds


A format id identifies a stored form of an object for the purposes of locating a class which can read the stored form and reconstruct the object using the java.io.Externalizable interface.

An important aspect of the format id concept is that it does not impose an implementation on the stored object. Rather, multiple implementations of an object (or interface) may share a format id. One implementation may store (write) an object and another may restore (read) the object. The implication of this is that a format id specifies the following properties of a stored object.

An object should implement the Formatable interface to support a stored format. In addition, the module which contains the object should register the object's class with the Monitor (See FormatIdUtil.register.)

When you add a format id to this file, please include the list of interfaces an implementation must support when it supports the format id. When Derby code reads a stored form it returns an object of a Class which supports the stored form. A reader may cast this object to any interface listed in this file. It is an error for the reader to cast the object to a class or interface not listed in this file.

When you implement a class that supports a format, add a comment that states the name of the class. The first implementation of a format defines the stored form.

This interface defines all the format ids for Derby. If you define a format id please be sure to declare it in this file. If you remove support for a one please document that the format id is deprecated. Never remove or re-use a format id.

Field Summary

Modifier and TypeField and Description
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
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
public static final int
public static final int
ACCESS_U8_V1_ID

Access ids.

public static final int
AGG_AVG_V01_ID

class org.apache.derby.Database.Language.Execution.AvgAggregator

public static final int
AGG_COUNT_STAR_V01_ID

class org.apache.derby.Database.Language.Execution.CountStarAggregator

public static final int
AGG_COUNT_V01_ID

class org.apache.derby.Database.Language.Execution.CountAggregator

public static final int
AGG_INFO_LIST_V01_ID

class org.apache.derby.Database.Language.Execution.AggregateInfoList

public static final int
AGG_INFO_V01_ID

class org.apache.derby.Database.Language.Execution.AggregateInfo

public static final int
AGG_MAX_MIN_V01_ID

class org.apache.derby.Database.Language.Execution.MaxMinAggregator

public static final int
AGG_MIN_V01_ID

class org.apache.derby.Database.Language.Execution.MinAggregator

public static final int
AGG_SUM_V01_ID

class org.apache.derby.Database.Language.Execution.SumAggregator

public static final int
AGG_USER_ADAPTOR_V01_ID

class org.apache.derby.Database.Language.Execution.UserAggregatorAggregator

public static final int
public static final int
ALIAS_DESCRIPTOR_FINDER_V01_ID

class org.apache.derby.impl.sql.catalog.AliasDescriptorFinder

public static final int
ALTER_SPS_CONSTANT_ACTION_V01_ID

class org.apache.derby.Database.Language.Execution.AlterSPSConstantAction

public static final int
BASIC_UUID

identifiers

public static final int
BIGINT_TYPE_ID

class org.apache.derby.iapi.types.LongintTypeId

public static final int
BIGINT_TYPE_ID_IMPL

class org.apache.derby.catalog.types.LongintTypeIdImpl

public static final int
BIT_COMPILATION_TYPE_ID

class org.apache.derby.iapi.types.BitTypeId

public static final int
BIT_TYPE_ID

class org.apache.derby.iapi.types.BitTypeId

public static final int
BIT_TYPE_ID_IMPL

class org.apache.derby.catalog.types.BitTypeIdImpl

public static final int
BITIMPL_V01_ID

class org.apache.derby.iapi.services.io.FormatableBitSet

public static final int
BLOB_COMPILATION_TYPE_ID

class org.apache.derby.iapi.types.LongvarbitTypeId - XXXX does not exist!!!

public static final int
BLOB_TYPE_ID

class org.apache.derby.iapi.types.LongvarbitTypeId - XXXX does not exist!!!

public static final int
BLOB_TYPE_ID_IMPL

class org.apache.derby.catalog.types.LongvarbitTypeIdImpl - does not exist, but we do it the same way for BLOB as for Longvarbit...

public static final int
BOOLEAN_COMPILATION_TYPE_ID

class org.apache.derby.iapi.types.BooleanTypeId

public static final int
BOOLEAN_TYPE_ID

class org.apache.derby.iapi.types.BooleanTypeId

public static final int
BOOLEAN_TYPE_ID_IMPL

class org.apache.derby.catalog.types.BooleanTypeIdImpl

public static final int
CHAR_COMPILATION_TYPE_ID

class org.apache.derby.iapi.types.CharTypeId

public static final int
CHAR_TYPE_ID

class org.apache.derby.iapi.types.CharTypeId

public static final int
CHAR_TYPE_ID_IMPL

class org.apache.derby.catalog.types.CharTypeIdImpl

public static final int
CLASS_ALIAS_INFO_V01_ID

class org.apache.derby.catalog.types.ClassAliasInfo

public static final int
CLOB_COMPILATION_TYPE_ID

class org.apache.derby.iapi.types.LongvarcharTypeId

public static final int
CLOB_TYPE_ID

class org.apache.derby.iapi.types.LongvarcharTypeId

public static final int
CLOB_TYPE_ID_IMPL

class org.apache.derby.catalog.types.LongvarcharTypeIdImpl

public static final int
COLUMN_DESCRIPTOR_FINDER_V01_ID

class org.apache.derby.impl.sql.catalog.ColumnDescriptorFinder

public static final int
COLUMN_INFO_V02_ID

class org.apache.derby.impl.sql.execute.ColumnInfo

public static final int
COLUMNS_PERMISSION_FINDER_V01_ID

class org.apache.derby.impl.sql.catalog.CoreDDFinderClassInfo

public static final int
CONGLOMERATE_DESCRIPTOR_FINDER_V01_ID

class org.apache.derby.impl.sql.catalog.ConglomerateDescriptorFinder

public static final int
CONSTRAINT_DESCRIPTOR_FINDER_V01_ID

class org.apache.derby.impl.sql.catalog.ConstraintDescriptorFinder

public static final int
CONSTRAINT_INFO_V01_ID

class org.apache.derby.Database.Language.Execution.ConstraintInfo

public static final int
CURSOR_INFO_V01_ID

class org.apache.derby.impl.sql.CursorInfo

public static final int
CURSOR_TABLE_REFERENCE_V01_ID

class org.apache.derby.impl.sql.CursorTableReference

public static final int
DATA_DICTIONARY_DESCRIPTOR_FINDER_V01_ID

class org.apache.derby.impl.sql.catalog.DataDictionaryDescriptorFinder

public static final int
DATA_TYPE_DESCRIPTOR_V02_ID

DataTypeDescriptor (runtime type) new format from 10.4 onwards that reflects the change in role from is a TypeDescriptor to has a TypeDescriptor.

public static final int
DATA_TYPE_IMPL_DESCRIPTOR_V01_ID

class org.apache.derby.catalog.types.TypeDescriptorImpl

public static final int
DATA_TYPE_SERVICES_IMPL_V01_ID

In releases prior to 10.3 this format was produced by DataTypeDescriptor.

public static final int
DATE_TYPE_ID

class org.apache.derby.iapi.types.DateTypeId

public static final int
DATE_TYPE_ID_IMPL

class org.apache.derby.catalog.types.TypesImplInstanceGetter

public static final int
DD_ARISTOTLE_VERSION_ID

class org.apache.derby.impl.sql.catalog.DD_AristotleVersion

public static final int
DD_ARWEN_VERSION_ID

class org.apache.derby.impl.sql.catalog.DD_Version now mapped to a single class DD_Version.

public static final int
DD_BUFFY_VERSION_ID

class org.apache.derby.impl.sql.catalog.DD_BuffyVersion

public static final int
DD_DB2J72_VERSION_ID

class org.apache.derby.impl.sql.catalog.DD_DB2J72 now mapped to a single class DD_Version.

public static final int
DD_IVANOVA_VERSION_ID

class org.apache.derby.impl.sql.catalog.DD_IvanovaVersion

public static final int
DD_MULAN_VERSION_ID

class org.apache.derby.impl.sql.catalog.DD_MulanVersion

public static final int
DD_PLATO_VERSION_ID

class org.apache.derby.impl.sql.catalog.DD_PlatoVersion

public static final int
DD_SOCRATES_VERSION_ID

class org.apache.derby.impl.sql.catalog.DD_SocratesVersion

public static final int
DD_XENA_VERSION_ID

class org.apache.derby.impl.sql.catalog.DD_XenaVersion

public static final int
DECIMAL_COMPILATION_TYPE_ID

class org.apache.derby.iapi.types.DecimalTypeId

public static final int
DECIMAL_TYPE_ID

class org.apache.derby.iapi.types.DecimalTypeId

public static final int
DECIMAL_TYPE_ID_IMPL

class org.apache.derby.catalog.types.DecimalTypeIdImpl

public static final int
DEFAULT_DESCRIPTOR_FINDER_V01_ID

class org.apache.derby.impl.sql.catalog.DefaultDescriptorFinder

public static final int
DEFAULT_INFO_IMPL_V01_ID

class org.apache.derby.catalog.types.DefaultInfoImpl

public static final int
DELETE_CONSTANT_ACTION_V01_ID

class org.apache.derby.Database.Language.Execution.DeleteConstantAction

public static final int
DOUBLE_COMPILATION_TYPE_ID

class org.apache.derby.iapi.types.DoubleTypeId

public static final int
DOUBLE_TYPE_ID

class org.apache.derby.iapi.types.DoubleTypeId

public static final int
DOUBLE_TYPE_ID_IMPL

class org.apache.derby.catalog.types.DoubleTypeIdImpl

public static final int
public static final int
EXEC_ROW_BUILDER_ID

Class org.apache.derby.iapi.sql.execute.ExecRowBuilder.

public static final int
FILE_INFO_FINDER_V01_ID

class org.apache.derby.impl.sql.catalog.FileInfoFinder

public static final int
public static final int
FK_INFO_V01_ID

class org.apache.derby.Database.Language.Execution.FKInfo

public static final int
FORMATABLE_ARRAY_HOLDER_V01_ID

class org.apache.derby.iapi.services.io.FormatableArrayHolder

public static final int
FORMATABLE_HASHTABLE_V01_ID

class org.apache.derby.iapi.services.io.FormatableHashtable

public static final int
FORMATABLE_INT_HOLDER_V01_ID

class org.apache.derby.iapi.services.io.FormatableIntHolder

public static final int
FORMATABLE_LONG_HOLDER_V01_ID

class org.apache.derby.iapi.services.io.FormatableLongHolder

public static final int
FORMATABLE_PROPERTIES_V01_ID

class org.apache.derby.iapi.services.io.FormatableProperties

public static final int
GENERIC_COLUMN_DESCRIPTOR_V02_ID

class org.apache.derby.impl.sql.GenericColumnDescriptor

public static final int
GENERIC_RESULT_DESCRIPTION_V01_ID

class org.apache.derby.impl.sql.GenericResultDescription

public static final int
GENERIC_TYPE_DESCRIPTOR_V01_ID

class org.apache.derby.impl.sql.GenericTypeDescriptor

public static final int
GENERIC_TYPE_ID_V01_ID

class org.apache.derby.impl.sql.GenericTypeId

public static final int
INDEX_COLUMN_ORDER_V01_ID

class org.apache.derby.Database.Language.Execution.IndexColumnOrder

public static final int
INDEX_DESCRIPTOR_IMPL_V02_ID

class org.apache.derby.catalog.types.IndexDescriptorImpl

public static final int
INDEX_ROW_GENERATOR_V01_ID

class org.apache.derby.impl.sql.catalog.IndexRowGeneratorImpl

public static final int
INSERT_CONSTANT_ACTION_V01_ID

class org.apache.derby.Database.Language.Execution.InsertConstantAction

public static final int
INT_COMPILATION_TYPE_ID

class org.apache.derby.iapi.types.IntTypeId

public static final int
INT_TYPE_ID

class org.apache.derby.iapi.types.IntTypeId

public static final int
INT_TYPE_ID_IMPL

class org.apache.derby.catalog.types.IntTypeIdImpl

public static final int
JSQLTYPEIMPL_ID

class org.apache.derby.iapi.types.JSQLType

public static final int
public static final int
LOG_RECORD

Log record

public static final int
public static final int
public static final int
LOGOP_CHAIN_ALLOC_PAGE

Raw Store Log operation Ids

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
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
public static final int
public static final int
LONGINT_COMPILATION_TYPE_ID

class org.apache.derby.iapi.types.LongintTypeId

public static final int
LONGVARBIT_COMPILATION_TYPE_ID

class org.apache.derby.iapi.types.LongvarbitTypeId - XXXX does not exist!!!

public static final int
LONGVARBIT_TYPE_ID

class org.apache.derby.iapi.types.LongvarbitTypeId - XXXX does not exist!!!

public static final int
LONGVARBIT_TYPE_ID_IMPL

class org.apache.derby.catalog.types.LongvarbitTypeIdImpl - does nto exist

public static final int
LONGVARCHAR_COMPILATION_TYPE_ID

class org.apache.derby.iapi.types.LongvarcharTypeId

public static final int
LONGVARCHAR_TYPE_ID

class org.apache.derby.iapi.types.LongvarcharTypeId

public static final int
LONGVARCHAR_TYPE_ID_IMPL

class org.apache.derby.catalog.types.LongvarcharTypeIdImpl

public static final int
MATCHING_CLAUSE_CONSTANT_ACTION_V01_ID

class org.apache.derby.impl.sql.execute.MatchingClauseConstantAction

public static final int
MAX_ID_2

UDPATE MAX_ID_2 WHEN YOU ADD A NEW FORMATABLE

public static final int
public static final int
MAX_TWO_BYTE_FORMAT_ID

Maximum value for a two byte format id.

public static final int
MERGE_CONSTANT_ACTION_V01_ID

class org.apache.derby.impl.sql.execute.MatchingClauseConstantAction

public static final int
METHOD_ALIAS_INFO_V01_ID

class org.apache.derby.catalog.types.MethodAliasInfo

public static final int
public static final int
public static final int
MIN_TWO_BYTE_FORMAT_ID

Minimum value for a two byte format id.

public static final int
NULL_FORMAT_ID

Special format id for any null referance

public static final int
OIDIMPL_V01_ID

|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||| || || DEPRECATED || |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||| class org.apache.derby.impl.sql.catalog.OIDImpl

public static final int
PARAMETER_DESCRIPTOR_V01_ID

class org.apache.derby.impl.sql.catalog.ParameterDescriptorImpl

public static final int
PC_XENA_VERSION_ID

class org.apache.derby.impl.store.access.PropertyConglomerate

public static final int
public static final int
PROVIDER_INFO_V01_ID

class org.apache.derby.Database.Language.Execution.ProviderInfo

public static final int
PROVIDER_INFO_V02_ID

class org.apache.derby.Database.Language.DependencySystem.Generic.ProviderInfo

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
REAL_COMPILATION_TYPE_ID

class org.apache.derby.iapi.types.RealTypeId

public static final int
REAL_TYPE_ID

class org.apache.derby.iapi.types.RealTypeId

public static final int
REAL_TYPE_ID_IMPL

class org.apache.derby.catalog.types.RealTypeIdImpl

public static final int
REF_COMPILATION_TYPE_ID

class org.apache.derby.iapi.types.RefTypeId

public static final int
REF_TYPE_ID

class org.apache.derby.iapi.types.RefTypeId

public static final int
REF_TYPE_ID_IMPL

class org.apache.derby.catalog.types.RefTypeIdImpl

public static final int
REFERENCED_COLUMNS_DESCRIPTOR_IMPL_V01_ID

class org.apache.derby.catalog.types.ReferencedColumnsDescriptorImpl

public static final int
RENAME_CONSTANT_ACTION_V01_ID

class org.apache.derby.Database.Language.Execution.RenameConstantAction

public static final int
REP_SET_TRIGGERS_CONSTANT_ACTION_V01_ID

class org.apache.derby.Replication.Database.Language.Execution.RepSetTriggersConstantAction

public static final int
ROLE_GRANT_FINDER_V01_ID

class org.apache.derby.impl.sql.catalog.CoreDDFinderClassInfo

public static final int
public static final int
ROUTINE_PERMISSION_FINDER_V01_ID

class org.apache.derby.impl.sql.catalog.CoreDDFinderClassInfo

public static final int
ROW_LIST_V01_ID

class org.apache.derby.impl.sql.catalog.RowListImpl

public static final int
public static final int
SAVEPOINT_V01_ID

class org.apache.derby.impl.sql.execute.SavepointConstantAction

public static final int
SCHEMA_DESCRIPTOR_FINDER_V01_ID

class org.apache.derby.impl.sql.catalog.SchemaDescriptorFinder

public static final int
SEQUENCE_DESCRIPTOR_FINDER_V01_ID

class org.apache.derby.impl.sql.catalog.SequenceDescriptorFinder

public static final int
SERIALIZABLE_FORMAT_ID

Special format id for tagging Serializable objects.

public static final int
SET_SCHEMA_CONSTANT_ACTION_V02_ID

class org.apache.derby.Database.Language.Execution.SetSchemaConstantAction

public static final int
SET_TRANSACTION_ISOLATION_CONSTANT_ACTION_V02_ID

class org.apache.derby.Database.Language.Execution.SetTransactionIsolationConstantAction

public static final int
SET_TRIGGERS_CONSTANT_ACTION_V01_ID

class org.apache.derby.Database.Language.Execution.SetTriggersConstantAction

public static final int
SMALLINT_COMPILATION_TYPE_ID

class org.apache.derby.iapi.types.SmallintTypeId

public static final int
SMALLINT_TYPE_ID

class org.apache.derby.iapi.types.SmallintTypeId

public static final int
SMALLINT_TYPE_ID_IMPL

class org.apache.derby.catalog.types.SmallintTypeIdImpl

public static final int
SPS_DESCRIPTOR_FINDER_V01_ID

class org.apache.derby.impl.sql.catalog.SPSDescriptorFinder

public static final int
public static final int
public static final int
SQL_BOOLEAN_ID

Type system id's

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
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
STATISTICS_CONSTANT_ACTION_V01_ID

class org.apache.derby.Database.Language.Execution.StatisticsConstantAction

public static final int
public static final int
STORABLE_PREPARED_STATEMENT_V01_ID

class org.apache.derby.impl.sql.GenericStorablePreparedStatement

public static final int
STRING_FORMAT_ID

Special format id for tagging UTF8 strings

public static final int
public static final int
TABLE_DESCRIPTOR_FINDER_V01_ID

class org.apache.derby.impl.sql.catalog.TableDescriptorFinder

public static final int
TABLE_PERMISSION_FINDER_V01_ID

class org.apache.derby.impl.sql.catalog.CoreDDFinderClassInfo

public static final int
TIME_TYPE_ID

class org.apache.derby.iapi.types.TimeTypeId

public static final int
TIME_TYPE_ID_IMPL

class org.apache.derby.catalog.types.TypesImplInstanceGetter

public static final int
TIMESTAMP_TYPE_ID

class org.apache.derby.iapi.types.TimestampTypeId

public static final int
TIMESTAMP_TYPE_ID_IMPL

class org.apache.derby.catalog.types.TypesImplInstanceGetter

public static final int
TINYINT_COMPILATION_TYPE_ID

class org.apache.derby.iapi.types.TinyintTypeId

public static final int
TINYINT_TYPE_ID

class org.apache.derby.iapi.types.TinyintTypeId

public static final int
TINYINT_TYPE_ID_IMPL

class org.apache.derby.catalog.types.TinyintTypeIdImpl

public static final int
TRANSACTION_CONSTANT_ACTION_V01_ID

class org.apache.derby.impl.sql.execute.TransactionConstantAction

public static final int
TRIGGER_DESCRIPTOR_FINDER_V01_ID

class org.apache.derby.impl.sql.catalog.TriggerDescriptorFinder

public static final int
TRIGGER_DESCRIPTOR_V01_ID

Class org.apache.derby.impl.sql.catalog.TriggerDescriptor.

public static final int
TRIGGER_INFO_V01_ID

class org.apache.derby.impl.sql.execute.TriggerInfo

public static final int
TWO_BYTE_FORMAT_ID_BYTE_LENGTH

Byte length of a two byt format id.

public static final int
public static final int
UNUSED_243

Unused 243

public static final int
UNUSED_2_141

class org.apache.derby.Database.Language.Execution.CreateSchemaConstantAction

public static final int
public static final int
UNUSED_2_143

class org.apache.derby.Database.Language.Execution.CreateViewConstantAction

public static final int
public static final int
public static final int
public static final int
UNUSED_2_221

class org.apache.derby.Database.Language.Execution.CreateSPSConstantAction

public static final int
UNUSED_2_222

class org.apache.derby.Database.Language.Execution.CreateSPSConstantAction

public static final int
UNUSED_2_275

class org.apache.derby.Database.Language.Execution.LockTableConstantAction

public static final int
public static final int
public static final int
public static final int
UNUSED_2_42

class org.apache.derby.Database.Language.Execution.DropAliasConstantAction

public static final int
UPDATABLE_VTI_CONSTANT_ACTION_V01_ID

class org.apache.derby.Database.Language.Execution.UpdateConstantAction

public static final int
UPDATE_CONSTANT_ACTION_V01_ID

class org.apache.derby.Database.Language.Execution.UpdateConstantAction

public static final int
public static final int
USER_AGGREGATE_ALIAS_INFO_V01_ID

class org.apache.derby.catalog.types.UserAggregateAliasInfo

public static final int
USERDEFINED_COMPILATION_TYPE_ID

class org.apache.derby.iapi.types.UserDefinedTypeId

public static final int
USERDEFINED_COMPILATION_TYPE_ID_V2

class org.apache.derby.iapi.types.UserDefinedTypeIdV2

public static final int
USERDEFINED_TYPE_ID_IMPL_V3

class org.apache.derby.catalog.types.UserDefinedTypeIdImpl

public static final int
USERDEFINED_TYPE_ID_V3

class org.apache.derby.iapi.types.UserDefinedTypeIdV3

public static final int
VARBIT_COMPILATION_TYPE_ID

class org.apache.derby.iapi.types.VarbitTypeId

public static final int
VARBIT_TYPE_ID

class org.apache.derby.iapi.types.VarbitTypeId

public static final int
VARBIT_TYPE_ID_IMPL

class org.apache.derby.catalog.types.VarbitTypeIdImpl

public static final int
VARCHAR_COMPILATION_TYPE_ID

class org.apache.derby.iapi.types.VarcharTypeId

public static final int
VARCHAR_TYPE_ID

class org.apache.derby.iapi.types.VarcharTypeId

public static final int
VARCHAR_TYPE_ID_IMPL

class org.apache.derby.catalog.types.VarcharTypeIdImpl

public static final int
VIEW_DESCRIPTOR_FINDER_V01_ID

class org.apache.derby.impl.sql.catalog.ViewDescriptorFinder

public static final int
WORK_UNIT_ALIAS_INFO_V01_ID

class org.apache.derby.catalog.types.WorkUnitAliasInfo

public static final int
WRITE_CURSOR_CONSTANT_ACTION_V01_ID

class org.apache.derby.Database.Language.Execution.DeleteConstantAction This class is abstract so it doesn't need a format id!

public static final int
public static final int
XML_TYPE_ID

Instance of TypeId for XML data types.

public static final int
XML_TYPE_ID_IMPL

class org.apache.derby.iapi.types.XML (implementation of org.apache.derby.iapi.types.XMLDataValue).