org.objectweb.medor.datasource.api
Interface DataStore

All Known Subinterfaces:
RdbDataStore
All Known Implementing Classes:
BasicDataStore

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
 java.lang.String getClientName()
          Returns the name of the data store client.
 short getDataStoreType()
          Returns the type of DataStore
 java.lang.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(java.lang.String cName)
          Sets the name of the data store client.
 

Field Detail

MEDORTC_STORE

public static final short MEDORTC_STORE
See Also:
Constant Field Values

JDBC_STORE

public static final short JDBC_STORE
See Also:
Constant Field Values

TEXTFILE_STORE

public static final short TEXTFILE_STORE
See Also:
Constant Field Values

ODMG_STORE

public static final short ODMG_STORE
See Also:
Constant Field Values

XMLDOCUMENT_STORE

public static final short XMLDOCUMENT_STORE
See Also:
Constant Field Values

UDDI_STORE

public static final short UDDI_STORE
See Also:
Constant Field Values
Method Detail

getName

public java.lang.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.

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.

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

getDataStoreType

public short getDataStoreType()
Returns the type of DataStore

Returns:
the type of DataStore

getClientName

public java.lang.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.

setClientName

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

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