Top Description Fields Constructors Methods
org.apache.derby.impl.store.access.btree.index

public Class B2IStaticCompiledInfo

extends Object
implements StaticCompiledOpenConglomInfo
Class Inheritance
All Implemented Interfaces
org.apache.derby.iapi.store.access.StaticCompiledOpenConglomInfo, org.apache.derby.iapi.services.io.Storable, org.apache.derby.iapi.services.io.Formatable, org.apache.derby.iapi.services.io.TypedFormat, java.io.Externalizable, java.io.Serializable
Imports
org.apache.derby.iapi.services.io.ArrayInputStream, .StoredFormatIds, org.apache.derby.shared.common.error.StandardException, org.apache.derby.iapi.store.access.StaticCompiledOpenConglomInfo, .TransactionController, org.apache.derby.iapi.types.DataValueDescriptor, java.io.IOException, .ObjectInput, .ObjectOutput

This class implements the static compiled information relevant to a btree secondary index. It is what is returned by B2I.getStaticCompiledOpenConglomInfo().

Currently the only interesting information stored is Conglomerate for this index and the Conglomerate for the base table of this conglomerate.

Field Summary

Modifier and TypeField and Description
pack-priv B2I
b2i

Conglomerate data structure for this index.

pack-priv StaticCompiledOpenConglomInfo
base_table_static_info

Conglomerate data structure for this base table of this index.

Constructor Summary

AccessConstructor and Description
public
B2IStaticCompiledInfo()

Empty arg constructor used by the monitor to create object to read into.

pack-priv
B2IStaticCompiledInfo(TransactionController tc, B2I
the btree Conglomerate that we are compiling.
b2i
)

Constructor used to build class from scratch.

Method Summary

Modifier and TypeMethod and Description
public DataValueDescriptor

Returns:

the secondary index Conglomerate Object.
getConglom
()

Implements org.apache.derby.iapi.store.access.StaticCompiledOpenConglomInfo.getConglom.

return the "Conglomerate".

public int
public boolean
isNull()

Implements org.apache.derby.iapi.services.io.Storable.isNull.

Return whether the value is null or not.

public void
readExternal(ObjectInput
the stream to read data from in order to restore the object
in
)

Implements java.io.Externalizable.readExternal.

Restore the in-memory representation from the stream.

public void
public void
restoreToNull()

Implements org.apache.derby.iapi.services.io.Storable.restoreToNull.

Restore the in-memory representation to the null value.

public void
writeExternal(ObjectOutput
the stream to write the object to
out
)

Implements java.io.Externalizable.writeExternal.

Store the stored representation of the column value in the stream.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

b2iback to summary
pack-priv B2I b2i

Conglomerate data structure for this index.

base_table_static_infoback to summary
pack-priv StaticCompiledOpenConglomInfo base_table_static_info

Conglomerate data structure for this base table of this index.

Constructor Detail

B2IStaticCompiledInfoback to summary
public B2IStaticCompiledInfo()

Empty arg constructor used by the monitor to create object to read into.

B2IStaticCompiledInfoback to summary
pack-priv B2IStaticCompiledInfo(TransactionController tc, B2I b2i) throws StandardException

Constructor used to build class from scratch.

Parameters
b2i:B2I

the btree Conglomerate that we are compiling.

Method Detail

getConglomback to summary
public DataValueDescriptor getConglom()

Implements org.apache.derby.iapi.store.access.StaticCompiledOpenConglomInfo.getConglom.

return the "Conglomerate".

For secondaryindex compiled info return the secondary index conglomerate.

Returns:DataValueDescriptor

the secondary index Conglomerate Object.

getTypeFormatIdback to summary
public int getTypeFormatId()

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

Return my format identifier.

Returns:int

Doc from org.apache.derby.iapi.services.io.TypedFormat.getTypeFormatId.

The identifier. (A UUID stuffed in an array of 16 bytes).

See Also
org.apache.derby.iapi.services.io.TypedFormat#getTypeFormatId
isNullback to summary
public boolean isNull()

Implements org.apache.derby.iapi.services.io.Storable.isNull.

Return whether the value is null or not. The containerid being zero is what determines nullness; subclasses are not expected to override this method.

Returns:boolean

Doc from org.apache.derby.iapi.services.io.Storable.isNull.

true if the value is null and false otherwise.

See Also
org.apache.derby.iapi.services.io.Storable#isNull
readExternalback to summary
public void readExternal(ObjectInput in) throws IOException, ClassNotFoundException

Implements java.io.Externalizable.readExternal.

Restore the in-memory representation from the stream.

Parameters
in:ObjectInput

Doc from java.io.Externalizable.readExternal.

the stream to read data from in order to restore the object

Exceptions
IOException:
thrown by readObject()
ClassNotFoundException:
Thrown if the stored representation is serialized and a class named in the stream could not be found.
See Also
java.io.Externalizable#readExternal
readExternalFromArrayback to summary
public void readExternalFromArray(ArrayInputStream in) throws IOException, ClassNotFoundException
restoreToNullback to summary
public void restoreToNull()

Implements org.apache.derby.iapi.services.io.Storable.restoreToNull.

Restore the in-memory representation to the null value. The containerid being zero is what determines nullness; subclasses are not expected to override this method.

See Also
org.apache.derby.iapi.services.io.Storable#restoreToNull
writeExternalback to summary
public void writeExternal(ObjectOutput out) throws IOException

Implements java.io.Externalizable.writeExternal.

Store the stored representation of the column value in the stream. It might be easier to simply store the properties - which would certainly make upgrading easier.

Parameters
out:ObjectOutput

Doc from java.io.Externalizable.writeExternal.

the stream to write the object to

Exceptions
IOException:
thrown by writeObject()