H2 Database Engine 2.3.232 · org.h2.index.IndexSort · APIdia, the JavaDoc alternative

Modifier and Type	Field and Description
public static final int	FULLY_SORTED Used instead of actual number of sorted columns when post-sorting isn't needed.
private final Index	index
private final boolean	reverse Whether index must be iterated in reverse order.
private final int	sortedColumns A positive number of sorted columns for partial index sorts, or `FULLY_SORTED` for complete index sorts.

Access	Constructor and Description
public	IndexSort(Index the index index, boolean whether index must be iterated in reverse order reverse) Creates an index sorting information for complete index sort.
public	IndexSort(Index the index index, int a positive number of sorted columns for partial index sorts, or `FULLY_SORTED` for complete index sorts sortedColumns, boolean whether index must be iterated in reverse order reverse) Creates an index sorting information for index sort.

Method Summary

Modifier and Type	Method and Description
public int	compareTo(IndexSort the object to be compared. o) Implements java.lang.Comparable.compareTo. Compares this object with the specified object for order.
public Index	Returns: the index getIndex() Returns the index.
public int	Returns: positive number of sorted columns for partial index sorts, or `FULLY_SORTED` for complete index sorts getSortedColumns() Returns number of sorted columns.
public boolean	Returns: `true` for reverse order, `false` for natural order isReverse() Returns whether index must be iterated in reverse order.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

FULLY_SORTED	back to summary
public static final int FULLY_SORTED Used instead of actual number of sorted columns when post-sorting isn't needed.

index	back to summary
private final Index index

reverse	back to summary
private final boolean reverse Whether index must be iterated in reverse order.

sortedColumns	back to summary
private final int sortedColumns A positive number of sorted columns for partial index sorts, or `FULLY_SORTED` for complete index sorts.

Constructor Detail

IndexSort	back to summary
public IndexSort(Index index, boolean reverse) Creates an index sorting information for complete index sort. Parameters index:Index the index reverse:boolean whether index must be iterated in reverse order

IndexSort

back to summary

public IndexSort(Index index, boolean reverse)

Creates an index sorting information for complete index sort.

Parameters

index:Index: the index
reverse:boolean: whether index must be iterated in reverse order

IndexSort back to summary

IndexSort	back to summary
public IndexSort(Index index, int sortedColumns, boolean reverse) Creates an index sorting information for index sort. Parameters index:Index the index sortedColumns:int a positive number of sorted columns for partial index sorts, or `FULLY_SORTED` for complete index sorts reverse:boolean whether index must be iterated in reverse order

public IndexSort(Index index, int sortedColumns, boolean reverse)

Creates an index sorting information for index sort.

Parameters

index:Index: the index
sortedColumns:int: a positive number of sorted columns for partial index sorts, or FULLY_SORTED for complete index sorts
reverse:boolean: whether index must be iterated in reverse order

Method Detail

compareTo back to summary

compareTo	back to summary
public int compareTo(IndexSort o) Implements java.lang.Comparable.compareTo. Doc from java.lang.Comparable.compareTo. Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object. The implementor must ensure `signum(x.compareTo(y)) == -signum(y.compareTo(x))` for all `x` and `y`. (This implies that `x.compareTo(y)` must throw an exception if and only if `y.compareTo(x)` throws an exception.) The implementor must also ensure that the relation is transitive: `(x.compareTo(y) > 0 && y.compareTo(z) > 0)` implies `x.compareTo(z) > 0`. Finally, the implementor must ensure that `x.compareTo(y)==0` implies that `signum(x.compareTo(z)) == signum(y.compareTo(z))`, for all `z`. Parameters o:IndexSort the object to be compared. Returns:int a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object. Annotations @Override

public int compareTo(IndexSort o)

Implements java.lang.Comparable.compareTo.

Doc from java.lang.Comparable.compareTo.

Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

The implementor must ensure signum(x.compareTo(y)) == -signum(y.compareTo(x)) for all x and y. (This implies that x.compareTo(y) must throw an exception if and only if y.compareTo(x) throws an exception.)

The implementor must also ensure that the relation is transitive: (x.compareTo(y) > 0 && y.compareTo(z) > 0) implies x.compareTo(z) > 0.

Finally, the implementor must ensure that x.compareTo(y)==0 implies that signum(x.compareTo(z)) == signum(y.compareTo(z)), for all z.

Parameters

o:IndexSort: the object to be compared.

Returns:int

a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

Annotations

@Override

getIndex	back to summary
public Index getIndex() Returns the index. Returns:Index the index

getIndex

back to summary

public Index getIndex()

Returns the index.

Returns:Index: the index

getSortedColumns back to summary

getSortedColumns	back to summary
public int getSortedColumns() Returns number of sorted columns. Returns:int positive number of sorted columns for partial index sorts, or `FULLY_SORTED` for complete index sorts

public int getSortedColumns()

Returns number of sorted columns.

Returns:int: positive number of sorted columns for partial index sorts, or FULLY_SORTED for complete index sorts

isReverse back to summary

isReverse	back to summary
public boolean isReverse() Returns whether index must be iterated in reverse order. Returns:boolean `true` for reverse order, `false` for natural order

public boolean isReverse()

Returns whether index must be iterated in reverse order.

Returns:boolean: true for reverse order, false for natural order

public final Class IndexSort

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail