IndexDescriptorImpl

Overview

Package

Class

Use

Deprecated

Index

Home >> All >> org >> apache >> derby >> catalog >> [ types overview ]

PREV CLASS NEXT CLASS

SUMMARY:

JAVADOC |

Sourc code of org.apache.derby.catalog.types.IndexDescriptorImpl

SOURCE |

Download org.apache.derby.catalog.types.IndexDescriptorImpl

DOWNLOAD | NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.apache.derby.catalog.types
Class IndexDescriptorImpl

java.lang.Object
  org.apache.derby.catalog.types.IndexDescriptorImpl

All Implemented Interfaces:: java.io.Externalizable, org.apache.derby.iapi.services.io.Formatable, org.apache.derby.catalog.IndexDescriptor, java.io.Serializable, org.apache.derby.iapi.services.io.TypedFormat

public class IndexDescriptorImpl
extends java.lang.Object
implements org.apache.derby.catalog.IndexDescriptor, org.apache.derby.iapi.services.io.Formatable

Field Summary

private int[] baseColumnPositions


private java.lang.String indexType


private boolean[] isAscending


private boolean isUnique
          This class implements Formatable.

private int numberOfOrderedColumns


Constructor Summary

IndexDescriptorImpl()
          Zero-argument constructor for Formatable interface

IndexDescriptorImpl(java.lang.String indexType, boolean isUnique, int[] baseColumnPositions, boolean[] isAscending, int numberOfOrderedColumns)
          Constructor for an IndexDescriptorImpl

Method Summary

int[] baseColumnPositions()
          Returns an array of column positions in the base table.

boolean equals(java.lang.Object other)
          Test for value equality

int getKeyColumnPosition(int heapColumnPosition)
          Returns the postion of a column.

java.lang.Integer getKeyColumnPosition(java.lang.Integer heapColumnPosition)
          Returns the postion of a column.

int getTypeFormatId()
          Get a universally unique identifier for the type of this object.

int hashCode()
          Get a value that represents this Object, as uniquely as possible within the confines of an int.

java.lang.String indexType()
          Returns the type of the index.

boolean[] isAscending()
          Returns array of boolean telling asc/desc info for each index key column for convenience of using together with baseColumnPositions method.

boolean isAscending(java.lang.Integer keyColumnPosition)
          Returns true if the specified column is ascending in the index (1-based).

boolean isDescending(java.lang.Integer keyColumnPosition)
          Returns true if the specified column is descending in the index (1-based).

boolean isUnique()
          Returns true if the index is unique.

int numberOfOrderedColumns()
          Returns the number of ordered columns.

void readExternal(java.io.ObjectInput in)
          This method restores an object's state by reading in the instance data for the object from the passed in stream.

void setBaseColumnPositions(int[] baseColumnPositions)
          set the baseColumnPositions field of the index descriptor.

void setIsAscending(boolean[] isAscending)
          set the isAscending field of the index descriptor.

void setNumberOfOrderedColumns(int numberOfOrderedColumns)
          set the numberOfOrderedColumns field of the index descriptor.

java.lang.String toString()
          Convert this Object to a human-readable String.

void writeExternal(java.io.ObjectOutput out)
          This method is responsible for writing the instance data of an object to the passed in stream.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

isUnique

private boolean isUnique

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.

baseColumnPositions

private int[] baseColumnPositions

isAscending

private boolean[] isAscending

numberOfOrderedColumns

private int numberOfOrderedColumns

indexType

private java.lang.String indexType

Constructor Detail

IndexDescriptorImpl

public IndexDescriptorImpl(java.lang.String indexType,
                           boolean isUnique,
                           int[] baseColumnPositions,
                           boolean[] isAscending,
                           int numberOfOrderedColumns)

Constructor for an IndexDescriptorImpl

IndexDescriptorImpl

public IndexDescriptorImpl()

Zero-argument constructor for Formatable interface

Method Detail