edu.umd.cs.psl.database.rdbms

Class RDBMSDataStore

java.lang.Object

edu.umd.cs.psl.database.rdbms.RDBMSDataStore

All Implemented Interfaces:

DataStore

public class RDBMSDataStore
extends Object
implements DataStore

The RDMBSDataStore is an RDBMS implementation of the DataStore interface. It will connect to any RDBMS that has a supporting DatabaseDriver implementation, and through the ConfigBundle can use custom names for its value, confidence, and partition columns.

The ConfigBundle can also specify whether or not this RDBMSDatabase should use RDBMSUniqueStringID for its UniqueID implementation (as opposed to using RDBMSUniqueIntID).

Author:

Eric Norris

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONFIDENCE_COLUMN_DEFAULT Default value for the CONFIDENCE_COLUMN_KEY property
static String	CONFIDENCE_COLUMN_KEY Key for String property for the name of the confidence column in the database.
static String	CONFIG_PREFIX Prefix of property keys used by this class.
static String	PARTITION_COLUMN_DEFAULT Default value for the PARTITION_COLUMN_KEY property
static String	PARTITION_COLUMN_KEY Key for String property for the name of the partition column in the database.
static boolean	USE_STRING_ID_DEFAULT Default value for the USE_STRING_ID_KEY property
static String	USE_STRING_ID_KEY Key for boolean property of whether to use RDBMSUniqueStringID as a UniqueID.
static String	VALUE_COLUMN_DEFAULT Default value for the VALUE_COLUMN_KEY property
static String	VALUE_COLUMN_KEY Key for String property for the name of the value column in the database.

Constructor Summary

Constructors

Constructor and Description
RDBMSDataStore(DatabaseDriver dbDriver, ConfigBundle config) Returns an RDBMSDataStore that utilizes the connection created by the DatabaseDriver.

Method Summary

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.
static String	getDatabaseID(RDBMSDatabase db) Registers and returns an ID for a given RDBMSDatabase.
Inserter	getInserter(StandardPredicate predicate, Partition partition) Creates an Inserter for persisting new GroundAtoms in a Partition.
Partition	getNextPartition() Get the next available partition
Set<StandardPredicate>	getRegisteredPredicates() Returns the set of StandardPredicates registered with this DataStore.
static String	getSimilarityFunctionID(ExternalFunction extFun) Registers and returns an ID for a given ExternalFunction.
UniqueID	getUniqueID(Object key) Returns a UniqueID based on the given key.
Updater	getUpdater(StandardPredicate predicate, Partition partition) Creates an Updater for updating GroundAtoms persisted in a Partition.
static double	registeredExternalFunctionCall(String databaseID, String functionID, String... args) Used by the RDBMS to make an external function call.
void	registerPredicate(StandardPredicate predicate) Registers a StandardPredicate so that GroundAtoms of that StandardPredicate can be persisted in this DataStore.
protected void	releasePartitions(RDBMSDatabase db)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CONFIG_PREFIX

public static final String CONFIG_PREFIX

Prefix of property keys used by this class.

See Also:

ConfigManager, Constant Field Values

VALUE_COLUMN_KEY

public static final String VALUE_COLUMN_KEY

Key for String property for the name of the value column in the database.

See Also:

Constant Field Values

VALUE_COLUMN_DEFAULT

public static final String VALUE_COLUMN_DEFAULT

Default value for the VALUE_COLUMN_KEY property

See Also:

Constant Field Values

CONFIDENCE_COLUMN_KEY

public static final String CONFIDENCE_COLUMN_KEY

Key for String property for the name of the confidence column in the database.

See Also:

Constant Field Values

CONFIDENCE_COLUMN_DEFAULT

public static final String CONFIDENCE_COLUMN_DEFAULT

Default value for the CONFIDENCE_COLUMN_KEY property

See Also:

Constant Field Values

PARTITION_COLUMN_KEY

public static final String PARTITION_COLUMN_KEY

Key for String property for the name of the partition column in the database.

See Also:

Constant Field Values

PARTITION_COLUMN_DEFAULT

public static final String PARTITION_COLUMN_DEFAULT

Default value for the PARTITION_COLUMN_KEY property

See Also:

Constant Field Values

USE_STRING_ID_KEY

public static final String USE_STRING_ID_KEY

Key for boolean property of whether to use RDBMSUniqueStringID as a UniqueID.

See Also:

Constant Field Values

USE_STRING_ID_DEFAULT

public static final boolean USE_STRING_ID_DEFAULT

Default value for the USE_STRING_ID_KEY property

See Also:

Constant Field Values

Constructor Detail

RDBMSDataStore

public RDBMSDataStore(DatabaseDriver dbDriver,
              ConfigBundle config)

Returns an RDBMSDataStore that utilizes the connection created by the DatabaseDriver.

Parameters:

dbDriver - the DatabaseDriver that contains a connection to the backing database.

config - the configuration for this DataStore.

Method Detail

registerPredicate

public void registerPredicate(StandardPredicate predicate)

Description copied from interface: DataStore

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.

Specified by:

registerPredicate in interface DataStore

Parameters:

predicate - the predicate to register

getDatabase

public Database getDatabase(Partition write,
                   Partition... read)

Description copied from interface: DataStore

Creates a Database that can read from and write to a Partition and optionally read from additional Partitions.

Specified by:

getDatabase in interface DataStore

Parameters:

write - the Partition to write to and read from

read - additional Partitions to read from

Returns:

a new Database backed by this DataStore

getDatabase

public Database getDatabase(Partition write,
                   Set<StandardPredicate> toClose,
                   Partition... read)

Description copied from interface: DataStore

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.

Specified by:

getDatabase in interface DataStore

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

getUniqueID

public UniqueID getUniqueID(Object key)

Description copied from interface: DataStore

Returns a UniqueID based on the given key.

An Integer must always be a valid key. Other types may be supported by implementations and/or configurations.

If two keys are equal, they must map to the same UniqueID.

Specified by:

getUniqueID in interface DataStore

Parameters:

key - the key to a UniqueID

Returns:

the UniqueID indicated by key

getInserter

public Inserter getInserter(StandardPredicate predicate,
                   Partition partition)

Description copied from interface: DataStore

Creates an Inserter for persisting new GroundAtoms in a Partition.

Specified by:

getInserter in interface DataStore

Parameters:

predicate - the Predicate of the Atoms to be inserted

partition - the Partition into which Atoms will be inserted

Returns:

the Inserter

getUpdater

public Updater getUpdater(StandardPredicate predicate,
                 Partition partition)

Description copied from interface: DataStore

Creates an Updater for updating GroundAtoms persisted in a Partition.

Specified by:

getUpdater in interface DataStore

Parameters:

predicate - the Predicate of the Atoms to be updated

partition - the Partition of the Atoms to be updated

Returns:

the Updater

getRegisteredPredicates

public Set<StandardPredicate> getRegisteredPredicates()

Description copied from interface: DataStore

Returns the set of StandardPredicates registered with this DataStore. Note that the result can differ from calling Database.getRegisteredPredicates() on an associated Database, since additional predicates might have been registered since that Database was created.

Specified by:

getRegisteredPredicates in interface DataStore

Returns:

the set of StandardPredicates registered with this DataStore

deletePartition

public int deletePartition(Partition partition)

Description copied from interface: DataStore

Deletes all GroundAtoms persisted in a Partition.

Specified by:

deletePartition in interface DataStore

Parameters:

partition - the partition to delete

Returns:

the number of Atoms deleted

getNextPartition

public Partition getNextPartition()

Description copied from interface: DataStore

Get the next available partition

Specified by:

getNextPartition in interface DataStore

Returns:

the next available partition

close

public void close()

Description copied from interface: DataStore

Releases all resources and locks obtained by this DataStore.

Specified by:

close in interface DataStore

releasePartitions

protected void releasePartitions(RDBMSDatabase db)

getSimilarityFunctionID

public static final String getSimilarityFunctionID(ExternalFunction extFun)

Registers and returns an ID for a given ExternalFunction. If this function was already registered, returns the same ID that was returned initially.

Parameters:

extFun - the ExternalFunction to register

Returns:

the String ID for this function

getDatabaseID

public static final String getDatabaseID(RDBMSDatabase db)

Registers and returns an ID for a given RDBMSDatabase. If this database was already registered, returns the same ID that was returned initially.

Parameters:

db - the RDBMSDatabase to register

Returns:

the String ID for this database

registeredExternalFunctionCall

public static final double registeredExternalFunctionCall(String databaseID,
                                    String functionID,
                                    String... args)

Used by the RDBMS to make an external function call.

Parameters:

databaseID - the ID for the RDBMSDatabase associated with this function call

functionID - the ID of the ExternalFunction to execute

args - the arguments for the ExternalFunction

Returns:

the result from the ExternalFunction