SimpleSpaceBase (SpaceBase 2.1)

java.lang.Object
- co.paralleluniverse.spacebase.simple.SimpleSpaceBase<T>

Direct Known Subclasses:

SimpleSpaceBaseWithExpiration
```
public class SimpleSpaceBase<T>
extends Object
```
A wrapper around a SpaceBase instance providing a simple, non-visitor based API, for applications making a basic CRUD use of SpaceBase.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class SimpleSpaceBase.ExecutionMode

Nested Classes
Modifier and Type	Class and Description
`static class`	`SimpleSpaceBase.ExecutionMode`

Constructor Summary

Constructors
Constructor and Description
`SimpleSpaceBase(SpaceBase<T> base)` Creates a new SimpleSpaceBase instance wrapping an existing `SpaceBase`
`SimpleSpaceBase(String name, int dims, SimpleSpaceBase.ExecutionMode mode, int parallelism)` Creates a new SimpleSpaceBase.

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`contains(SpatialToken token)` Checks if the spatial element represented by a `SpatialToken` currently exists in the data-store.
`void`	`delete(SpatialToken token)` Deletes an element from the data store.
`SpatialToken`	`find(T elem, AABB aabb)` Finds an element’s token that can be used for update and delete.
`ElementAndBounds<T>`	`getElement(SpatialToken token)` Returns the spatial element represented by a `SpatialToken`.
`String`	`getName()` Returns the SpaceBase store’s name.
`SpaceBase<T>`	`getSpaceBase()` Returns the wrapped `SpaceBase` instance.
`SpatialToken`	`insert(T elem, AABB aabb)` Inserts an element to the data store.
`<T2> Collection<co.paralleluniverse.common.util.Pair<T,T2>>`	`join(SimpleSpaceBase<T2> other, SpatialJoinQuery<? super T,? super T2> joinQuery)` Performs a spatial join on the store and another store, and visits every pair of elements - an element from each store - matching it one at a time.
`Collection<co.paralleluniverse.common.util.Pair<T,T>>`	`join(SpatialJoinQuery<? super T,? super T> joinQuery)` Performs a spatial join on the store, and visits every pair of elements matching it one at a time.
`<T2> Collection<co.paralleluniverse.common.util.Pair<T,T2>>`	`join(SpatialQuery<Object> region, SimpleSpaceBase<T2> other, SpatialJoinQuery<? super T,? super T2> joinQuery)` Performs a spatial join on a region of the store and another store, and visits every pair of elements - an element from each store - matching it one at a time.
`Collection<co.paralleluniverse.common.util.Pair<T,T>>`	`join(SpatialQuery<Object> region, SpatialJoinQuery<? super T,? super T> joinQuery)` Performs a spatial join on a region of the store, and visits every pair of elements matching it one at a time.
`Collection<T>`	`query(SpatialQuery<? super T> query)` Performs a query on the store and visits all of the elements matching it, one at a time, for a read-only operation.
`int`	`size()` Returns the number of elements currently in the store.
`void`	`update(SpatialToken token, AABB newAABB)` Updates the data store with a new bounding-box for an element which has already been inserted into the store.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - SimpleSpaceBase
```
public SimpleSpaceBase(String name,
               int dims,
               SimpleSpaceBase.ExecutionMode mode,
               int parallelism)
```
    Creates a new SimpleSpaceBase.
    
    Parameters:
    name - database name
    dims - 2 for 2D, 3 for 3D etc…
    mode - ExecutorMode.CONCURRENT will run the user tasks in the user context. Only cleanup tasks will run in the background.
    ExecutorMode.PARALLEL will run all the tasks in parallel.
    parallelism - The number of threads to use for background tasks.
  - SimpleSpaceBase
```
public SimpleSpaceBase(SpaceBase<T> base)
```
    Creates a new SimpleSpaceBase instance wrapping an existing SpaceBase
    
    Parameters:
    base - The SpaceBase instance to wrap.
- Method Detail
  - getSpaceBase
```
public SpaceBase<T> getSpaceBase()
```
    Returns the wrapped SpaceBase instance.
    
    Returns:
    The wrapped instance.
  - contains
```
public boolean contains(SpatialToken token)
```
    Checks if the spatial element represented by a SpatialToken currently exists in the data-store.
    
    Parameters:
    token - The token representing the element.
    
    Returns:
    true if the element represented by the token exists in the store, false otherwise.
  - insert
```
public SpatialToken insert(T elem,
                  AABB aabb)
```
    Inserts an element to the data store.
    In the current implementation, this method runs in O(log n) time.
    
    The aabb argument is copied by SpaceBase, so it may be modified by the user after passing it to this method.
    
    Parameters:
    elem - The element to be inserted.
    aabb - The element’s bounding-box.
    
    Returns:
    A token that may be used for deletion or update.
    
    Throws:
    
    IllegalStateException - If called from within a visitor.
  - size
```
public int size()
```
    Returns the number of elements currently in the store. This method runs in O(n) time.
    
    Returns:
    The number of elements in the store.
  - update
```
public void update(SpatialToken token,
          AABB newAABB)
```
    Updates the data store with a new bounding-box for an element which has already been inserted into the store. The bounding-box may shrink, expand or move arbitrarily, but must remain valid. If the element represented by the token no longer exists in the data-store, this call is ignored and returns normally.
    If the token has been obtained from another SpaceBase instance, this method may result in unexpected behavior.
    In the current implementation, this method runs in O(1) time in most cases, and in worst-case O(log n) time.
    The aabb argument is copied by SpaceBase, so it may be modified by the user after passing it to this method.
    
    Parameters:
    newAABB - The element’s new bounding-box.
    token - The token representing the element, which MUST have been obtained from this SpaceBase instance.
    
    Throws:
    
    IllegalArgumentException - if the token or bounds are null, or if the bounds are invalid.
    
    IllegalStateException - If called from within a visitor.
  - delete
```
public void delete(SpatialToken token)
```
    Deletes an element from the data store. The element is represented by a token. If the element represented by the token no longer exists in the data-store, this call is ignored and returns normally.
    If the token has been obtained from another SpaceBase instance, this method may result in unexpected behavior.
    In the current implementation, this method runs in O(1) time in most cases, and in worst-case O(log n) time.
    
    Parameters:
    token - The token representing the element, which MUST have been obtained from this SpaceBase instance.
    
    Throws:
    
    IllegalStateException - If called from within a visitor.
  - getName
```
public String getName()
```
    Returns the SpaceBase store’s name.
    
    Returns:
    The store’s name.
  - getElement
```
public ElementAndBounds<T> getElement(SpatialToken token)
```
    Returns the spatial element represented by a SpatialToken. If the element no longer exists in the data-store, this method returns null
    
    Parameters:
    token - The token representing the element.
    
    Returns:
    A simple container object holding the element represented by the token and its bounding-box, or null if the element no longer exists in the data-store.
  - find
```
public SpatialToken find(T elem,
                AABB aabb)
```
    Finds an element’s token that can be used for update and delete. If the element does not exist in the store, or if it was not found within its bounding-box, this method will return a SpatialToken that, when passed to contains() will yield false.
    The aabb argument is copied by SpaceBase, so it may be modified by the user after passing it to this method.
    
    Parameters:
    elem - The element.
    aabb - The element’s bounding-box.
    
    Returns:
    A token representing the element to be used for updates and deletions, or null if the element does not exist in the store, or if it was not found within its bounding-box.
    
    Throws:
    
    IllegalStateException - If called from within a visitor.
  - query
```
public Collection<T> query(SpatialQuery<? super T> query)
```
    Performs a query on the store and visits all of the elements matching it, one at a time, for a read-only operation.
    
    Parameters:
    query - The spatial query to perform.
    
    Returns:
    A collection of all elements matching the query.
  - join
```
public Collection<co.paralleluniverse.common.util.Pair<T,T>> join(SpatialJoinQuery<? super T,? super T> joinQuery)
```
    Performs a spatial join on the store, and visits every pair of elements matching it one at a time.
    
    Parameters:
    joinQuery - The spatial join to perform.
    
    Returns:
    A collection of all pairs of elements satisfying the join query.
  - join
```
public Collection<co.paralleluniverse.common.util.Pair<T,T>> join(SpatialQuery<Object> region,
                                                         SpatialJoinQuery<? super T,? super T> joinQuery)
```
    Performs a spatial join on a region of the store, and visits every pair of elements matching it one at a time.
    
    Parameters:
    region - A SpatialQuery defining the region in which to perform the spatial join. Only elements matching this query will be considered in the join.
    joinQuery - The spatial join to perform.
    
    Returns:
    A collection of all pairs of elements satisfying the join query.
  - join
```
public <T2> Collection<co.paralleluniverse.common.util.Pair<T,T2>> join(SimpleSpaceBase<T2> other,
                                                               SpatialJoinQuery<? super T,? super T2> joinQuery)
```
    Performs a spatial join on the store and another store, and visits every pair of elements - an element from each store - matching it one at a time. The first element in each joined pair is a member of this SpaceBase instance, while the second is a member of the instance passed as the other parameter.
    
    Parameters:
    other - The second SpaceBase instance to be used in the join. The second element in each joined pair will come from other
    joinQuery - The spatial join to perform.
    
    Returns:
    A collection of all pairs of elements satisfying the join query.
  - join
```
public <T2> Collection<co.paralleluniverse.common.util.Pair<T,T2>> join(SpatialQuery<Object> region,
                                                               SimpleSpaceBase<T2> other,
                                                               SpatialJoinQuery<? super T,? super T2> joinQuery)
```
    Performs a spatial join on a region of the store and another store, and visits every pair of elements - an element from each store - matching it one at a time. The first element in each joined pair is a member of this SpaceBase instance, while the second is a member of the instance passed as the other parameter.
    
    Parameters:
    other - The second SpaceBase instance to be used in the join. The second element in each joined pair will come from other
    region - A SpatialQuery defining the region (of both stores) in which to perform the spatial join. Only elements, in either store, matching this query will be considered in the join.
    joinQuery - The spatial join to perform.
    
    Returns:
    A collection of all pairs of elements satisfying the join query.

Class SimpleSpaceBase<T>

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SimpleSpaceBase

SimpleSpaceBase

Method Detail

getSpaceBase

contains

insert

size

update

delete

getName

getElement

find

query

join

join

join

join