org.apache.derby.impl.store.access.btree.index
Class B2IStaticCompiledInfo

java.lang.Object
  extended by org.apache.derby.impl.store.access.btree.index.B2IStaticCompiledInfo
All Implemented Interfaces:
java.io.Externalizable, java.io.Serializable, Formatable, Storable, TypedFormat, StaticCompiledOpenConglomInfo

public class B2IStaticCompiledInfo
extends java.lang.Object
implements StaticCompiledOpenConglomInfo

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.

See Also:
Serialized Form

Field Summary
(package private)  B2I b2i
          Conglomerate data structure for this index.
(package private)  StaticCompiledOpenConglomInfo base_table_static_info
          Conglomerate data structure for this base table of this index.
 
Constructor Summary
B2IStaticCompiledInfo()
          Empty arg constructor used by the monitor to create object to read into.
B2IStaticCompiledInfo(TransactionController tc, B2I b2i)
          Constructor used to build class from scratch.
 
Method Summary
 DataValueDescriptor getConglom()
          return the "Conglomerate".
 int getTypeFormatId()
          Return my format identifier.
 boolean isNull()
          Return whether the value is null or not.
 void readExternal(java.io.ObjectInput in)
          Restore the in-memory representation from the stream.
 void readExternalFromArray(ArrayInputStream in)
           
 void restoreToNull()
          Restore the in-memory representation to the null value.
 void writeExternal(java.io.ObjectOutput out)
          Store the stored representation of the column value in the stream.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

b2i

B2I b2i
Conglomerate data structure for this index.


base_table_static_info

StaticCompiledOpenConglomInfo base_table_static_info
Conglomerate data structure for this base table of this index.

Constructor Detail

B2IStaticCompiledInfo

public B2IStaticCompiledInfo()
Empty arg constructor used by the monitor to create object to read into.


B2IStaticCompiledInfo

B2IStaticCompiledInfo(TransactionController tc,
                      B2I b2i)
                throws StandardException
Constructor used to build class from scratch.

Parameters:
b2i - the btree Conglomerate that we are compiling.
Throws:
StandardException
Method Detail

getConglom

public DataValueDescriptor getConglom()
return the "Conglomerate".

For secondaryindex compiled info return the secondary index conglomerate.

Specified by:
getConglom in interface StaticCompiledOpenConglomInfo
Returns:
the secondary index Conglomerate Object.

isNull

public boolean 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.

Specified by:
isNull in interface Storable
Returns:
true if the value is null and false otherwise.
See Also:
Storable.isNull()

restoreToNull

public void 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.

Specified by:
restoreToNull in interface Storable
See Also:
Storable.restoreToNull()

getTypeFormatId

public int getTypeFormatId()
Return my format identifier.

Specified by:
getTypeFormatId in interface TypedFormat
Returns:
The identifier. (A UUID stuffed in an array of 16 bytes).
See Also:
TypedFormat.getTypeFormatId()

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException
Restore the in-memory representation from the stream.

Specified by:
readExternal in interface java.io.Externalizable
Throws:
java.lang.ClassNotFoundException - Thrown if the stored representation is serialized and a class named in the stream could not be found.
java.io.IOException - thrown by readObject()
See Also:
Externalizable.readExternal(java.io.ObjectInput)

readExternalFromArray

public void readExternalFromArray(ArrayInputStream in)
                           throws java.io.IOException,
                                  java.lang.ClassNotFoundException
Throws:
java.io.IOException
java.lang.ClassNotFoundException

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException
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.

Specified by:
writeExternal in interface java.io.Externalizable
Throws:
java.io.IOException - thrown by writeObject()

Built on Thu 2010-12-23 20:49:13+0000, from revision ???

Apache Derby V10.6 Internals - Copyright © 2004,2007 The Apache Software Foundation. All Rights Reserved.