com.sri.emo.dbobj
Class AbstractSettingHandler

java.lang.Object
  com.sri.emo.dbobj.AbstractAttributeHandler
      com.sri.emo.dbobj.AbstractSettingHandler

All Implemented Interfaces:

IPartHandler, Cloneable

public abstract class AbstractSettingHandler
extends AbstractAttributeHandler

base class for custom handler for settings

Author:

Larry Hamel

Field Summary

static String

SETTING

Fields inherited from class com.sri.emo.dbobj.AbstractAttributeHandler

OBSERVABLE_ID_XMLTAG

Fields inherited from interface com.sri.emo.dbobj.IPartHandler

FULL_XML, NO_PARAMETERS

Constructor Summary

AbstractSettingHandler(String attribName, Class editorClass, String viewState, String promptEditState)

Method Summary

protected org.dom4j.Element	addSingleSettingElem(org.dom4j.Element root, String typeName, ISetting aSetting, ControllerRequest request)
org.dom4j.Element	addXML(Attribute attrib, org.dom4j.Element root, String typeName, ControllerRequest request)
void	clone(Attribute existing, Attribute clone) clone data from existing to clone
void	delete(Attribute attribute) Delete a part.
abstract List	getInputs(String templateId) get a map of Inputs for all settings.
String[]	getInsertStatements(AbstractNodeExportSupport treeExporter, DBObject obj, ISetting setting)
abstract ISetting	getSettingPrototype()
Transition	getViewTransition(Map params) Get the View Transition.
protected ISetting	parseSingleSetting(Map allNodesByXML_ID, org.dom4j.Element settingElem, ISetting aSetting)
void	parseXML(org.dom4j.Element elem, Attribute attrib, Map allNodesByXML_ID, ControllerRequest request) Parse xml into this attribute format.

Methods inherited from class com.sri.emo.dbobj.AbstractAttributeHandler

addIDs, clone, copyParams, getAttribName, getEditTransition, getLogger, getParentAttrib, getViewComment, isNeededInFullXML, saveInput, setParentAttrib, validate

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.sri.emo.dbobj.IPartHandler

addXML, getInsertStatements

Field Detail

SETTING

public static final String SETTING

See Also:

Constant Field Values

Constructor Detail

AbstractSettingHandler

public AbstractSettingHandler(String attribName,
                              Class editorClass,
                              String viewState,
                              String promptEditState)

Method Detail

clone

public void clone(Attribute existing,
                  Attribute clone)
           throws DBException

clone data from existing to clone

Parameters:

existing - The source attribute.

clone - The target Attribute.

Throws:

DBException - upon database error.

delete

public void delete(Attribute attribute)
            throws DBException

Description copied from interface: IPartHandler

Delete a part.

Parameters:

attribute - Attribute the attribute to delete.

Throws:

DBException - upon database error.

addXML

public org.dom4j.Element addXML(Attribute attrib,
                                org.dom4j.Element root,
                                String typeName,
                                ControllerRequest request)
                         throws DBException

Throws:

DBException

addSingleSettingElem

protected org.dom4j.Element addSingleSettingElem(org.dom4j.Element root,
                                                 String typeName,
                                                 ISetting aSetting,
                                                 ControllerRequest request)
                                          throws DBException

Throws:

DBException

parseXML

public void parseXML(org.dom4j.Element elem,
                     Attribute attrib,
                     Map allNodesByXML_ID,
                     ControllerRequest request)
              throws DBException

Description copied from interface: IPartHandler

Parse xml into this attribute format.

Parameters:

elem - The XML Element we're parsing.

attrib - the specifying format.

allNodesByXML_ID - ?

request - ControllerRequest the ControllerRequest object.

Throws:

DBException - upon database error.

parseSingleSetting

protected ISetting parseSingleSetting(Map allNodesByXML_ID,
                                      org.dom4j.Element settingElem,
                                      ISetting aSetting)
                               throws DBException

Throws:

DBException

getViewTransition

public Transition getViewTransition(Map params)
                             throws DBException

Description copied from interface: IPartHandler

Get the View Transition.

Specified by:

getViewTransition in interface IPartHandler

Overrides:

getViewTransition in class AbstractAttributeHandler

Parameters:

params - map of ControllerRequest params.

Returns:

null as a signal to use standard output

Throws:

DBException - upon error.

getInputs

public abstract List getInputs(String templateId)
                        throws Exception

get a map of Inputs for all settings.

Returns:

map keyed by setting key (from the getKey() function), value is list of Inputs

Throws:

Exception

getSettingPrototype

public abstract ISetting getSettingPrototype()
                                      throws DBException

Throws:

DBException

getInsertStatements

public String[] getInsertStatements(AbstractNodeExportSupport treeExporter,
                                    DBObject obj,
                                    ISetting setting)
                             throws DBException

Returns:

an array of SQL Insert statements that are equivalent to the contents of this attribute; can be empty but never null

Throws:

DBException