|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.cgiams.esl.util.DefaultDataManagerImpl
This class is the deafult implementation for the Data Access Layer and
currently uses iBATIS for executing SQL. It provides an implementation of
the DataManager interface.
The configuration file must be in the appropriate iBATIS XML file format.
Modification History | ||
---|---|---|
Programmer | Date | Description |
Jim Matysczak | 03/18/2005 | Original Author |
Scott Bowers | 04/06/2005 | Renamed this file from DataManager to DefaultDataManagerImpl. This breaks the coupling of the data access layer allowing other types of data access to occur. The DataManager class is now an Interface which this class implements. Instances of this class should be retrieved through the DataManagerFactory object. |
Field Summary | |
com.ibatis.sqlmap.client.SqlMapClient |
io_sql_map_client
The instance of the Data Access Layer. |
Constructor Summary | |
DefaultDataManagerImpl(java.lang.String as_config_file)
Constructor that initializes the new instance with the specified configuration file. |
Method Summary | |
void |
commitTxn()
Commit a transaction. |
java.util.Collection |
getData(java.lang.String as_sql_id)
This method will retrieve a data set based on the specified SQL ID. |
java.util.Collection |
getData(java.lang.String as_sql_id,
java.lang.Object ao_arguments)
This method will retrieve a data set based on the specified SQL ID and arguments. |
java.lang.Object |
getData(java.lang.String as_sql_id,
java.lang.Object ao_arguments,
com.ibatis.sqlmap.client.event.RowHandler ao_row_handler)
This method will retrieve a data set based on the specified SQL ID and arguments. |
java.lang.String |
getSystemOptionString(java.lang.String as_option_name)
This method will return the String value for the specified option name. |
ValueListResultContext |
getValueObjects(ValueListSearchContext ao_search_parms)
Retrieve a list of value objects based on the incoming search context. |
void |
rollbackTxn()
Rollback a transaction. |
void |
startTxn()
Start a transaction. |
org.w3c.dom.Document |
toXML(java.lang.String as_root_name,
java.lang.String[] as_sql_ids,
java.lang.String[] as_xml_tags,
java.lang.Object ao_arguments)
This method will take a list of SQL IDs to execute, convert the results to an XML document, and return the document. |
void |
updateData(java.lang.String as_sql_id,
java.lang.Object ao_arguments)
This method will execute an update based on the specified SQL ID and arguments. |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public final com.ibatis.sqlmap.client.SqlMapClient io_sql_map_client
Constructor Detail |
public DefaultDataManagerImpl(java.lang.String as_config_file) throws java.io.FileNotFoundException, java.io.IOException
as_config_file
- The configuration file that specifies the
initialization parameters for the Data Access Layer.
java.io.FileNotFoundException
- If the incoming config file cannot be found.
java.io.IOException
- If any other exception occurs with reading the
configuration file.Method Detail |
public void startTxn() throws java.sql.SQLException
DataManager
startTxn
in interface DataManager
java.sql.SQLException
- If any error occurs.public void commitTxn() throws java.sql.SQLException
DataManager
commitTxn
in interface DataManager
java.sql.SQLException
- If any error occurs.public void rollbackTxn() throws java.sql.SQLException
DataManager
rollbackTxn
in interface DataManager
java.sql.SQLException
- If any error occurs.public java.lang.String getSystemOptionString(java.lang.String as_option_name) throws java.lang.Exception
getSystemOptionString
in interface DataManager
as_option_name
- The option name to return the String value for.
java.lang.Exception
- If an error occurres.public java.util.Collection getData(java.lang.String as_sql_id) throws java.lang.Exception
getData
in interface DataManager
as_sql_id
- The ID of a predefined SQL Select statement to execute.
java.lang.Exception
- If an error occurres.public java.util.Collection getData(java.lang.String as_sql_id, java.lang.Object ao_arguments) throws java.lang.Exception
getData
in interface DataManager
as_sql_id
- The ID of a predefined SQL Select statement to execute.ao_arguments
- The arguments that will be passed to and used by the SQL
Select statement. This argument can be null.
java.lang.Exception
- If an error occurres.public void updateData(java.lang.String as_sql_id, java.lang.Object ao_arguments) throws java.lang.Exception
updateData
in interface DataManager
as_sql_id
- The ID of a predefined SQL Insert or Update statement to execute.ao_arguments
- The arguments that will be passed to and used by the SQL
Insert or Update statement.
java.lang.Exception
- If an error occurres.public org.w3c.dom.Document toXML(java.lang.String as_root_name, java.lang.String[] as_sql_ids, java.lang.String[] as_xml_tags, java.lang.Object ao_arguments) throws java.lang.Exception
toXML
in interface DataManager
as_root_name
- The name that will be used as the root element in the XML
document that will be returned.as_sql_ids
- The SQL IDs that are to be executed.as_xml_tags
- The corresponding XML tag names for the SQL IDs.ao_arguments
- A Java Bean or Map containing the arguments to the SQL Selects
defined by as_sql_ids.
java.lang.Exception
- If an error occurres.public java.lang.Object getData(java.lang.String as_sql_id, java.lang.Object ao_arguments, com.ibatis.sqlmap.client.event.RowHandler ao_row_handler) throws java.lang.Exception
as_sql_id
- The ID of a predefined SQL Select statement to execute.ao_arguments
- The arguments that will be passed to and used by the SQL
Select statement. This argument can be null.ao_row_handler
- An callback interface used to process each row of
the result set.
java.lang.Exception
- If an error occurres.public ValueListResultContext getValueObjects(ValueListSearchContext ao_search_parms) throws ESLException
getValueObjects
in interface ValueListHandler
ao_search_parms
- The ValueListSearchContext object.
ESLException
- If any error occurs.ValueListHandler.getValueObjects(ValueListSearchContext)
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |