oracle.kv.table

Interface IndexKey

All Superinterfaces:

Comparable<FieldValue>, FieldValue, RecordValue

public interface IndexKey
extends RecordValue

IndexKey is a specialization of RecordValue to represent a key used to access a specific index defined on a table. It may contain all or part of a the fields associated with the index. If partial the fields must be set in order of significance, as defined by the list returned by getFields(). If an attempt is made to set a field that is not part of the index IllegalArgumentException is thrown.

IndexKey objects are constructed using createIndexKey.

Since:

3.0

Method Summary

Methods

Modifier and Type	Method and Description
List<String>	getFields() Returns an unmodifiable list of fields, in key order, that comprise this key.
Index	getIndex() Returns the Index associated with this key.

Methods inherited from interface oracle.kv.table.RecordValue

clone, contains, copyFrom, get, getDefinition, isEmpty, put, put, put, put, put, put, put, put, putArray, putArrayAsJson, putArrayAsJson, putEnum, putFixed, putMap, putMapAsJson, putMapAsJson, putNull, putRecord, putRecordAsJson, putRecordAsJson, remove, size, toString

Methods inherited from interface oracle.kv.table.FieldValue

asArray, asBinary, asBoolean, asDouble, asEnum, asFixedBinary, asFloat, asIndexKey, asInteger, asLong, asMap, asPrimaryKey, asRecord, asRow, asString, getType, isArray, isBinary, isBoolean, isDouble, isEnum, isFixedBinary, isFloat, isIndexKey, isInteger, isLong, isMap, isNull, isPrimaryKey, isRecord, isRow, isString, toJsonString

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

getIndex

Index getIndex()

Returns the Index associated with this key.

Returns:

the Index

getFields

List<String> getFields()

Returns an unmodifiable list of fields, in key order, that comprise this key. This method returns the same list as Index.getFields() for this instance's Index.

Specified by:

getFields in interface RecordValue

Returns:

the fields

Since:

3.0.6