org.objectweb.medor.datasource.api

Interface DataStore

Known Subinterfaces:
RdbDataStore
Known Implementing Classes:
BasicDataStore, ConnectionFactoryDataStore

public interface DataStore

Describes data stores, i.e., entities storing data, such as a relational database, an object-oriented database, an LDAP directory, a UDDI directory, an XML document store, a text file storage system, etc.

Field Summary

static short
JDBC_STORE
static short
MEDORTC_STORE
static short
ODMG_STORE
static short
TEXTFILE_STORE
static short
UDDI_STORE
static short
XMLDOCUMENT_STORE

Method Summary

String
getClientName()
Returns the name of the data store client.
short
getDataStoreType()
Returns the type of DataStore
String
getName()
Returns the symbolic name of the DataStore.
boolean
isCapable(short operationType)
Checks whether the current DataStore is capable of performing different types of operations.
boolean
isSameAs(DataStore ds)
Checks whether the current DataStore object represents the same data store as another DataStore object.
void
setClientName(String cName)
Sets the name of the data store client.

Field Details

JDBC_STORE

public static final short JDBC_STORE

Field Value:
1


MEDORTC_STORE

public static final short MEDORTC_STORE

Field Value:
0


ODMG_STORE

public static final short ODMG_STORE

Field Value:
3


TEXTFILE_STORE

public static final short TEXTFILE_STORE

Field Value:
2


UDDI_STORE

public static final short UDDI_STORE

Field Value:
5


XMLDOCUMENT_STORE

public static final short XMLDOCUMENT_STORE

Field Value:
4

Method Details

getClientName

public String getClientName()
Returns the name of the data store client.

This information is complementary to the data store type, and is useful when the data store type has several possible clients or products.

Returns:
the name of the data store client.


getDataStoreType

public short getDataStoreType()
Returns the type of DataStore

Returns:
the type of DataStore


getName

public String getName()
Returns the symbolic name of the DataStore.

This name is used to pass as a parameter the connection to use at evaluation time for all QueryLeaves attached to this DataStore.

Returns:
the symbolic name of the current DataStore.


isCapable

public boolean isCapable(short operationType)
Checks whether the current DataStore is capable of performing different types of operations.

Parameters:
operationType - is the type of operation for checking.

Returns:
true if the current DataStore is capable of performing the input operation type

See Also:
OperationType


isSameAs

public boolean isSameAs(DataStore ds)
Checks whether the current DataStore object represents the same data store as another DataStore object.

Parameters:
ds - the other DataStore object

Returns:
true of the two DataStore objects represent the same data store.


setClientName

public void setClientName(String cName)
Sets the name of the data store client.

Parameters:
cName - the name of the data store client.