java.io.Externalizable
, java.io.Serializable
, IndexDescriptor
, Formatable
, TypedFormat
public class IndexDescriptorImpl extends java.lang.Object implements IndexDescriptor, Formatable
IndexRowGenerator
.
For a description of how deferrable and non-deferrable constraints
are backed differently, including the meaning of the
boolean attributes used here, see IndexDescriptor
.
Modifier and Type | Field | Description |
---|---|---|
private int[] |
baseColumnPositions |
|
private boolean |
hasDeferrableChecking |
The index represents a constraint which is deferrable.
|
private java.lang.String |
indexType |
|
private boolean[] |
isAscending |
|
private boolean |
isUnique |
This class implements Formatable.
|
private boolean |
isUniqueDeferrable |
The index represents a PRIMARY KEY or a UNIQUE NOT NULL constraint which
is deferrable.
|
private boolean |
isUniqueWithDuplicateNulls |
|
private int |
numberOfOrderedColumns |
Constructor | Description |
---|---|
IndexDescriptorImpl() |
Zero-argument constructor for Formatable interface
|
IndexDescriptorImpl(java.lang.String indexType,
boolean isUnique,
boolean isUniqueWithDuplicateNulls,
boolean isUniqueDeferrable,
boolean hasDeferrableChecking,
int[] baseColumnPositions,
boolean[] isAscending,
int numberOfOrderedColumns) |
Constructor for an IndexDescriptorImpl
|
Modifier and Type | Method | Description |
---|---|---|
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.
|
int |
getTypeFormatId() |
Get a universally unique identifier for the type of
this object.
|
boolean |
hasDeferrableChecking() |
Returns true if the index is used to support a deferrable constraint.
|
int |
hashCode() |
|
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.
|
boolean |
isUniqueDeferrable() |
The index represents a PRIMARY KEY or a UNIQUE NOT NULL constraint which
is deferrable.
|
boolean |
isUniqueWithDuplicateNulls() |
Returns true if the index is duplicate keys only for null key parts.
|
int |
numberOfOrderedColumns() |
Returns the number of ordered columns.
|
void |
readExternal(java.io.ObjectInput in) |
|
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() |
|
void |
writeExternal(java.io.ObjectOutput out) |
private boolean isUnique
private int[] baseColumnPositions
private boolean[] isAscending
private int numberOfOrderedColumns
private java.lang.String indexType
private boolean isUniqueWithDuplicateNulls
private boolean isUniqueDeferrable
true
implies isUnique == false
and
isUniqueWithDuplicateNulls == false
and
hasDeferrableChecking == true
.private boolean hasDeferrableChecking
public IndexDescriptorImpl(java.lang.String indexType, boolean isUnique, boolean isUniqueWithDuplicateNulls, boolean isUniqueDeferrable, boolean hasDeferrableChecking, int[] baseColumnPositions, boolean[] isAscending, int numberOfOrderedColumns)
indexType
- The type of indexisUnique
- True means the index is uniqueisUniqueWithDuplicateNulls
- True means the index will be unique
for non null values but duplicate nulls
will be allowed.
This parameter has no effect if the isUnique
is true. If isUnique is false and
isUniqueWithDuplicateNulls is set to true the
index will allow duplicate nulls but for
non null keys will act like a unique index.isUniqueDeferrable
- True means the index represents a PRIMARY
KEY or a UNIQUE NOT NULL constraint which
is deferrable.hasDeferrableChecking
- True if this index supports a deferrable
constraint.baseColumnPositions
- An array of column positions in the base
table. Each index column corresponds to a
column position in the base table.isAscending
- An array of booleans telling asc/desc on each
column.numberOfOrderedColumns
- In the future, it will be possible
to store non-ordered columns in an
index. These will be useful for
covered queries.public IndexDescriptorImpl()
public boolean isUniqueWithDuplicateNulls()
IndexDescriptor
isUniqueWithDuplicateNulls
in interface IndexDescriptor
IndexDescriptor.isUniqueWithDuplicateNulls()
public boolean hasDeferrableChecking()
IndexDescriptor
hasDeferrableChecking
in interface IndexDescriptor
true
is the index supports a deferrable constraintpublic boolean isUniqueDeferrable()
true
implies #isUnique() == false
and
#isUniqueWithDuplicateNulls() == false
and
#hasDeferrableChecking() == true
.isUniqueDeferrable
in interface IndexDescriptor
true
is the index supports such a constraintpublic boolean isUnique()
IndexDescriptor
isUnique
in interface IndexDescriptor
IndexDescriptor.isUnique()
public int[] baseColumnPositions()
IndexDescriptor
baseColumnPositions
in interface IndexDescriptor
IndexDescriptor.baseColumnPositions()
public int getKeyColumnPosition(int heapColumnPosition)
IndexDescriptor
Returns the position of a column within the key (1-based). 0 means that the column is not in the key. Same as the above method, but it uses int instead of Integer.
getKeyColumnPosition
in interface IndexDescriptor
IndexDescriptor.getKeyColumnPosition(int)
public int numberOfOrderedColumns()
IndexDescriptor
In the future, it will be possible to store non-ordered columns in an index. These will be useful for covered queries. The ordered columns will be at the beginning of the index row, and they will be followed by the non-ordered columns. For now, all columns in an index must be ordered.
numberOfOrderedColumns
in interface IndexDescriptor
IndexDescriptor.numberOfOrderedColumns()
public java.lang.String indexType()
IndexDescriptor
indexType
in interface IndexDescriptor
IndexDescriptor.indexType()
public boolean isAscending(java.lang.Integer keyColumnPosition)
IndexDescriptor
isAscending
in interface IndexDescriptor
IndexDescriptor.isAscending()
public boolean isDescending(java.lang.Integer keyColumnPosition)
IndexDescriptor
isDescending
in interface IndexDescriptor
IndexDescriptor.isDescending(java.lang.Integer)
public boolean[] isAscending()
IndexDescriptor
isAscending
in interface IndexDescriptor
IndexDescriptor.isAscending()
public void setBaseColumnPositions(int[] baseColumnPositions)
IndexDescriptor
setBaseColumnPositions
in interface IndexDescriptor
IndexDescriptor.setBaseColumnPositions(int[])
public void setIsAscending(boolean[] isAscending)
IndexDescriptor
setIsAscending
in interface IndexDescriptor
IndexDescriptor.setIsAscending(boolean[])
public void setNumberOfOrderedColumns(int numberOfOrderedColumns)
IndexDescriptor
setNumberOfOrderedColumns
in interface IndexDescriptor
IndexDescriptor.setNumberOfOrderedColumns(int)
public java.lang.String toString()
toString
in class java.lang.Object
public void readExternal(java.io.ObjectInput in) throws java.io.IOException, java.lang.ClassNotFoundException
readExternal
in interface java.io.Externalizable
java.io.IOException
- Thrown on read errorjava.lang.ClassNotFoundException
Externalizable.readExternal(java.io.ObjectInput)
public void writeExternal(java.io.ObjectOutput out) throws java.io.IOException
writeExternal
in interface java.io.Externalizable
java.io.IOException
- Thrown on write errorExternalizable.writeExternal(java.io.ObjectOutput)
public int getTypeFormatId()
TypedFormat
getTypeFormatId
in interface TypedFormat
public boolean equals(java.lang.Object other)
equals
in class java.lang.Object
other
- The other indexrowgenerator to compare this one withpublic int hashCode()
hashCode
in class java.lang.Object
Object.hashCode()
Apache Derby V10.14 Internals - Copyright © 2004,2018 The Apache Software Foundation. All Rights Reserved.