|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Service Data Objects - JDBCMediatorAccessBean.
This interface
defines the wrapper to a JDBC SDO Mediator and it's Metadata.
A
Mediator has the following responsibilities:
Field Summary | |
static int |
ASCENDING
Use ascending order for list ordering |
static int |
BIGDECIMAL
|
static int |
BLOB
|
static int |
BOOLEAN
|
static int |
BYTE
|
static int |
BYTES
|
static int |
CLOB
|
static int |
DATE
|
static int |
DESCENDING
Use descending order for list ordering |
static int |
DOUBLE
|
static int |
FLOAT
|
static int |
INTEGER
|
static int |
LONG
|
static int |
OBJECT
|
static int |
SHORT
|
static int |
STRING
|
static int |
TIME
|
static int |
TIMESTAMP
|
static int |
UNSORTED
Use unsorted orders for list ordering |
Method Summary | |
void |
addOrderBy(java.lang.String name,
int direction)
Adds an orderBy to order results by a property in a given direction. |
void |
autoGenerateKey(DataObjectAccessBean dataObject)
Populates all the columns of the Primary key with values from the Key generator. |
void |
clearFilter(java.lang.String tableName)
Removes all filters set on the table tableName |
void |
clearOrderby()
Removes all orderBy clauses set through the addOrderBy API |
com.ibm.websphere.wdo.mediator.rdb.metadata.FilterArgument |
createFilterArgument(java.lang.String name,
int type)
Creates a new Filter Argument to be added to a Filter on a table |
DataGraphAccessBean |
firstPage()
Moves to the first page of DataObjects |
com.ibm.websphere.wdo.mediator.rdb.metadata.Filter |
getFilter(java.lang.String tableName)
Returns the Filter associated with a give table |
java.lang.Long |
getNextGeneratedKey()
Get the next Key Value from the Auto Key Generator The Auto Key Generator is set up in your DataObject's Metadata. |
int |
getPageSize()
Return the desired number of DataObjects to return per page. |
boolean |
isFirstPage()
Return true if the last DataGraph returned from this mediator was the first page of this data set. |
boolean |
isLastPage()
Return true if the last DataGraph returned from this mediator was the first page of this data set. |
DataGraphAccessBean |
lastPage()
Moves to the first page of DataObjects |
DataGraphAccessBean |
nextPage()
Resets the position of the DataList so that on the next iteration, the next page of DataObjects will be returned. |
DataGraphAccessBean |
previousPage()
Resets the position of the DataList so that on the next iteration, the previous page of DataObjects will be returned. |
void |
removeOrderBy(java.lang.String name)
Removes an Order By added for a given property |
void |
setAutoCloseConnection(boolean autoclose)
By default the connection is opened before any fill or flush operation. |
void |
setConnectionName(java.lang.String name)
Set the connection name There are two ways a data source can be specified as a string. |
void |
setConnectionWrapper(com.ibm.websphere.wdo.mediator.rdb.ConnectionWrapper wrapper)
Set the DataDase conenction as a ConnectionWrapper object |
com.ibm.websphere.wdo.mediator.rdb.metadata.Filter |
setFilter(java.lang.String tableName,
java.lang.String predicate,
java.lang.String[] argNames,
int[] argTypes)
Create a new Filter of the a given database table The filter can be any valid SQL where clause. |
void |
setPageSize(int size)
Specify the desired number of DataObjects per page. |
Methods inherited from interface com.ibm.websphere.sdo.MediatorAccessBean |
applyChanges, close, createEmptyGraph, fetchGraph, getMetadata, getParams, getSchema, setMetadata, setMetadataFileName, setParams |
Field Detail |
public static final int INTEGER
public static final int BOOLEAN
public static final int BYTE
public static final int SHORT
public static final int STRING
public static final int DOUBLE
public static final int LONG
public static final int FLOAT
public static final int OBJECT
public static final int BIGDECIMAL
public static final int DATE
public static final int TIME
public static final int TIMESTAMP
public static final int BLOB
public static final int CLOB
public static final int BYTES
public static final int UNSORTED
public static final int ASCENDING
public static final int DESCENDING
Method Detail |
public void addOrderBy(java.lang.String name, int direction) throws java.io.IOException, com.ibm.websphere.wdo.mediator.exception.MediatorException
name
- name of column to order by.direction
- directional order to sort by: DataListAccessBean.UNSORTED,
DataListAccessBean.ASCENDING, DataListAccessBean.DESCENDINGcom.ibm.websphere.wdo.mediator.exception.MediatorException
- java.io.IOException
- public void autoGenerateKey(DataObjectAccessBean dataObject) throws com.ibm.websphere.wdo.mediator.exception.MediatorException, java.io.IOException
com.ibm.websphere.wdo.mediator.exception.MediatorException
- java.io.IOException
- public void clearFilter(java.lang.String tableName) throws java.io.IOException, com.ibm.websphere.wdo.mediator.exception.MediatorException
tableName
- com.ibm.websphere.wdo.mediator.exception.MediatorException
- java.io.IOException
- public void clearOrderby() throws java.io.IOException, com.ibm.websphere.wdo.mediator.exception.MediatorException
com.ibm.websphere.wdo.mediator.exception.MediatorException
- java.io.IOException
- public com.ibm.websphere.wdo.mediator.rdb.metadata.FilterArgument createFilterArgument(java.lang.String name, int type)
name
- type
- public DataGraphAccessBean firstPage() throws com.ibm.websphere.wdo.mediator.exception.MediatorException, java.io.IOException
com.ibm.websphere.wdo.mediator.exception.MediatorException
- java.io.IOException
- public com.ibm.websphere.wdo.mediator.rdb.metadata.Filter getFilter(java.lang.String tableName) throws java.io.IOException, com.ibm.websphere.wdo.mediator.exception.MediatorException
tableName
- java.io.IOException
- com.ibm.websphere.wdo.mediator.exception.MediatorException
- public java.lang.Long getNextGeneratedKey() throws com.ibm.websphere.wdo.mediator.exception.MediatorException, java.io.IOException
com.ibm.websphere.wdo.mediator.exception.MediatorException
- java.io.IOException
- public int getPageSize()
public boolean isFirstPage()
public boolean isLastPage()
public DataGraphAccessBean lastPage() throws com.ibm.websphere.wdo.mediator.exception.MediatorException, java.io.IOException
com.ibm.websphere.wdo.mediator.exception.MediatorException
- java.io.IOException
- public DataGraphAccessBean nextPage() throws com.ibm.websphere.wdo.mediator.exception.MediatorException, java.io.IOException
com.ibm.websphere.wdo.mediator.exception.MediatorException
- java.io.IOException
- public DataGraphAccessBean previousPage() throws com.ibm.websphere.wdo.mediator.exception.MediatorException, java.io.IOException
com.ibm.websphere.wdo.mediator.exception.MediatorException
- java.io.IOException
- public void removeOrderBy(java.lang.String name) throws java.io.IOException, com.ibm.websphere.wdo.mediator.exception.MediatorException
name
- name of column to be removed from order-by list.com.ibm.websphere.wdo.mediator.exception.MediatorException
- java.io.IOException
- public void setAutoCloseConnection(boolean autoclose)
autoclose
- public void setConnectionName(java.lang.String name)
name
- public void setConnectionWrapper(com.ibm.websphere.wdo.mediator.rdb.ConnectionWrapper wrapper)
wrapper
- public com.ibm.websphere.wdo.mediator.rdb.metadata.Filter setFilter(java.lang.String tableName, java.lang.String predicate, java.lang.String[] argNames, int[] argTypes) throws java.io.IOException, com.ibm.websphere.wdo.mediator.exception.MediatorException
tableName
- predicate
- argNames
- argTypes
- com.ibm.websphere.wdo.mediator.exception.MediatorException
- public void setPageSize(int size)
targetPagesize
- the desired number of DataObjects per page
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |