IndexImpl

java.lang.Object
- com.healthmarketscience.jackcess.impl.IndexImpl

All Implemented Interfaces:

Index, java.lang.Comparable<IndexImpl>
```
public class IndexImpl
extends java.lang.Object
implements Index, java.lang.Comparable<IndexImpl>
```
Access table (logical) index. Logical indexes are backed for IndexData, where one or more logical indexes could be backed by the same data.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`IndexImpl.ForeignKeyReference` Information about a foreign key reference defined in an index (when referential integrity should be enforced).

Nested classes/interfaces inherited from interface com.healthmarketscience.jackcess.Index
Index.Column

Field Summary

Fields
Modifier and Type	Field and Description
`private IndexData`	`_data` the actual data backing this index (more than one index may be backed by the same data
`private int`	`_indexNumber` 0-based index number
`private byte`	`_indexType` the type of the index
`private java.lang.String`	`_name` Index name
`private IndexImpl.ForeignKeyReference`	`_reference` foreign key reference info, if any
`private static byte`	`CASCADE_DELETES_FLAG` flag for indicating that deletes should cascade in a foreign key index
`private static byte`	`CASCADE_UPDATES_FLAG` flag for indicating that updates should cascade in a foreign key index
`static byte`	`FOREIGN_KEY_INDEX_TYPE` index type for foreign key indexes
`private static int`	`INVALID_INDEX_NUMBER` indicate an invalid index number for foreign key field
`protected static org.apache.commons.logging.Log`	`LOG`
`static byte`	`PRIMARY_KEY_INDEX_TYPE` index type for primary key indexes
`private static byte`	`PRIMARY_TABLE_TYPE` index table type for the "primary" table in a foreign key index

Constructor Summary

Constructors
Modifier Constructor and Description

protected IndexImpl(java.nio.ByteBuffer tableBuffer, java.util.List<IndexData> indexDatas, JetFormat format)

Constructors
Modifier	Constructor and Description
`protected`	`IndexImpl(java.nio.ByteBuffer tableBuffer, java.util.List<IndexData> indexDatas, JetFormat format)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`compareTo(IndexImpl other)`
`java.lang.Object[]`	`constructIndexRow(java.util.Map<java.lang.String,?> row)` Constructs an array of values appropriate for this index from the given column values.
`java.lang.Object[]`	`constructIndexRow(java.lang.String colName, java.lang.Object value)` Constructs an array of values appropriate for this index from the given column value.
`java.lang.Object[]`	`constructIndexRowFromEntry(java.lang.Object... values)` Constructs an array of values appropriate for this index from the given column values, expected to match the columns for this index.
`IndexData.EntryCursor`	`cursor()` Gets a new cursor for this index.
`IndexData.EntryCursor`	`cursor(java.lang.Object[] startRow, boolean startInclusive, java.lang.Object[] endRow, boolean endInclusive)` Gets a new cursor for this index, narrowed to the range defined by the given startRow and endRow.
`java.util.List<IndexData.ColumnDescriptor>`	`getColumns()`
`JetFormat`	`getFormat()`
`IndexData`	`getIndexData()`
`byte`	`getIndexFlags()`
`int`	`getIndexNumber()`
`java.lang.String`	`getName()`
`PageChannel`	`getPageChannel()`
`IndexImpl.ForeignKeyReference`	`getReference()`
`IndexImpl`	`getReferencedIndex()`
`TableImpl`	`getTable()`
`int`	`getUniqueEntryCount()`
`int`	`getUniqueEntryCountOffset()`
`void`	`initialize()` Forces initialization of this index (actual parsing of index pages).
`boolean`	`isForeignKey()`
`boolean`	`isInitialized()` Whether or not the complete index state has been read.
`boolean`	`isPrimaryKey()`
`boolean`	`isUnique()` Whether or not index entries must be unique.
`CursorBuilder`	`newCursor()` Convenience method for constructing a new CursorBuilder for this Index.
`(package private) void`	`setName(java.lang.String name)`
`boolean`	`shouldIgnoreNulls()` Whether or not `null` values are actually recorded in the index.
`java.lang.String`	`toString()`
`private java.lang.String`	`withErrorContext(java.lang.String msg)`
`private static java.lang.String`	`withErrorContext(java.lang.String msg, DatabaseImpl db, java.lang.String idxName)`
`protected static void`	`writeDefinitions(TableCreator creator, java.nio.ByteBuffer buffer)` Writes the logical index definitions into a table definition buffer.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - LOG
```
protected static final org.apache.commons.logging.Log LOG
```
  - PRIMARY_KEY_INDEX_TYPE
```
public static final byte PRIMARY_KEY_INDEX_TYPE
```
    index type for primary key indexes
    
    See Also:
    
    Constant Field Values
  - FOREIGN_KEY_INDEX_TYPE
```
public static final byte FOREIGN_KEY_INDEX_TYPE
```
    index type for foreign key indexes
    
    See Also:
    
    Constant Field Values
  - CASCADE_UPDATES_FLAG
```
private static final byte CASCADE_UPDATES_FLAG
```
    flag for indicating that updates should cascade in a foreign key index
    
    See Also:
    
    Constant Field Values
  - CASCADE_DELETES_FLAG
```
private static final byte CASCADE_DELETES_FLAG
```
    flag for indicating that deletes should cascade in a foreign key index
    
    See Also:
    
    Constant Field Values
  - PRIMARY_TABLE_TYPE
```
private static final byte PRIMARY_TABLE_TYPE
```
    index table type for the "primary" table in a foreign key index
    
    See Also:
    
    Constant Field Values
  - INVALID_INDEX_NUMBER
```
private static final int INVALID_INDEX_NUMBER
```
    indicate an invalid index number for foreign key field
    
    See Also:
    
    Constant Field Values
  - _data
```
private final IndexData _data
```
    the actual data backing this index (more than one index may be backed by the same data
  - _indexNumber
```
private final int _indexNumber
```
    0-based index number
  - _indexType
```
private final byte _indexType
```
    the type of the index
  - _name
```
private java.lang.String _name
```
    Index name
  - _reference
```
private final IndexImpl.ForeignKeyReference _reference
```
    foreign key reference info, if any
- Constructor Detail
  - IndexImpl
```
protected IndexImpl(java.nio.ByteBuffer tableBuffer,
                    java.util.List<IndexData> indexDatas,
                    JetFormat format)
             throws java.io.IOException
```
    Throws:
    
    java.io.IOException
- Method Detail
  - getIndexData
```
public IndexData getIndexData()
```
  - getTable
```
public TableImpl getTable()
```
    Specified by:
    
    getTable in interface Index
  - getFormat
```
public JetFormat getFormat()
```
  - getPageChannel
```
public PageChannel getPageChannel()
```
  - getIndexNumber
```
public int getIndexNumber()
```
  - getIndexFlags
```
public byte getIndexFlags()
```
  - getUniqueEntryCount
```
public int getUniqueEntryCount()
```
  - getUniqueEntryCountOffset
```
public int getUniqueEntryCountOffset()
```
  - getName
```
public java.lang.String getName()
```
    Specified by:
    
    getName in interface Index
  - setName
```
void setName(java.lang.String name)
```
  - isPrimaryKey
```
public boolean isPrimaryKey()
```
    Specified by:
    
    isPrimaryKey in interface Index
  - isForeignKey
```
public boolean isForeignKey()
```
    Specified by:
    
    isForeignKey in interface Index
  - getReference
```
public IndexImpl.ForeignKeyReference getReference()
```
  - getReferencedIndex
```
public IndexImpl getReferencedIndex()
                             throws java.io.IOException
```
    Specified by:
    
    getReferencedIndex in interface Index
    
    Returns:
    
    the Index referenced by this Index's ForeignKeyReference (if it has one), otherwise null.
    
    Throws:
    
    java.io.IOException
  - shouldIgnoreNulls
```
public boolean shouldIgnoreNulls()
```
    Description copied from interface: Index
    
    Whether or not null values are actually recorded in the index.
    
    Specified by:
    
    shouldIgnoreNulls in interface Index
  - isUnique
```
public boolean isUnique()
```
    Description copied from interface: Index
    Whether or not index entries must be unique.
    Some notes about uniqueness:
    - Access does not seem to consider multiple null entries invalid for a unique index
    - text indexes collapse case, and Access seems to compare only the index entry bytes, therefore two strings which differ only in case will violate the unique constraint
    Specified by:
    
    isUnique in interface Index
  - getColumns
```
public java.util.List<IndexData.ColumnDescriptor> getColumns()
```
    Specified by:
    
    getColumns in interface Index
    
    Returns:
    
    the Columns for this index (unmodifiable)
  - newCursor
```
public CursorBuilder newCursor()
```
    Description copied from interface: Index
    
    Convenience method for constructing a new CursorBuilder for this Index.
    
    Specified by:
    
    newCursor in interface Index
  - isInitialized
```
public boolean isInitialized()
```
    Whether or not the complete index state has been read.
  - initialize
```
public void initialize()
                throws java.io.IOException
```
    Forces initialization of this index (actual parsing of index pages). normally, the index will not be initialized until the entries are actually needed.
    
    Throws:
    
    java.io.IOException
  - cursor
```
public IndexData.EntryCursor cursor()
                             throws java.io.IOException
```
    Gets a new cursor for this index.
    Forces index initialization.
    
    Throws:
    
    java.io.IOException
  - cursor
```
public IndexData.EntryCursor cursor(java.lang.Object[] startRow,
                                    boolean startInclusive,
                                    java.lang.Object[] endRow,
                                    boolean endInclusive)
                             throws java.io.IOException
```
    Gets a new cursor for this index, narrowed to the range defined by the given startRow and endRow.
    Forces index initialization.
    
    Parameters:
    
    startRow - the first row of data for the cursor, or null for the first entry
    
    startInclusive - whether or not startRow is inclusive or exclusive
    
    endRow - the last row of data for the cursor, or null for the last entry
    
    endInclusive - whether or not endRow is inclusive or exclusive
    
    Throws:
    
    java.io.IOException
  - constructIndexRowFromEntry
```
public java.lang.Object[] constructIndexRowFromEntry(java.lang.Object... values)
```
    Constructs an array of values appropriate for this index from the given column values, expected to match the columns for this index.
    
    Returns:
    
    the appropriate sparse array of data
    
    Throws:
    
    java.lang.IllegalArgumentException - if the wrong number of values are provided
  - constructIndexRow
```
public java.lang.Object[] constructIndexRow(java.lang.String colName,
                                            java.lang.Object value)
```
    Constructs an array of values appropriate for this index from the given column value.
    
    Returns:
    
    the appropriate sparse array of data or null if not all columns for this index were provided
  - constructIndexRow
```
public java.lang.Object[] constructIndexRow(java.util.Map<java.lang.String,?> row)
```
    Constructs an array of values appropriate for this index from the given column values.
    
    Returns:
    
    the appropriate sparse array of data or null if not all columns for this index were provided
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - compareTo
```
public int compareTo(IndexImpl other)
```
    Specified by:
    
    compareTo in interface java.lang.Comparable<IndexImpl>
  - writeDefinitions
```
protected static void writeDefinitions(TableCreator creator,
                                       java.nio.ByteBuffer buffer)
                                throws java.io.IOException
```
    Writes the logical index definitions into a table definition buffer.
    
    Parameters:
    
    creator - description of the indexes to write
    
    buffer - Buffer to write to
    
    Throws:
    
    java.io.IOException
  - withErrorContext
```
private java.lang.String withErrorContext(java.lang.String msg)
```
  - withErrorContext
```
private static java.lang.String withErrorContext(java.lang.String msg,
                                                 DatabaseImpl db,
                                                 java.lang.String idxName)
```

Class IndexImpl

Nested Class Summary

Nested classes/interfaces inherited from interface com.healthmarketscience.jackcess.Index

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

LOG

PRIMARY_KEY_INDEX_TYPE

FOREIGN_KEY_INDEX_TYPE

CASCADE_UPDATES_FLAG

CASCADE_DELETES_FLAG

PRIMARY_TABLE_TYPE

INVALID_INDEX_NUMBER

_data

_indexNumber

_indexType

_name

_reference

Constructor Detail

IndexImpl

Method Detail

getIndexData

getTable

getFormat

getPageChannel

getIndexNumber

getIndexFlags

getUniqueEntryCount

getUniqueEntryCountOffset

getName

setName

isPrimaryKey

isForeignKey

getReference

getReferencedIndex

shouldIgnoreNulls

isUnique

getColumns

newCursor

isInitialized

initialize

cursor

cursor

constructIndexRowFromEntry

constructIndexRow

constructIndexRow

toString

compareTo

writeDefinitions

withErrorContext

withErrorContext