|
ABLE 2.0.0 07/02/2003 10:25:01 | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Defines the behavior of an RMI Platform Persistence Service.
Method Summary | |
---|---|
void |
close(java.lang.String databaseName,
java.lang.String tableName,
AbleSecureKey key)
Closes all connections, both the AbleDBImport and AbleDBExport beans for this database table. |
void |
createTableConnection(java.lang.String databaseName,
java.lang.String tableName,
java.lang.String[] columnNames,
java.lang.String[] columnTypes,
AbleSecureKey key)
This creates both an AbleDBImport and AbleDBExport bean and the table these beans will be dealing with if the table does not already exist. |
void |
delete(java.lang.String databaseName,
java.lang.String tableName,
java.lang.Object whereObject,
AbleSecureKey key)
Deletes rows from a table. |
void |
insert(java.lang.String databaseName,
java.lang.String tableName,
java.lang.Object[] insertData,
AbleSecureKey key)
Insert a record into a table. |
java.lang.Object[] |
select(java.lang.String databaseName,
java.lang.String tableName,
java.lang.String columnString,
java.lang.String whereString,
AbleSecureKey key)
Selects data from a table. |
void |
update(java.lang.String databaseName,
java.lang.String tableName,
java.lang.Object updateObject,
java.lang.Object whereObject,
AbleSecureKey key)
Updates a row in a table. |
Method Detail |
public void createTableConnection(java.lang.String databaseName, java.lang.String tableName, java.lang.String[] columnNames, java.lang.String[] columnTypes, AbleSecureKey key) throws java.rmi.RemoteException, PlatformPersistenceException
databaseName
- The name of the Database that the table will exist in.
tableName
- The name of the table.
columnNames
- String[] containing the name of each column for this table.
columnTypes
- String[] containing the type of each column for this table.
key
- AbleSecureKey used to secure communication.
AbleException
- On all errors creating and initializing the AbleDBExport or AbleDBImport beans.
PlatformPersistenceException
- If unable to verify the key when the platform is secure.
On errors creating the table.
java.rmi.RemoteException
- On all remote errors.public void insert(java.lang.String databaseName, java.lang.String tableName, java.lang.Object[] insertData, AbleSecureKey key) throws java.rmi.RemoteException, PlatformPersistenceException
databaseName
- The name of the Database that the table will exist in.
tableName
- The name of the table to insert into.
insertData
- Object[] containing the data that is to be inserted into the table.
key
- AbleSecureKey used to secure communication.
PlatformPersistenceException
- If unable to verify the key when the platform is secure.
If secure and the caller is not the one who originally set up the connection to this table.
java.rmi.RemoteException
- On all remote errors.public void update(java.lang.String databaseName, java.lang.String tableName, java.lang.Object updateObject, java.lang.Object whereObject, AbleSecureKey key) throws java.rmi.RemoteException, PlatformPersistenceException
databaseName
- The name of the Database that the table will exist in.
tableName
- The name of the table.
updateObject
- This is the new data for the record that is to be updated. This should
either be a Map or an Object[]. If it is an Object[], it will contain
the data for the record to be updated. Each element represents a column.
Every column must be represented, even if a column is not changing. If
it is a Map, then keys are the column names and the values are the
column values. Unlike an Object[], when using a Map the columns that
are not changing do not have to be present. If the updateObject is an
Object[], the whereObject must be a String. If the updateObject is a Map,
the whereObject must be a Map too.
whereObject
- This determines the where clause for the update statement. The whereObject
is either a String or a Map. If it is a String, it will be appended to the
end of the update statement. If it is a Map, it will be used to build the
where clause. The keys will be the column names, and the values will be the
Object to match to for their respective column. If left null, or empty,
everything will be deleted. If the whereObject is a String, the updateObject
must be an Object[]. If the whereObject is a Map, the updateObject must be
a Map too.
key
- AbleSecureKey used to secure communication
PlatformPersistenceException
- If unable to verify the key when the platform is secure.
If secure and the caller is not the one who originally set up the connection to this table.
If updateObject is an Object[], but whereObject is not a String
If updateObject is a Map, but whereObject is not a Map
If updateObject is neither an Object[] or a Map.
java.rmi.RemoteException
- On all remote errors.public void delete(java.lang.String databaseName, java.lang.String tableName, java.lang.Object whereObject, AbleSecureKey key) throws java.rmi.RemoteException, PlatformPersistenceException
databaseName
- The name of the database that the table will exist in.
tableName
- The name of the table.
whereObject
- This can either be a simple String that states the where clause of
the delete, or a Map that will be used to build the where clause.
The keys will be the column names, and the values will be the Object
to match to for their respective column. If left null, or not a String
or Map, everything will be deleted.
key
- AbleSecureKey used to secure communication
PlatformPersistenceException
- If unable to verify the key when the platform is secure.
If secure and the caller is not the one who originally set up the connection to this table.
java.rmi.RemoteException
- On all remote errors.public java.lang.Object[] select(java.lang.String databaseName, java.lang.String tableName, java.lang.String columnString, java.lang.String whereString, AbleSecureKey key) throws java.rmi.RemoteException, PlatformPersistenceException
databaseName
- The name of the database that the table will exist in.
tableName
- The name of the table.
columnString
- The columns that are to be returned in a select statement.
If left blank or null, all columns will be returned.
whereString
- The where string of the select statement. If left blank or null,
everything will be returned.
key
- AbleSecureKey used to secure communication.
AbleException
- On AbleDBImport bean errors opening or processing the select query.
PlatformPersistenceException
- If unable to verify the key when the platform is secure.
If secure and the caller is not the one who originally set up the connection to this table.
java.rmi.RemoteException
- On all remote errors.public void close(java.lang.String databaseName, java.lang.String tableName, AbleSecureKey key) throws java.rmi.RemoteException, PlatformPersistenceException
databaseName
- The name of the DB that the table will exist in.
tableName
- The name of the table.
key
- AbleSecureKey used to secure communication.
AbleException
- On any errors calling quitAll on the AbleDBImport or AbleDBExport beans.
PlatformPersistenceException
- If unable to verify the key when the platform is secure.
If secure and the caller is not the one who originally set up the connection to this table.
java.rmi.RemoteException
- On all remote errors.
|
ABLE 2.0.0 07/02/2003 10:25:01 | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |