HyperSQL Database 2.7.4 · org.hsqldb.index.Index · APIdia, the JavaDoc alternative

Modifier and Type	Class and Description
public static class	Index.IndexUse

Modifier and Type	Field and Description
public static final double	cachedFactor
public static final Index[]	emptyArray Hides org.hsqldb.SchemaObject.emptyArray.
public static final Index.IndexUse[]	emptyUseArray
public static final int	INDEX_NON_UNIQUE
public static final int	INDEX_NONE
public static final int	INDEX_UNIQUE
public static final double	minimumSelectivity
public static final int	probeDepth

Method Summary

Modifier and Type	Method and Description
public Index.IndexUse[]	asArray()
public int	compareRow(Session session, Object[] a, Object[] b)
public int	Returns: comparison result, -1,0,+1 compareRowNonUnique(Session Session session, Object[] row from another table a, Object[] a full row in this table b, int[] column indexes in the other table rowColMap) Compares two table rows based on the columns of this index.
public int	compareRowNonUnique(Session session, Object[] a, Object[] b, int[] rowColMap, int fieldCount)
public int	compareRowNonUnique(Session session, Object[] a, Object[] b, int fieldcount) As above but use the index column data
public void	delete(Session session, PersistentStore store, Row row)
public boolean	existsParent(Session session, PersistentStore store, Object[] rowdata, int[] rowColMap)
public RowIterator	Returns: iterator findFirstRow(Session session object session, PersistentStore store object store, Object[] Object[] rowdata, int count of columns to match matchCount, int int distinctCount, int int compareType, boolean boolean reversed, boolean[] boolean[] map) Return the first node equal to the indexdata object.
public RowIterator	Returns: iterator findFirstRow(Session session object session, PersistentStore store object store, Object[] array containing table row data rowdata) Return the first node equal to the rowdata object.
public RowIterator	Returns: iterator findFirstRow(Session session object session, PersistentStore store object store, Object[] array containing table row data rowdata, int[] int[] rowColMap) Return the first node equal to the rowdata object.
public RowIterator	Returns: iterator findFirstRowNotNull(Session Session session, PersistentStore PersistentStore store) Finds the first node where the data is not null.
public RowIterator	firstRow(PersistentStore store)
public RowIterator	Returns: Iterator for first row firstRow(Session session, PersistentStore store, RangeVariable.RangeVariableConditions[] conditions, int distinctCount, boolean[] map) Returns the row for the first node of the index
public int	getColumnCount() Returns the count of visible columns used
public boolean[]	Returns: boolean[] getColumnDesc() Returns the array containing desc column flags
public int[]	Returns: int[] getColumns() Returns the array containing column indexes for index
public Type[]	Returns: Type[] getColumnTypes() Returns the array containing column indexes for index
public int[]	Returns: int[] getDefaultColumnMap() Returns the array containing 0, 1, ...
public int	Returns: ordinal value getIndexOrderValue() Returns a value indicating the order of different types of index in the list of indexes for a table.
public long	getPersistenceId()
public int	getPosition()
public TableBase	getTable()
public void	insert(Session session, PersistentStore store, Row row) Insert a node into the index
public boolean	isClustered()
public boolean	isConstraint() Does this index belong to a constraint?
public boolean	isEmpty(PersistentStore store)
public boolean	isForward()
public boolean	isPrimaryKey() Is this a PRIMARY_KEY index?
public boolean	isUnique() Is this a UNIQUE index?
public RowIterator	Returns: Iterator from last row lastRow(Session Session session, PersistentStore PersistentStore store, int int distinctCount, boolean[] boolean[] usedColumnCheck) Returns the row for the last node of the index
public double[]	searchCost(Session session, PersistentStore store)
public void	setClustered(boolean clustered)
public void	setPosition(int position)
public void	setTable(TableBase table)
public long	size(Session session, PersistentStore store) Returns the node count.
public long	sizeUnique(PersistentStore store)

Inherited from org.hsqldb.SchemaObject:: compile getCatalogName getChangeTimestamp getComponents getName getOwner getReferences getSchemaName getSQL getType

cachedFactor	back to summary
public static final double cachedFactor

emptyArray	back to summary
public static final Index[] emptyArray Hides org.hsqldb.SchemaObject.emptyArray.

emptyUseArray	back to summary
public static final Index.IndexUse[] emptyUseArray

INDEX_NON_UNIQUE	back to summary
public static final int INDEX_NON_UNIQUE

INDEX_NONE	back to summary
public static final int INDEX_NONE

INDEX_UNIQUE	back to summary
public static final int INDEX_UNIQUE

minimumSelectivity	back to summary
public static final double minimumSelectivity

probeDepth	back to summary
public static final int probeDepth

Method Detail

asArray	back to summary
public Index.IndexUse[] asArray()

compareRow	back to summary
public int compareRow(Session session, Object[] a, Object[] b)

compareRowNonUnique	back to summary
public int compareRowNonUnique(Session session, Object[] a, Object[] b, int[] rowColMap) Compares two table rows based on the columns of this index. The rowColMap parameter specifies which columns of the other table are to be compared with the colIndex columns of this index. The rowColMap can cover all or only some columns of this index. Parameters session:Session Session a:Object[] row from another table b:Object[] a full row in this table rowColMap:int[] column indexes in the other table Returns:int comparison result, -1,0,+1

compareRowNonUnique

back to summary

public int compareRowNonUnique(Session session, Object[] a, Object[] b, int[] rowColMap)

Compares two table rows based on the columns of this index. The rowColMap parameter specifies which columns of the other table are to be compared with the colIndex columns of this index. The rowColMap can cover all or only some columns of this index.

Parameters

session:Session: Session
a:Object[]: row from another table
b:Object[]: a full row in this table
rowColMap:int[]: column indexes in the other table

Returns:int

comparison result, -1,0,+1

compareRowNonUnique	back to summary
public int compareRowNonUnique(Session session, Object[] a, Object[] b, int[] rowColMap, int fieldCount)

compareRowNonUnique	back to summary
public int compareRowNonUnique(Session session, Object[] a, Object[] b, int fieldcount) As above but use the index column data

delete	back to summary
public void delete(Session session, PersistentStore store, Row row)

existsParent	back to summary
public boolean existsParent(Session session, PersistentStore store, Object[] rowdata, int[] rowColMap)

findFirstRow	back to summary
public RowIterator findFirstRow(Session session, PersistentStore store, Object[] rowdata, int matchCount, int distinctCount, int compareType, boolean reversed, boolean[] map) Return the first node equal to the indexdata object. The rowdata has the same column mapping as this index. Parameters session:Session session object store:PersistentStore store object rowdata:Object[] Object[] matchCount:int count of columns to match distinctCount:int int compareType:int int reversed:boolean boolean map:boolean[] boolean[] Returns:RowIterator iterator

findFirstRow

back to summary

public RowIterator findFirstRow(Session session, PersistentStore store, Object[] rowdata, int matchCount, int distinctCount, int compareType, boolean reversed, boolean[] map)

Return the first node equal to the indexdata object. The rowdata has the same column mapping as this index.

Parameters

session:Session: session object
store:PersistentStore: store object
rowdata:Object[]: Object[]
matchCount:int: count of columns to match
distinctCount:int: int
compareType:int: int
reversed:boolean: boolean
map:boolean[]: boolean[]

Returns:RowIterator

iterator

findFirstRow	back to summary
public RowIterator findFirstRow(Session session, PersistentStore store, Object[] rowdata) Return the first node equal to the rowdata object. The rowdata has the same column mapping as this table. Parameters session:Session session object store:PersistentStore store object rowdata:Object[] array containing table row data Returns:RowIterator iterator

findFirstRow

back to summary

public RowIterator findFirstRow(Session session, PersistentStore store, Object[] rowdata)

Return the first node equal to the rowdata object. The rowdata has the same column mapping as this table.

Parameters

session:Session: session object
store:PersistentStore: store object
rowdata:Object[]: array containing table row data

Returns:RowIterator

iterator

findFirstRow	back to summary
public RowIterator findFirstRow(Session session, PersistentStore store, Object[] rowdata, int[] rowColMap) Return the first node equal to the rowdata object. The rowdata has the column mapping provided in rowColMap. Parameters session:Session session object store:PersistentStore store object rowdata:Object[] array containing table row data rowColMap:int[] int[] Returns:RowIterator iterator

findFirstRow

back to summary

public RowIterator findFirstRow(Session session, PersistentStore store, Object[] rowdata, int[] rowColMap)

Return the first node equal to the rowdata object. The rowdata has the column mapping provided in rowColMap.

Parameters

session:Session: session object
store:PersistentStore: store object
rowdata:Object[]: array containing table row data
rowColMap:int[]: int[]

Returns:RowIterator

iterator

findFirstRowNotNull	back to summary
public RowIterator findFirstRowNotNull(Session session, PersistentStore store) Finds the first node where the data is not null. Parameters session:Session Session store:PersistentStore PersistentStore Returns:RowIterator iterator

findFirstRowNotNull

back to summary

public RowIterator findFirstRowNotNull(Session session, PersistentStore store)

Finds the first node where the data is not null.

Parameters

session:Session: Session
store:PersistentStore: PersistentStore

Returns:RowIterator

iterator

firstRow	back to summary
public RowIterator firstRow(PersistentStore store)

firstRow	back to summary
public RowIterator firstRow(Session session, PersistentStore store, RangeVariable.RangeVariableConditions[] conditions, int distinctCount, boolean[] map) Returns the row for the first node of the index Returns:RowIterator Iterator for first row

firstRow

back to summary

public RowIterator firstRow(Session session, PersistentStore store, RangeVariable.RangeVariableConditions[] conditions, int distinctCount, boolean[] map)

Returns the row for the first node of the index

Returns:RowIterator: Iterator for first row

getColumnCount	back to summary
public int getColumnCount() Returns the count of visible columns used

getColumnDesc	back to summary
public boolean[] getColumnDesc() Returns the array containing desc column flags Returns:boolean[] boolean[]

getColumnDesc

back to summary

public boolean[] getColumnDesc()

Returns the array containing desc column flags

Returns:boolean[]: boolean[]

getColumns	back to summary
public int[] getColumns() Returns the array containing column indexes for index Returns:int[] int[]

getColumns

back to summary

public int[] getColumns()

Returns the array containing column indexes for index

Returns:int[]: int[]

getColumnTypes	back to summary
public Type[] getColumnTypes() Returns the array containing column indexes for index Returns:Type[] Type[]

getColumnTypes

back to summary

public Type[] getColumnTypes()

Returns the array containing column indexes for index

Returns:Type[]: Type[]

getDefaultColumnMap	back to summary
public int[] getDefaultColumnMap() Returns the array containing 0, 1, ... column indexes Returns:int[] int[]

getDefaultColumnMap

back to summary

public int[] getDefaultColumnMap()

Returns the array containing 0, 1, ... column indexes

Returns:int[]: int[]

getIndexOrderValue	back to summary
public int getIndexOrderValue() Returns a value indicating the order of different types of index in the list of indexes for a table. The position of the groups of Indexes in the list in ascending order is as follows: primary key index unique constraint indexes autogenerated foreign key indexes for FK's that reference this table or tables created before this table user created indexes (CREATE INDEX) autogenerated foreign key indexes for FK's that reference tables created after this table Among a group of indexes, the order is based on the order of creation of the index. Returns:int ordinal value

getIndexOrderValue

back to summary

public int getIndexOrderValue()

Returns a value indicating the order of different types of index in the list of indexes for a table. The position of the groups of Indexes in the list in ascending order is as follows: primary key index unique constraint indexes autogenerated foreign key indexes for FK's that reference this table or tables created before this table user created indexes (CREATE INDEX) autogenerated foreign key indexes for FK's that reference tables created after this table Among a group of indexes, the order is based on the order of creation of the index.

Returns:int: ordinal value

getPersistenceId	back to summary
public long getPersistenceId()

getPosition	back to summary
public int getPosition()

getTable	back to summary
public TableBase getTable()

insert	back to summary
public void insert(Session session, PersistentStore store, Row row) Insert a node into the index

isClustered	back to summary
public boolean isClustered()

isConstraint	back to summary
public boolean isConstraint() Does this index belong to a constraint?

isEmpty	back to summary
public boolean isEmpty(PersistentStore store)

isForward	back to summary
public boolean isForward()

isPrimaryKey	back to summary
public boolean isPrimaryKey() Is this a PRIMARY_KEY index?

isUnique	back to summary
public boolean isUnique() Is this a UNIQUE index?

lastRow	back to summary
public RowIterator lastRow(Session session, PersistentStore store, int distinctCount, boolean[] usedColumnCheck) Returns the row for the last node of the index Parameters session:Session Session store:PersistentStore PersistentStore distinctCount:int int usedColumnCheck:boolean[] boolean[] Returns:RowIterator Iterator from last row

lastRow

back to summary

public RowIterator lastRow(Session session, PersistentStore store, int distinctCount, boolean[] usedColumnCheck)

Returns the row for the last node of the index

Parameters

session:Session: Session
store:PersistentStore: PersistentStore
distinctCount:int: int
usedColumnCheck:boolean[]: boolean[]

Returns:RowIterator

Iterator from last row

searchCost	back to summary
public double[] searchCost(Session session, PersistentStore store)

setClustered	back to summary
public void setClustered(boolean clustered)

setPosition	back to summary
public void setPosition(int position)

setTable	back to summary
public void setTable(TableBase table)

size	back to summary
public long size(Session session, PersistentStore store) Returns the node count.

sizeUnique	back to summary
public long sizeUnique(PersistentStore store)

public Interface Index

Nested and Inner Type Summary

Field Summary

Method Summary

Field Detail

Method Detail

public Class Index.IndexUse

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail