Package io.permazen

Class PermazenCompositeIndex

java.lang.Object

io.permazen.PermazenSchemaItem

io.permazen.PermazenCompositeIndex

public class PermazenCompositeIndex
extends PermazenSchemaItem

A composite index.

Method Summary

Modifier and Type	Method	Description
List<PermazenSimpleField>	getFields()	Get the PermazenSimpleFields on which this index is based.
Object	getIndex(PermazenTransaction ptx)	View this index.
CompositeIndex	getSchemaItem()	Get the corresonding core API database instance.

Methods inherited from class io.permazen.PermazenSchemaItem

getName, getSchemaId, getStorageId, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Details

getFields

public List<PermazenSimpleField> getFields()

Get the PermazenSimpleFields on which this index is based.

Returns:

this index's fields, in indexed order

getIndex

public Object getIndex(PermazenTransaction ptx)

View this index.

The returned index will have time Index2, Index3, etc., depending on the number of fields indexed.

Parameters:

ptx - transaction

Returns:

view of this index in ptx

Throws:

StaleTransactionException - if ptx is no longer usable

IllegalArgumentException - if ptx is null

getSchemaItem

public CompositeIndex getSchemaItem()

Description copied from class: PermazenSchemaItem

Get the corresonding core API database instance.

Overrides:

getSchemaItem in class PermazenSchemaItem

Returns:

this instance's correpsonding SchemaItem