DataStore (psl 2.2.0-SNAPSHOT API)

All Known Implementing Classes:

RDBMSDataStore
```
public interface DataStore
```
Makes GroundAtoms available via Databases.
GroundAtoms with StandardPredicates can be persisted in a DataStore's Partitions. If a StandardPredicate has not been persisted before in a DataStore, it must be registered via registerPredicate(StandardPredicate).

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`close()` Releases all resources and locks obtained by this DataStore.
`int`	`deletePartition(Partition partition)` Deletes all `GroundAtoms` persisted in a Partition.
`Database`	`getDatabase(Partition write, Partition... read)` Creates a Database that can read from and write to a `Partition` and optionally read from additional Partitions.
`Database`	`getDatabase(Partition write, Set<StandardPredicate> toClose, Partition... read)` Creates a Database that can read from and write to a `Partition` and optionally read from additional Partitions.
`Inserter`	`getInserter(StandardPredicate predicate, Partition partition)` Creates an Inserter for persisting new `GroundAtoms` in a `Partition`.
`Partition`	`getNewPartition()` Requests a new `Partition` that is assigned an auto-generated name and the next unused ID.
`Collection<Database>`	`getOpenDatabases()` Get all the currenly open databases associated with this data store.
`Partition`	`getPartition(String partitionName)` Gets a new `Partition` of the DataStore with the given name.
`Set<Partition>`	`getPartitions()`
`Set<StandardPredicate>`	`getRegisteredPredicates()` Returns the set of StandardPredicates registered with this DataStore.
`void`	`registerPredicate(StandardPredicate predicate)` Registers a StandardPredicate so that `GroundAtoms` of that StandardPredicate can be persisted in this DataStore.

- Method Detail
  - registerPredicate
```
void registerPredicate(StandardPredicate predicate)
```
    Registers a StandardPredicate so that GroundAtoms of that StandardPredicate can be persisted in this DataStore.
    If GroundAtoms of a StandardPredicate were already persisted in this DataStore at initialization, that StandardPredicate is already registered.
    
    Parameters:
    
    predicate - the predicate to register
  - getPartition
```
Partition getPartition(String partitionName)
```
    Gets a new Partition of the DataStore with the given name. If the partition doesn't exist, a new one will be created and added to the DataStore metadata.
    
    Parameters:
    
    partitionName - a human-readable name for the partition
  - getDatabase
```
Database getDatabase(Partition write,
                     Partition... read)
```
    Creates a Database that can read from and write to a Partition and optionally read from additional Partitions.
    
    Parameters:
    
    write - the Partition to write to and read from
    
    read - additional Partitions to read from
    
    Returns:
    
    a new Database backed by this DataStore
    
    Throws:
    
    IllegalArgumentException - if write is in use or if read is the write Partition of another Database
  - getDatabase
```
Database getDatabase(Partition write,
                     Set<StandardPredicate> toClose,
                     Partition... read)
```
    Creates a Database that can read from and write to a Partition and optionally read from additional Partitions.
    Additionally, defines a set of StandardPredicates as closed in the Database, meaning that all GroundAtoms of that Predicate are ObservedAtoms.
    
    Parameters:
    
    write - the Partition to write to and read from
    
    toClose - set of StandardPredicates to close
    
    read - additional Partitions to read from
    
    Returns:
    
    a new Database backed by this DataStore
    
    Throws:
    
    IllegalArgumentException - if write is in use or if read is the write Partition of another Database
  - getOpenDatabases
```
Collection<Database> getOpenDatabases()
```
    Get all the currenly open databases associated with this data store.
  - getInserter
```
Inserter getInserter(StandardPredicate predicate,
                     Partition partition)
```
    Creates an Inserter for persisting new GroundAtoms in a Partition.
    
    Parameters:
    
    predicate - the Predicate of the Atoms to be inserted
    
    partition - the Partition into which Atoms will be inserted
    
    Returns:
    
    the Inserter
    
    Throws:
    
    IllegalArgumentException - if partition is in use or predicate is not registered
  - getRegisteredPredicates
```
Set<StandardPredicate> getRegisteredPredicates()
```
    Returns the set of StandardPredicates registered with this DataStore.
  - getPartitions
```
Set<Partition> getPartitions()
```
    Returns:
    
    a set containing all Partitions of this DataStore
  - deletePartition
```
int deletePartition(Partition partition)
```
    Deletes all GroundAtoms persisted in a Partition.
    
    Parameters:
    
    partition - the partition to delete
    
    Returns:
    
    the number of Atoms deleted
    
    Throws:
    
    IllegalArgumentException - if partition is in use
  - getNewPartition
```
Partition getNewPartition()
```
    Requests a new Partition that is assigned an auto-generated name and the next unused ID. This partition will remain in the datastore metadata unless explicitly deleted.
    
    Returns:
    
    new, unused partition
  - close
```
void close()
```
    Releases all resources and locks obtained by this DataStore.
    
    Throws:
    
    IllegalStateException - if any Partitions are in use

Interface DataStore

Method Summary

Method Detail

registerPredicate

getPartition

getDatabase

getDatabase

getOpenDatabases

getInserter

getRegisteredPredicates

getPartitions

deletePartition

getNewPartition

close