com.groiss.store
Interface RemoteStore

All Superinterfaces:

Remote

All Known Subinterfaces:

Store

public interface RemoteStore
extends Remote

The store interface represents the interface to the database. It is used for inserting, updating, deleting and retrieving objects. You get an object implementing this interface by calling com.groiss.wf.ServiceLocator.getStore() or - in case of RMI - using the getStore() call of com.groiss.wf.Session.

Many methods contain a condition string. The syntax of them is as in an SQL where clause like "name='john' and salary > 1000", where name and salary are database fields of the given object class. In methods where the extra parameter bindVars appears, the condition can contain placeholders, for example "name=? and salary >?".

The condition parameter may always be null, as well as the order parameter. The bindVars may be null if no placeholders are used in the condition.

Method Summary

int	count(Class<?> c, String cond, Object[] bindVars) This method returns the number of members of a given class matching the given condition.
int	count(String classname, String cond, Object[] bindVars) This method returns the number of members of a given class matching the given condition.
void	delete(Class<?> c, String condition, Object[] bindVars) Deletes some objects from the database.
int	delete(Persistent o) Deletes the object from the database.
void	delete(String classname, String condition, Object[] bindVars) Deletes some objects from the database.
int	executeStatement(String stmt) Execute a SQL statement.
int	executeStatement(String stmt, Object[] bindVars) Execute a SQL statement.
<P> P	fill(P o) Fill objects where only the oid is set.
<P> P	get(Class<? extends P> c, long oid) Method for getting objects from the database.
<P> P	get(Class<? extends P> c, String cond) Method for getting objects from the database.
<P> P	get(Class<? extends P> c, String cond, Object[] bindVars) Method for getting objects from the database.
<P extends Persistent> P	get(String classname, long oid) Method for getting objects from the database.
<P extends Persistent> P	get(String classname, String cond) Method for getting objects from the database.
<P extends Persistent> P	get(String classname, String cond, Object[] bindVars) Method for getting objects from the database.
<P> P	getNoCache(Class<? extends P> c, long oid) Method for getting objects directly from the database bypassing the cache.
long	getOID() Return the next object id from the oid-factory in the database
String	getSchema() Returns the schema of the tables
TableModel	getTable(String q, Object[] bindVars) Returns the results of the given query.
TableModel	getTable(String q, Object[] bindVars, int[] sqlTypes) Returns the results of the given query.
Object	getValue(String stmt) Execute a SQL statement which returns one value.
Object	getValue(String stmt, int sqlType) Execute a SQL statement which returns one value.
Object	getValue(String stmt, Object[] bindVars) Execute a SQL statement which returns one value.
Object	getValue(String stmt, Object[] bindVars, int sqlType) Execute a SQL statement which returns one value.
boolean	hasRows(String stmt, Object[] bindVars) Check whether the statement returns results.
boolean	inDatabase(Persistent o) Check whether the object is in database
void	insert(Persistent o) Insert the object into the database.
<P> List<P>	list(Class<? extends P> c) This method returns all members of the given class.
<P> List<P>	list(Class<? extends P> c, String cond) This method returns the members of the given class matching the given condition.
<P> List<P>	list(Class<? extends P> c, String cond, String order) This method returns the members of the given class matching the given condition.
<P> List<P>	list(Class<? extends P> c, String cond, String order, Object[] bindVars) This method returns the members of the given class matching the given condition.
<P> List<P>	list(Class<? extends P> c, String cond, String order, Object[] bindVars, int maxRows) This method returns the members of the given class matching the given condition and limiting the returned entry count.
<P extends Persistent> List<P>	list(String classname) This method returns all members of the given class.
<P extends Persistent> List<P>	list(String classname, String cond) This method returns the members of the given class matching the given condition.
<P extends Persistent> List<P>	list(String classname, String cond, String order) This method returns the members of the given class matching the given condition.
<P extends Persistent> List<P>	list(String classname, String cond, String order, Object[] bindVars) This method returns the members of the given class matching the given condition.
<P> List<P>	list2(Class<? extends P> c, String q, Object[] bindVars) This method returns the members of the given class matching the given condition.
<P extends Persistent> List<P>	list2(String classname, String q, Object[] bindVars) This method returns the members of the given class matching the given condition.
void	setSchema(String schema) Set the schema of the tables
<P> Map<Long,P>	table(Class<? extends P> c, String cond, Object[] bindVars) This method returns the members of the given class matching the given condition.
<P extends Persistent> Map<Long,P>	table(String classname, String cond, Object[] bindVars) This method returns the members of the given class matching the given condition.
int	update(Persistent o) Update the database tuple corresponding to the given object.
int	update(Persistent o, String... fieldNames) Update some fields of the database tuple corresponding to the given object.

Method Detail

list

<P> List<P> list(Class<? extends P> c)
             throws RemoteException

This method returns all members of the given class.

Parameters:

c - the class of the objects

Returns:

a list of members of the given class

Throws:

RemoteException

list

<P extends Persistent> List<P> list(String classname)
                                throws RemoteException

This method returns all members of the given class.

Parameters:

classname - the name of the class of the object

Returns:

a List of members of the given class

Throws:

RemoteException

list

<P> List<P> list(Class<? extends P> c,
                 String cond)
             throws RemoteException

This method returns the members of the given class matching the given condition.

Parameters:

c - the class of the objects

cond - a SQL condition

Returns:

a List of members of the given class

Throws:

RemoteException

list

<P extends Persistent> List<P> list(String classname,
                                    String cond)
                                throws RemoteException

This method returns the members of the given class matching the given condition.

Parameters:

classname - the name of the class of the object

cond - a SQL condition

Returns:

a List of members of the given class

Throws:

RemoteException

list

<P> List<P> list(Class<? extends P> c,
                 String cond,
                 String order)
             throws RemoteException

This method returns the members of the given class matching the given condition.

Parameters:

c - the class of the objects

cond - a SQL condition

order - a comma separated list of attribute names of the given class.

Returns:

a List of members of the given class

Throws:

RemoteException

list

<P extends Persistent> List<P> list(String classname,
                                    String cond,
                                    String order)
                                throws RemoteException

This method returns the members of the given class matching the given condition.

Parameters:

classname - the name of the class of the object

cond - a SQL condition

order - a comma separated list of attribute names of the given class.

Returns:

a List of members of the given class

Throws:

RemoteException

list

<P> List<P> list(Class<? extends P> c,
                 String cond,
                 String order,
                 Object[] bindVars)
             throws RemoteException

This method returns the members of the given class matching the given condition.

Parameters:

c - the class of the objects

cond - a SQL condition

order - a comma separated list of attribute names of the given class.

bindVars - if the condition contains place holders for binding variables this array should contain the values

Returns:

a List of members of the given class

Throws:

RemoteException

list

<P> List<P> list(Class<? extends P> c,
                 String cond,
                 String order,
                 Object[] bindVars,
                 int maxRows)
             throws RemoteException

This method returns the members of the given class matching the given condition and limiting the returned entry count.

Parameters:

c - the class of the objects

cond - a SQL condition

order - a comma separated list of attribute names of the given class.

bindVars - if the condition contains place holders for binding variables this array should contain the values

maxRows - the maximum number of entries to return

Returns:

a List of members of the given class

Throws:

RemoteException

list

<P extends Persistent> List<P> list(String classname,
                                    String cond,
                                    String order,
                                    Object[] bindVars)
                                throws RemoteException

This method returns the members of the given class matching the given condition.

Parameters:

classname - the name of the class of the objects

cond - a SQL condition

order - a comma separated list of attribute names of the given class.

bindVars - if the condition contains place holders for binding variables this array should contain the values

Returns:

a List of members of the given class

Throws:

RemoteException

list2

<P> List<P> list2(Class<? extends P> c,
                  String q,
                  Object[] bindVars)
              throws RemoteException

This method returns the members of the given class matching the given condition. the sql-query is a complete sql statement which must retreive exactly the database attributes of the given class, for example: select u.* from avw_user u, avw_userrole ur where ... It is required to use the StoreUtil.dbAttrs(Persistent, String) dbAttrs(String) method to construct the attribute list, that is to formulate "select "+StoreUtil.dbAttrs(user,"u")+" from avwuser u, avw_userrole ur where..."

Parameters:

c - the class of the objects

q - a SQL query

bindVars - if the condition contains place holders for binding variables this array should contain the values

Returns:

a List of members of the given class

Throws:

RemoteException

list2

<P extends Persistent> List<P> list2(String classname,
                                     String q,
                                     Object[] bindVars)
                                 throws RemoteException

This method returns the members of the given class matching the given condition. the sql-query is a complete sql statement which must retreive exactly the database attributes of the given class, for example: select u.* from avw_user u, avw_userrole ur where ... It is required to use the StoreUtil.dbAttrs(Persistent, String) dbAttrs(String) method to construct the attribute list, that is to formulate "select "+StoreUtil.dbAttrs(user,"u")+" from avwuser u, avw_userrole ur where..."

Parameters:

classname - the name of the class of the objects

q - a SQL query

bindVars - if the condition contains place holders for binding variables this array should contain the values

Returns:

a List of members of the given class

Throws:

RemoteException

table

<P> Map<Long,P> table(Class<? extends P> c,
                      String cond,
                      Object[] bindVars)
                  throws RemoteException

This method returns the members of the given class matching the given condition. The keys of the table are the oids of the objects as Long objects, the values are the objects itself.

Parameters:

c - the class of the objects

cond - a SQL condition

bindVars - if the condition contains place holders for binding variables this array should contain the values

Returns:

a Map of members of the given class

Throws:

RemoteException

table

<P extends Persistent> Map<Long,P> table(String classname,
                                         String cond,
                                         Object[] bindVars)
                                     throws RemoteException

This method returns the members of the given class matching the given condition. The keys of the table are the oids of the objects as Long objects, the values are the objects itself.

Parameters:

classname - the name of the class of the objects

cond - a SQL condition

bindVars - if the condition contains place holders for binding variables this array should contain the values

Returns:

a Map of members of the given class

Throws:

RemoteException

count

int count(Class<?> c,
          String cond,
          Object[] bindVars)
          throws RemoteException

This method returns the number of members of a given class matching the given condition.

Parameters:

c - the class

cond - a SQL condition

bindVars - if the condition contains place holders for binding variables this array should contain the values

Returns:

the number of elements

Throws:

RemoteException

count

int count(String classname,
          String cond,
          Object[] bindVars)
          throws RemoteException

This method returns the number of members of a given class matching the given condition.

Parameters:

classname - the name of the class

cond - a SQL condition

bindVars - if the condition contains place holders for binding variables this array should contain the values

Returns:

the number of elements

Throws:

RemoteException

inDatabase

boolean inDatabase(Persistent o)
                   throws RemoteException

Check whether the object is in database

Returns:

true if the object is in the database

Throws:

RemoteException

hasRows

boolean hasRows(String stmt,
                Object[] bindVars)
                throws RemoteException

Check whether the statement returns results.

Parameters:

stmt - the SQL statement text.

bindVars - if the stmt contains place holders for binding variables this array should contain the values

Returns:

true if the result set is not empty

Throws:

RemoteException

get

<P> P get(Class<? extends P> c,
          long oid)
      throws RemoteException

Method for getting objects from the database.

Parameters:

c - the class of the object

oid - the oid of the object

Returns:

the object with a given oid

Throws:

RemoteException

get

<P extends Persistent> P get(String classname,
                             long oid)
                         throws RemoteException

Method for getting objects from the database.

Parameters:

classname - the name of the class of the object

oid - the oid of the object

Returns:

the object with a given oid

Throws:

RemoteException

get

<P> P get(Class<? extends P> c,
          String cond)
      throws RemoteException

Method for getting objects from the database.

Parameters:

c - the class of the object

cond - a SQL condition

Returns:

the object with a given oid

Throws:

RemoteException

get

<P extends Persistent> P get(String classname,
                             String cond)
                         throws RemoteException

Method for getting objects from the database.

Parameters:

classname - the name of the class of the object

cond - a SQL condition

Returns:

an object matching the given condition

Throws:

RemoteException

get

<P> P get(Class<? extends P> c,
          String cond,
          Object[] bindVars)
      throws RemoteException

Method for getting objects from the database.

Parameters:

c - the class of the object

cond - a SQL condition

bindVars - if the condition contains place holders for binding variables this array should contain the values

Returns:

an object matching the given condition

Throws:

RemoteException

get

<P extends Persistent> P get(String classname,
                             String cond,
                             Object[] bindVars)
                         throws RemoteException

Method for getting objects from the database.

Parameters:

classname - the name of the class of the object

cond - a SQL condition

bindVars - if the condition contains place holders for binding variables this array should contain the values

Returns:

an object matching the given condition

Throws:

RemoteException

fill

<P> P fill(P o)
       throws RemoteException

Fill objects where only the oid is set.

Parameters:

o - the object

Returns:

the same object with fields set from the database

Throws:

RemoteException

insert

void insert(Persistent o)
            throws RemoteException

Insert the object into the database.

Parameters:

o - the object

Throws:

RemoteException

update

int update(Persistent o)
           throws RemoteException

Update the database tuple corresponding to the given object.

Parameters:

o - the object

Throws:

RemoteException

update

int update(Persistent o,
           String... fieldNames)
           throws RemoteException

Update some fields of the database tuple corresponding to the given object.

Parameters:

o - the object

fieldNames - an array containing the names of the fields which should be updated

Throws:

RemoteException

delete

int delete(Persistent o)
           throws RemoteException

Deletes the object from the database.

Parameters:

o - the object to delete

Throws:

RemoteException

delete

void delete(Class<?> c,
            String condition,
            Object[] bindVars)
            throws RemoteException

Deletes some objects from the database. Note that neither the Persistent.onDelete() nor PersistentEventHandler.onDelete(Persistent) methods are called for the individual deleted objects.

Parameters:

c - the class of the objects

condition - a SQL condition

bindVars - if the condition contains place holders for binding variables this array should contain the values

Throws:

RemoteException

delete

void delete(String classname,
            String condition,
            Object[] bindVars)
            throws RemoteException

Deletes some objects from the database. Note that neither the Persistent.onDelete() nor PersistentEventHandler.onDelete(Persistent) methods are called for the individual deleted objects.

Parameters:

classname - the name of the class of the objects

condition - a SQL condition

bindVars - if the condition contains place holders for binding variables this array should contain the values

Throws:

RemoteException

executeStatement

int executeStatement(String stmt)
                     throws RemoteException

Execute a SQL statement.

Parameters:

stmt - the SQL statement text.

Returns:

the number of rows changed

Throws:

RemoteException

executeStatement

int executeStatement(String stmt,
                     Object[] bindVars)
                     throws RemoteException

Execute a SQL statement.

Parameters:

stmt - the SQL statement text.

bindVars - if the stmt contains place holders for binding variables this array should contain the values

Returns:

the number of rows changed

Throws:

RemoteException

getOID

long getOID()
            throws RemoteException

Return the next object id from the oid-factory in the database

Returns:

an unique object id

Throws:

RemoteException

getValue

Object getValue(String stmt)
                throws RemoteException

Execute a SQL statement which returns one value. The statement is executed, the first row fetched and from the result set the first element is returned.

Parameters:

stmt - the SQL statement text.

Returns:

the value as object.

Throws:

RemoteException

getValue

Object getValue(String stmt,
                int sqlType)
                throws RemoteException

Execute a SQL statement which returns one value. The statement is executed, the first row fetched and from the result set the first element is returned.

Parameters:

stmt - the SQL statement text.

sqlType - if a special mapping of the database type to java type is needed, the type (java.sql.Types) can be specified here.

Returns:

the value as object.

Throws:

RemoteException

getValue

Object getValue(String stmt,
                Object[] bindVars)
                throws RemoteException

Execute a SQL statement which returns one value. The statement is executed, the first row fetched and from the result set the first element is returned.

Parameters:

stmt - the SQL statement text.

bindVars - if the stmt contains place holders for binding variables this array should contain the values

Returns:

the value as object.

Throws:

RemoteException

getValue

Object getValue(String stmt,
                Object[] bindVars,
                int sqlType)
                throws RemoteException

Execute a SQL statement which returns one value. The statement is executed, the first row fetched and from the result set the first element is returned.

Parameters:

stmt - the SQL statement text.

bindVars - if the stmt contains place holders for binding variables this array should contain the values

sqlType - if a special mapping of the database type to java type is needed, the type (java.sql.Types) can be specified here.

Returns:

the value as object.

Throws:

RemoteException

getTable

TableModel getTable(String q,
                    Object[] bindVars)
                    throws RemoteException

Returns the results of the given query.

Parameters:

q - the sql-query

bindVars - if the query contains place holders for binding variables this array should contain the values

Returns:

a list of list of values

Throws:

RemoteException

getTable

TableModel getTable(String q,
                    Object[] bindVars,
                    int[] sqlTypes)
                    throws RemoteException

Returns the results of the given query.

Parameters:

q - the sql-query

bindVars - if the query contains place holders for binding variables this array should contain the values

sqlTypes - if a special mapping of database types to java types is needed, the types (java.sql.Types) can be specified here. The length of the array must be equal to the number of columns in the result set.

Returns:

a list of list of values

Throws:

RemoteException

setSchema

void setSchema(String schema)
               throws RemoteException

Set the schema of the tables

Parameters:

schema -

Throws:

RemoteException

getSchema

String getSchema()
                 throws RemoteException

Returns the schema of the tables

Throws:

RemoteException

getNoCache

<P> P getNoCache(Class<? extends P> c,
                 long oid)
             throws RemoteException

Method for getting objects directly from the database bypassing the cache.

Parameters:

c - the class of the object

oid - the oid of the object

Returns:

the object with a given oid

Throws:

RemoteException