Index (Apache Jena - DBOE Indexes 4.0.0)

All Superinterfaces:

org.apache.jena.atlas.lib.Closeable, java.lang.Iterable<Record>, org.apache.jena.atlas.lib.Sync

All Known Subinterfaces:

RangeIndex

All Known Implementing Classes:

IndexLogger, IndexMap, IndexWrapper, RangeIndexLogger, RangeIndexWrapper
```
public interface Index
extends java.lang.Iterable<Record>, org.apache.jena.atlas.lib.Sync, org.apache.jena.atlas.lib.Closeable
```

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`void`	`check()`	Perform checks on this index
`void`	`clear()`	Clear the index
`void`	`close()`	Close the index - can not be used again through this object
`boolean`	`contains(Record record)`	Return whether the index contains the record or not.
`boolean`	`delete(Record record)`	Delete a record - Return true if a record was actually removed
`Record`	`find(Record record)`	Find one record - and return the record actually in the index (may have a value part)
`RecordFactory`	`getRecordFactory()`	Get the Record factory associated with this index
`boolean`	`insert(Record record)`	Insert a record - return true if an insertion was actually needed
`boolean`	`isEmpty()`	Answer whether the index is empty or not.
`java.util.Iterator<Record>`	`iterator()`	Iterate over the whole index
`long`	`size()`	Return size if known else return -1 : does not count the persistent storage

Methods inherited from interface java.lang.Iterable
forEach, spliterator

Methods inherited from interface org.apache.jena.atlas.lib.Sync
sync

- Method Detail
  - find
```
Record find(Record record)
```
    Find one record - and return the record actually in the index (may have a value part)
  - contains
```
boolean contains(Record record)
```
    Return whether the index contains the record or not.
  - insert
```
boolean insert(Record record)
```
    Insert a record - return true if an insertion was actually needed
  - delete
```
boolean delete(Record record)
```
    Delete a record - Return true if a record was actually removed
  - iterator
```
java.util.Iterator<Record> iterator()
```
    Iterate over the whole index
    
    Specified by:
    
    iterator in interface java.lang.Iterable<Record>
  - getRecordFactory
```
RecordFactory getRecordFactory()
```
    Get the Record factory associated with this index
  - close
```
void close()
```
    Close the index - can not be used again through this object
    
    Specified by:
    
    close in interface org.apache.jena.atlas.lib.Closeable
  - isEmpty
```
boolean isEmpty()
```
    Answer whether the index is empty or not. May return false for unknown or meaningless
  - clear
```
void clear()
```
    Clear the index
  - check
```
void check()
```
    Perform checks on this index
  - size
```
long size()
```
    Return size if known else return -1 : does not count the persistent storage