com.ibm.websphere.sdo
Interface MediatorAccessBean

All Known Subinterfaces:

JDBCMediatorAccessBean

public interface MediatorAccessBean

Service Data Objects - MediatorAccessBean.

This interface defines the wrapper to a SDO Mediator and it's Metadata. A Mediator has the following responsibilities:

• Be able to construct a Mediator from a XML file the defines the Metadata
• Fill and Flush data to and from a back-end data source
• Construct empty DataGraphs so clients can create new records
• Allow a client to retrieve and modify the Metadata Object for this Service.

Method Summary

void	applyChanges(DataGraphAccessBean datagraph) Flush all changes made to the datagraph back to a data source
void	close() Releases any resources, such as database cursors, being held by the DataList for the current page
DataGraphAccessBean	createEmptyGraph() Return an empty datagraph based on my metadata
DataGraphAccessBean	fetchGraph() Return a datagraph based on my metadata NOTE: This methods performs a fetch from the back-end data source.
java.lang.Object	getMetadata() Returns the Metadata Object
java.util.Map	getParams() Return the Map of paramaters use in the fetch query
org.eclipse.emf.ecore.EClass	getSchema() Return the datagraph schema
void	setMetadata(java.lang.Object metadata) Set the Metadata Object
void	setMetadataFileName(java.lang.String filename) Set the path to the XML file containg the Metadata in XML format
void	setParams(java.util.Map params) Set a Map of paramaters to be used in the fetch query

Method Detail

applyChanges

public void applyChanges(DataGraphAccessBean datagraph)
                  throws com.ibm.websphere.wdo.mediator.exception.MediatorException,
                         java.io.IOException

Flush all changes made to the datagraph back to a data source

Parameters:

datagraph -

Throws:

com.ibm.websphere.wdo.mediator.exception.MediatorException -

java.io.IOException -

close

public void close()
           throws com.ibm.websphere.wdo.mediator.exception.MediatorException

Releases any resources, such as database cursors, being held by the DataList for the current page

Throws:

com.ibm.websphere.wdo.mediator.exception.MediatorException -

createEmptyGraph

public DataGraphAccessBean createEmptyGraph()
                                     throws com.ibm.websphere.wdo.mediator.exception.MediatorException,
                                            java.io.IOException

Return an empty datagraph based on my metadata

Returns:

DataGraphAccessBean

Throws:

com.ibm.websphere.wdo.mediator.exception.MediatorException -

java.io.IOException -

fetchGraph

public DataGraphAccessBean fetchGraph()
                               throws com.ibm.websphere.wdo.mediator.exception.MediatorException,
                                      java.io.IOException

Return a datagraph based on my metadata NOTE: This methods performs a fetch from the back-end data source.

Returns:

DataGraphAccessBean

Throws:

com.ibm.websphere.wdo.mediator.exception.MediatorException -

java.io.IOException -

getMetadata

public java.lang.Object getMetadata()
                             throws java.io.IOException,
                                    com.ibm.websphere.wdo.mediator.exception.MediatorException

Returns the Metadata Object

Returns:

Object

Throws:

java.io.IOException -

com.ibm.websphere.wdo.mediator.exception.MediatorException -

getParams

public java.util.Map getParams()

Return the Map of paramaters use in the fetch query

Returns:

Map

getSchema

public org.eclipse.emf.ecore.EClass getSchema()
                                       throws com.ibm.websphere.wdo.mediator.exception.MediatorException,
                                              java.io.IOException

Return the datagraph schema

Returns:

EClass - Represents the schema by containing a list of references to types at the root of the DataGraph

setMetadataFileName

public void setMetadataFileName(java.lang.String filename)
                         throws com.ibm.websphere.wdo.mediator.exception.MediatorException

Set the path to the XML file containg the Metadata in XML format

Parameters:

filename -

Throws:

com.ibm.websphere.wdo.mediator.exception.MediatorException -

setParams

public void setParams(java.util.Map params)

Set a Map of paramaters to be used in the fetch query

Parameters:

params -

setMetadata

public void setMetadata(java.lang.Object metadata)

Set the Metadata Object

Parameters:

metadata -