org.openeai.implementations.layouts
Class ComplexResultSetLayout

java.lang.Object

  |

  +--org.openeai.OpenEaiObject

        |

        +--org.openeai.layouts.EnterpriseLayoutManagerImpl

              |

              +--org.openeai.implementations.layouts.ComplexResultSetLayout

All Implemented Interfaces:

EnterpriseLayoutManager

public class ComplexResultSetLayout

extends EnterpriseLayoutManagerImpl

implements EnterpriseLayoutManager

This is the ResultSet Layout manager that Enterprise Messaging Objects use to build themselves from database ResultSets. It uses information found in the EnterpriseObjects.xml document to determine the layout corresponding to a particular object. See EntepriseObjects.xml for more information.

This layout manager will return an XmlEnterpriseObject populated with data contained in the result set.

Version:

3.0 beta2 - 28 January 2003

Author:

Tod Jackson (tod@openeai.org), Steve Wheat (steve@openeai.org)

Field Summary

Fields inherited from class org.openeai.OpenEaiObject

logger

Constructor Summary

ComplexResultSetLayout()
Constructor

Method Summary

void	buildObjectFromInput(java.lang.Object input, XmlEnterpriseObject xeo) This is the buildObjectFromInput method that all Layout Managers must implement.
java.lang.Object	buildOutputFromObject(XmlEnterpriseObject xeo) This is the buildOutputFromObject method that all Layout Managers must implement.
java.lang.Object	buildOutputFromObject(XmlEnterpriseObject anXmlEnterpriseObject, java.lang.String appName) This is the buildOutputFromObject method that all Layout Managers must implement.
java.lang.String	getMessageObject()
void	init(java.lang.String layoutManagerName, org.jdom.Document layoutDoc) Method used to initialize the LayoutMangager implementation with information found in the EnterpriseObjects document associated to the object being initialized.
void	setMessageObject(java.lang.String msgObject)

Methods inherited from class org.openeai.layouts.EnterpriseLayoutManagerImpl

getEnterpriseObjectsUri, getFieldLayout, getLayout, getLayout, getLayoutManagerName, getLayoutRoot, getLength, getTargetAppName, getValueFromObject, getValueFromObject, getValueFromObject, getValueFromObject, instantiate, isDate, isRepeating, isRequired, setEnterpriseObjectsUri, setLayout, setLayoutManagerName, setLayoutRoot, setTargetAppName, setVariableValue, setVariableValue

Methods inherited from class org.openeai.OpenEaiObject

addLog4jProperty, getAppName, getDebug, getFromAddr, getLog4jProperties, getMailHost, getMailService, getProperties, getToAddr, initializeLog4j, initializeLog4j, initializeLog4j, setAppName, setDebug, setFromAddr, setMailHost, setMailService, setProperties, setToAddr

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.openeai.layouts.EnterpriseLayoutManager

getEnterpriseObjectsUri, getLayoutManagerName, getLayoutRoot, setEnterpriseObjectsUri, setLayoutManagerName

Constructor Detail

ComplexResultSetLayout

public ComplexResultSetLayout()

Constructor

Method Detail

setMessageObject

public void setMessageObject(java.lang.String msgObject)

getMessageObject

public java.lang.String getMessageObject()

init

public void init(java.lang.String layoutManagerName,
                 org.jdom.Document layoutDoc)
          throws EnterpriseLayoutException

Description copied from interface: EnterpriseLayoutManager

Method used to initialize the LayoutMangager implementation with information found in the EnterpriseObjects document associated to the object being initialized. The layoutmanager implementation retrieves information from the EnterpriseObjects document to tell it how the object should be built from an input and serialized to an output.

Specified by:

init in interface EnterpriseLayoutManager

Overrides:

init in class EnterpriseLayoutManagerImpl

Throws:

EnterpriseLayoutException - if any errors occur initializing the layout manager implementation.

buildOutputFromObject

public java.lang.Object buildOutputFromObject(XmlEnterpriseObject xeo)
                                       throws EnterpriseLayoutException

This is the buildOutputFromObject method that all Layout Managers must implement. Note, this method is not supported by this layout manager yet so it will throw an EntepriseLayoutException stating that it is not supported.

Specified by:

buildOutputFromObject in interface EnterpriseLayoutManager

Returns:

Object the XML element that corresponds to the data in the object.

Throws:

EnterpriseLayoutException - if any errors occur getting the field values from the object.

buildOutputFromObject

public java.lang.Object buildOutputFromObject(XmlEnterpriseObject anXmlEnterpriseObject,
                                              java.lang.String appName)
                                       throws EnterpriseLayoutException

This is the buildOutputFromObject method that all Layout Managers must implement. Note, this method is not supported by this layout manager yet so it will throw an EntepriseLayoutException stating that it is not supported.

Specified by:

buildOutputFromObject in interface EnterpriseLayoutManager

Returns:

Object the XML element that corresponds to the data in the object.

Throws:

EnterpriseLayoutException - if any errors occur getting the field values from the object.

buildObjectFromInput

public void buildObjectFromInput(java.lang.Object input,
                                 XmlEnterpriseObject xeo)
                          throws EnterpriseLayoutException

This is the buildObjectFromInput method that all Layout Managers must implement. This particular layout manager will take the ResultSet passed in and populate the XmlEnterpriseObject passed in with data retrieved from the ResultSet. Information regarding where the data is stored in the ResultSet will be derived from the EnterpriseObjects.xml document. Setter methods on the XmlEnterpriseObject object will be called passing that data to populate the object.

Specified by:

buildObjectFromInput in interface EnterpriseLayoutManager

Throws:

EnterpriseLayoutException - if an errors occur setting the Object fields with data contained in the XML element.