Package com.arcadedb.index
Interface Index
-
- All Known Subinterfaces:
IndexInternal
,RangeIndex
- All Known Implementing Classes:
LSMTreeFullTextIndex
,LSMTreeIndex
,TypeIndex
public interface Index
Basic Index interface.
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static interface
Index.BuildIndexCallback
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description long
countEntries()
IndexCursor
get(Object[] keys)
Retrieves the set of RIDs associated to a key.IndexCursor
get(Object[] keys, int limit)
Retrieves the set of RIDs associated to a key with a limit for the result.int
getAssociatedBucketId()
String
getName()
LSMTreeIndexAbstract.NULL_STRATEGY
getNullStrategy()
int
getPageSize()
List<String>
getPropertyNames()
Schema.INDEX_TYPE
getType()
String
getTypeName()
boolean
isAutomatic()
boolean
isCompacting()
boolean
isUnique()
void
put(Object[] keys, RID[] rid)
Add multiple values for one key in the index.void
remove(Object[] keys)
Removes the keys from the index.void
remove(Object[] keys, Identifiable rid)
Removes an entry keys/record entry from the index.boolean
scheduleCompaction()
void
setNullStrategy(LSMTreeIndexAbstract.NULL_STRATEGY nullStrategy)
boolean
supportsOrderedIterations()
-
-
-
Method Detail
-
get
IndexCursor get(Object[] keys)
Retrieves the set of RIDs associated to a key.
-
get
IndexCursor get(Object[] keys, int limit)
Retrieves the set of RIDs associated to a key with a limit for the result.
-
put
void put(Object[] keys, RID[] rid)
Add multiple values for one key in the index.- Parameters:
keys
-rid
- as an array of RIDs
-
remove
void remove(Object[] keys)
Removes the keys from the index.- Parameters:
keys
-
-
remove
void remove(Object[] keys, Identifiable rid)
Removes an entry keys/record entry from the index.
-
countEntries
long countEntries()
-
isCompacting
boolean isCompacting()
-
scheduleCompaction
boolean scheduleCompaction()
-
getType
Schema.INDEX_TYPE getType()
-
getTypeName
String getTypeName()
-
getName
String getName()
-
getNullStrategy
LSMTreeIndexAbstract.NULL_STRATEGY getNullStrategy()
-
setNullStrategy
void setNullStrategy(LSMTreeIndexAbstract.NULL_STRATEGY nullStrategy)
-
isUnique
boolean isUnique()
-
getAssociatedBucketId
int getAssociatedBucketId()
-
supportsOrderedIterations
boolean supportsOrderedIterations()
-
isAutomatic
boolean isAutomatic()
-
getPageSize
int getPageSize()
-
-