NitriteRTree (Nitrite 4.2.0 API)

Type Parameters:

Key - the type parameter

Value - the type parameter

All Superinterfaces:

AutoCloseable
```
public interface NitriteRTree<Key,Value>
extends AutoCloseable
```
Represents an R-Tree in the nitrite database.

Since:

4.0

Author:

Anindya Chatterjee.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`void`	`add(Key key, NitriteId nitriteId)`	Adds a key to the rtree.
`void`	`clear()`	Clears the data.
`void`	`close()`	Closes this `NitriteRTree` instance.
`void`	`drop()`	Drops this instance.
`RecordStream<NitriteId>`	`findContainedKeys(Key key)`	Finds the contained keys from the rtree.
`RecordStream<NitriteId>`	`findIntersectingKeys(Key key)`	Finds the intersecting keys from the rtree.
`void`	`remove(Key key, NitriteId nitriteId)`	Removes a key from the rtree.
`long`	`size()`	Gets the size of the rtree.

- Method Detail
  - add
```
void add(Key key,
         NitriteId nitriteId)
```
    Adds a key to the rtree.
    
    Parameters:
    
    key - the key
    
    nitriteId - the nitrite id
  - remove
```
void remove(Key key,
            NitriteId nitriteId)
```
    Removes a key from the rtree.
    
    Parameters:
    
    key - the key
    
    nitriteId - the nitrite id
  - findIntersectingKeys
```
RecordStream<NitriteId> findIntersectingKeys(Key key)
```
    Finds the intersecting keys from the rtree.
    
    Parameters:
    
    key - the key
    
    Returns:
    
    the record stream
  - findContainedKeys
```
RecordStream<NitriteId> findContainedKeys(Key key)
```
    Finds the contained keys from the rtree.
    
    Parameters:
    
    key - the key
    
    Returns:
    
    the record stream
  - size
```
long size()
```
    Gets the size of the rtree.
    
    Returns:
    
    the size
  - close
```
void close()
```
    Closes this NitriteRTree instance.
    
    Specified by:
    
    close in interface AutoCloseable
  - clear
```
void clear()
```
    Clears the data.
  - drop
```
void drop()
```
    Drops this instance.