Package io.permazen.core

Class SimpleIndex<T>

java.lang.Object

io.permazen.core.SchemaItem

io.permazen.core.Index

io.permazen.core.SimpleIndex<T>

Type Parameters:

T - field's value type

Direct Known Subclasses:

ComplexSubFieldIndex, SimpleFieldIndex

public abstract class SimpleIndex<T>
extends Index

An index on a simple field, either a regular simple field or a sub-field of a complex field.

Method Summary

Modifier and Type	Method	Description
Encoding<T>	getEncoding()	Get the indexed field's encoding.
SimpleField<T>	getField()	Get the indexed field.
abstract CoreIndex1<T,ObjId>	getIndex(Transaction tx)	Get this index's view of the given transaction.
byte[]	getKey(ObjId id, T value)	Get the byte[] key in the underlying key/value store corresponding to the given value and target object in this index.
byte[]	getKey(T value)	Get the byte[] key in the underlying key/value store corresponding to the given value in this index.

Methods inherited from class io.permazen.core.Index

genericize, getEncodings, getFields, getKey, getKey, getObjType, isComposite, toString, visit

Methods inherited from class io.permazen.core.SchemaItem

getName, getSchema, getSchemaId, getStorageId

Methods inherited from class java.lang.Object

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

Method Details

getField

public SimpleField<T> getField()

Get the indexed field.

Returns:

the indexed field

getEncoding

public Encoding<T> getEncoding()

Get the indexed field's encoding.

Returns:

the indexed field's encoding

getIndex

public abstract CoreIndex1<T,ObjId> getIndex(Transaction tx)

Description copied from class: Index

Get this index's view of the given transaction.

Specified by:

getIndex in class Index

Parameters:

tx - transaction

Returns:

view of this index in tx

getKey

public byte[] getKey(T value)

Get the byte[] key in the underlying key/value store corresponding to the given value in this index.

The returned key will be the prefix of all index entries with the given value over all objects.

Parameters:

value - indexed value

Returns:

the corresponding KVDatabase key

See Also:

• KVTransaction.watchKey()

getKey

public byte[] getKey(ObjId id,
 T value)

Get the byte[] key in the underlying key/value store corresponding to the given value and target object in this index.

Parameters:

id - target object ID

value - indexed value

Returns:

the corresponding KVDatabase key

See Also:

• KVTransaction.watchKey()