Package hec.data

Class AbstractJDomDataObject

java.lang.Object

java.util.Observable

hec.lang.NamedType

hec.data.AbstractJDomDataObject

All Implemented Interfaces:

AsciiSerializable, FieldAccessor, Serializable, Cloneable, Comparable, Observer, Modifiable

Direct Known Subclasses:

JDomAttributeParameterTypedValue, JDomCharacteristic, JDomCharacteristicType, JDomCharacteristicTypeRef, JDomEmbankmentImpl, JDomLocationLevelImpl, JDomLocationLevelRef, JDomLockCatalogImpl, JDomLockImpl, JDomLookupTypeImpl, JDomParameterTypedValueImpl, JDomProjectCatalogImpl, JDomProjectImpl, JDomSeasonalIntervalImpl, JDomSeasonalValueImpl, JDomSeasonalValuesImpl, JDomSpecifiedLevelImpl, JDomWaterSupplyPumpAccountingImpl, JDomWaterUserContractImpl, JDomWaterUserContractRef, JDomWaterUserImpl, OperationalProjectChanges, PhysicalStructure, PhysicalStructureOperationalChange, PhysicalStructureOperationalChangeRef, PhysicalStructureOperationalSetting

public abstract class AbstractJDomDataObject
extends NamedType

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DD_MM_MYYYY
static final String	DD_MM_MYYYY_HHMM
static final String	DD_MM_MYYYY_HHMMZ
static final String	MM_MYYYY
static final String	UNIT
static final String	YYYY

Fields inherited from class hec.lang.NamedType

_description, _ignoreModifiedEvents, _index, _isValid, _modified, _name, defaultDescription, defaultName, DESCRIPTION_CHANGED, NAME_CHANGED, RENAME_EVENT

Constructor Summary

Constructors

Constructor	Description
AbstractJDomDataObject()

Method Summary

Modifier and Type	Method	Description
abstract void	buildElement(org.jdom.Element element)	Populates the element with data from this object.
protected org.jdom.Element	buildElementOrRemove(org.jdom.Element element, String childElementName, AbstractJDomDataObject jdom)
static String	camelCaseToLowerUnderbar(String word)	Converts a camelCase string to one with words separated by underbars (_) and lowercased.
protected String	getDefaultElementName()
static Date	getXmlDate(org.jdom.Element parent, String childElementName, String dateFormat)
static double	getXmlValue(ParamDouble paramDouble, org.jdom.Element parent, String childElementName, int paramId)
protected double	parseDouble(org.jdom.Element parentElement, String childElementName, String[] units, double defaultValue)
protected double	parseFormattedDouble(org.jdom.Element parentElement, String childElementName, String[] units, double defaultValue)
protected int	parseInt(org.jdom.Element parentElement, String childElementName, String[] units, int defaultValue)
static void	setXmlDate(org.jdom.Element element, String childElementName, String dateFormat, Date date)
static void	setXmlValue(ParamDouble paramDouble, org.jdom.Element parent, String childElementName, Double value, int paramId)
String	toXmlString()	Writes an AbstractJDomDataObject to an xml string.

Methods inherited from class hec.lang.NamedType

addModifiableListener, clone, compareTo, fireModifiedStateChanged, getDescription, getDisplayName, getFieldObject, getIgnoreModifiedEvents, getIndex, getName, isModified, isValid, readResolve, removeModifiableListener, rename, set, setDescription, setFieldObject, setIgnoreModifiedEvents, setIndex, setModified, setName, setValid, toString, update, useRecursiveModifiedTest

Methods inherited from class java.util.Observable

addObserver, clearChanged, countObservers, deleteObserver, deleteObservers, hasChanged, notifyObservers, notifyObservers, setChanged

Methods inherited from class java.lang.Object

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

Field Details

YYYY

public static final String YYYY

See Also:

• Constant Field Values

MM_MYYYY

public static final String MM_MYYYY

See Also:

• Constant Field Values

DD_MM_MYYYY

public static final String DD_MM_MYYYY

See Also:

• Constant Field Values

DD_MM_MYYYY_HHMM

public static final String DD_MM_MYYYY_HHMM

See Also:

• Constant Field Values

DD_MM_MYYYY_HHMMZ

public static final String DD_MM_MYYYY_HHMMZ

See Also:

• Constant Field Values

UNIT

public static final String UNIT

See Also:

• Constant Field Values

Constructor Details

AbstractJDomDataObject

public AbstractJDomDataObject()

Method Details

buildElement

public abstract void buildElement(org.jdom.Element element)

Populates the element with data from this object.

Parameters:

element -

parseInt

protected int parseInt(org.jdom.Element parentElement,
 String childElementName,
 String[] units,
 int defaultValue)

parseFormattedDouble

protected double parseFormattedDouble(org.jdom.Element parentElement,
 String childElementName,
 String[] units,
 double defaultValue)

parseDouble

protected double parseDouble(org.jdom.Element parentElement,
 String childElementName,
 String[] units,
 double defaultValue)

camelCaseToLowerUnderbar

public static String camelCaseToLowerUnderbar(String word)

Converts a camelCase string to one with words separated by underbars (_) and lowercased. Loosely based on: http://www.malethan.com/article/humanise_camel_case_in_java.html

getDefaultElementName

protected String getDefaultElementName()

toXmlString

public String toXmlString()

Writes an AbstractJDomDataObject to an xml string. This method is mostly for debugging. The root element of the string that is returned is named based on a lowercased and underscored version of the classname. If the classname starts with "JDom" or ends with "Impl" those are removed.

Returns:

the xml string

getXmlValue

public static double getXmlValue(ParamDouble paramDouble,
 org.jdom.Element parent,
 String childElementName,
 int paramId)

setXmlValue

public static void setXmlValue(ParamDouble paramDouble,
 org.jdom.Element parent,
 String childElementName,
 Double value,
 int paramId)

getXmlDate

public static Date getXmlDate(org.jdom.Element parent,
 String childElementName,
 String dateFormat)

setXmlDate

public static void setXmlDate(org.jdom.Element element,
 String childElementName,
 String dateFormat,
 Date date)

buildElementOrRemove

protected org.jdom.Element buildElementOrRemove(org.jdom.Element element,
 String childElementName,
 AbstractJDomDataObject jdom)