Package hec.data.project

Class JDomProjectImpl

java.lang.Object

java.util.Observable

hec.lang.NamedType

hec.data.AbstractJDomDataObject

hec.data.project.JDomProjectImpl

All Implemented Interfaces:

ILocationAssociation, IProject, XmlString, AsciiSerializable, FieldAccessor, Serializable, Cloneable, Comparable, Observer, Modifiable

public class JDomProjectImpl
extends AbstractJDomDataObject
implements IProject

See Also:

• Serialized Form

Field Summary

Fields inherited from class hec.data.AbstractJDomDataObject

DD_MM_MYYYY, DD_MM_MYYYY_HHMM, DD_MM_MYYYY_HHMMZ, MM_MYYYY, UNIT, YYYY

Fields inherited from class hec.lang.NamedType

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

Fields inherited from interface hec.data.project.IProject

AUTHORIZING_LAW, BANK_FULL_CAPACITY_DESCRIPTION, COST_YEAR, DOWNSTREAM_URBAN_DESCRIPTION, ELEMENT, FEDERAL_COST, FEDERAL_OM_COST, HYDROPOWER_DESCRIPTION, NEAR_GAGE_LOCATION, NONFEDERAL_COST, NONFEDERAL_OM_COST, PROJECT_LOCATION, PROJECT_OWNER, PUMP_BACK_LOCATION, REMARKS, SEDIMENTATION_DESCRIPTION, VERSION, VERSION_1_0, YIELD_TIME_FRAME_END, YIELD_TIME_FRAME_START

Constructor Summary

Constructors

Constructor	Description
JDomProjectImpl()
JDomProjectImpl(Location projectLocation)
JDomProjectImpl(IProject iproject)
JDomProjectImpl(org.jdom.Element rootElement)

Method Summary

Modifier and Type	Method	Description
void	buildElement(org.jdom.Element element)	Populates the element with data from this object.
String	getAuthorizingLaw()	Returns the law authorizing this project.
String	getBankFullCapacityDescription()
long	getCostYear()	Returns the date of the major cost of the project.
Timestamp	getCostYearObject()	Returns the date of the major cost of the project.
String	getDownstreamUrbanDescription()
double	getFederalCost()	Returns the federal cost of this project.
void	getFederalCost(ParamDouble paramDouble)
BigDecimal	getFederalCostObject()
String	getFederalCostUnit()
double	getFederalOandMCost()	Returns the federal operations and maintenance cost for this project.
void	getFederalOandMCost(ParamDouble paramDouble)
BigDecimal	getFederalOandMCostObject()
String	getFederalOandMCostUnit()
String	getHydropowerDescription()
Location	getLocation()	Returns the location for this project.
Location	getNearGageLocation()	Returns by reference the location associated with the near gage for this project.
double	getNonFederalCost()	Returns the non federal cost of this project.
void	getNonFederalCost(ParamDouble paramDouble)
BigDecimal	getNonFederalCostObject()
String	getNonFederalCostUnit()
double	getNonFederalOandMCost()	Returns the non federal operations and maintenance cost for this project.
void	getNonFederalOandMCost(ParamDouble paramDouble)
BigDecimal	getNonFederalOandMCostObject()
String	getNonFederalOandMCostUnit()
String	getProjectId()	Returns the concatenated base location id - sub location id for this project.
String	getProjectOfficeId()	Returns the office id that owns this project.
String	getProjectOwner()	Returns the assigned owner of this project.
TimeZone	getProjectTimeZone()	Returns the office id that owns this project.
Location	getPumpbackLocation()	Returns by reference the location associated with water pumped back into ' this project, can be null.
String	getRemarks()	Returns the general remarks for this project.
String	getSedimentationDescription()
long	getYieldTimeFrameEnd()
Timestamp	getYieldTimeFrameEndTimestamp()
long	getYieldTimeFrameStart()
Timestamp	getYieldTimeFrameStartTimestamp()
void	setAuthorizingLaw(String authorizingLaw)	Sets the law authorizing this project.
void	setBankFullCapacityDescription(String bankFullCapacityDescription)
void	setCostYear(long year)	Sets the cost year of this project.
void	setCostYearObject(Timestamp time)
void	setDownstreamUrbanDescription(String downstreamUrbanDescription)
void	setFederalCost(double cost)	Sets the federal cost for this project.
void	setFederalCostObject(BigDecimal cost)
void	setFederalCostUnit(String federalCostUnit)
void	setFederalOandMCost(double cost)	Sets the federal operations and maintenance cost for this project.
void	setFederalOandMCostObject(BigDecimal cost)
void	setFederalOandMCostUnit(String federalOandMCostUnit)
void	setHydropowerDescription(String hydropowerDescription)
void	setLocation(Location projectLocation)
void	setNearGageLocation(Location location)
void	setNonFederalCost(double cost)	Sets the non federal cost of this project.
void	setNonFederalCostObject(BigDecimal cost)
void	setNonFederalCostUnit(String nonFederalCostUnit)
void	setNonFederalOandMCost(double cost)	Sets the non federal operations and maintenance cost for this project.
void	setNonFederalOandMCostObject(BigDecimal cost)
void	setNonFederalOandMCostUnit(String nonFederalOandMCostUnit)
void	setProjectOfficeId(String projectOfficeId)
void	setProjectOwner(String owner)	Sets the assigned owner of this project.
void	setPumpbackLocation(Location location)
void	setRemarks(String remarks)	Sets the general remarks for this project.
void	setSedimentationDescription(String sedimentationDescription)
void	setYieldTimeFrameEnd(long yieldTimeFrameEnd)
void	setYieldTimeFrameEndTimestamp(Timestamp input)
void	setYieldTimeFrameStart(long yieldTimeFrameStart)
void	setYieldTimeFrameStartTimestamp(Timestamp input)
String	toString()

Methods inherited from class hec.data.AbstractJDomDataObject

buildElementOrRemove, camelCaseToLowerUnderbar, getDefaultElementName, getXmlDate, getXmlValue, parseDouble, parseFormattedDouble, parseInt, setXmlDate, setXmlValue, toXmlString

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, 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

Methods inherited from interface rma.lang.Modifiable

isModified, setModified

Methods inherited from interface hec.data.XmlString

toXmlString

Constructor Details

JDomProjectImpl

public JDomProjectImpl(Location projectLocation)

JDomProjectImpl

public JDomProjectImpl()

JDomProjectImpl

public JDomProjectImpl(org.jdom.Element rootElement)

JDomProjectImpl

public JDomProjectImpl(IProject iproject)

Method Details

toString

public String toString()

Overrides:

toString in class NamedType

getLocation

public Location getLocation()

Description copied from interface: IProject

Returns the location for this project. Can be modified by reference.

Specified by:

getLocation in interface ILocationAssociation

Specified by:

getLocation in interface IProject

setLocation

public void setLocation(Location projectLocation)

Specified by:

setLocation in interface ILocationAssociation

Specified by:

setLocation in interface IProject

getProjectOfficeId

public String getProjectOfficeId()

Description copied from interface: IProject

Returns the office id that owns this project.

Specified by:

getProjectOfficeId in interface IProject

setProjectOfficeId

public void setProjectOfficeId(String projectOfficeId)

getFederalCostUnit

public String getFederalCostUnit()

Specified by:

getFederalCostUnit in interface IProject

setFederalCostUnit

public void setFederalCostUnit(String federalCostUnit)

getNonFederalCostUnit

public String getNonFederalCostUnit()

Specified by:

getNonFederalCostUnit in interface IProject

setNonFederalCostUnit

public void setNonFederalCostUnit(String nonFederalCostUnit)

getFederalOandMCostUnit

public String getFederalOandMCostUnit()

Specified by:

getFederalOandMCostUnit in interface IProject

setFederalOandMCostUnit

public void setFederalOandMCostUnit(String federalOandMCostUnit)

getNonFederalOandMCostUnit

public String getNonFederalOandMCostUnit()

Specified by:

getNonFederalOandMCostUnit in interface IProject

setNonFederalOandMCostUnit

public void setNonFederalOandMCostUnit(String nonFederalOandMCostUnit)

setBankFullCapacityDescription

public void setBankFullCapacityDescription(String bankFullCapacityDescription)

Specified by:

setBankFullCapacityDescription in interface IProject

setDownstreamUrbanDescription

public void setDownstreamUrbanDescription(String downstreamUrbanDescription)

Specified by:

setDownstreamUrbanDescription in interface IProject

setHydropowerDescription

public void setHydropowerDescription(String hydropowerDescription)

Specified by:

setHydropowerDescription in interface IProject

setSedimentationDescription

public void setSedimentationDescription(String sedimentationDescription)

Specified by:

setSedimentationDescription in interface IProject

setYieldTimeFrameEnd

public void setYieldTimeFrameEnd(long yieldTimeFrameEnd)

Specified by:

setYieldTimeFrameEnd in interface IProject

setYieldTimeFrameStart

public void setYieldTimeFrameStart(long yieldTimeFrameStart)

Specified by:

setYieldTimeFrameStart in interface IProject

getProjectTimeZone

public TimeZone getProjectTimeZone()

Description copied from interface: IProject

Returns the office id that owns this project.

Specified by:

getProjectTimeZone in interface IProject

getProjectId

public String getProjectId()

Description copied from interface: IProject

Returns the concatenated base location id - sub location id for this project.

Specified by:

getProjectId in interface IProject

getAuthorizingLaw

public String getAuthorizingLaw()

Description copied from interface: IProject

Returns the law authorizing this project.

Specified by:

getAuthorizingLaw in interface IProject

setAuthorizingLaw

public void setAuthorizingLaw(String authorizingLaw)

Description copied from interface: IProject

Sets the law authorizing this project.

Specified by:

setAuthorizingLaw in interface IProject

getFederalCostObject

public BigDecimal getFederalCostObject()

setFederalCostObject

public void setFederalCostObject(BigDecimal cost)

getFederalCost

public double getFederalCost()

Description copied from interface: IProject

Returns the federal cost of this project.

Specified by:

getFederalCost in interface IProject

Returns:

setFederalCost

public void setFederalCost(double cost)

Description copied from interface: IProject

Sets the federal cost for this project.

Specified by:

setFederalCost in interface IProject

getNonFederalCost

public double getNonFederalCost()

Description copied from interface: IProject

Returns the non federal cost of this project.

Specified by:

getNonFederalCost in interface IProject

Returns:

setNonFederalCost

public void setNonFederalCost(double cost)

Description copied from interface: IProject

Sets the non federal cost of this project.

Specified by:

setNonFederalCost in interface IProject

getNonFederalCostObject

public BigDecimal getNonFederalCostObject()

setNonFederalCostObject

public void setNonFederalCostObject(BigDecimal cost)

getCostYear

public long getCostYear()

Description copied from interface: IProject

Returns the date of the major cost of the project.

Specified by:

getCostYear in interface IProject

Returns:

a java ms utc time for the year.

setCostYear

public void setCostYear(long year)

Description copied from interface: IProject

Sets the cost year of this project.

Specified by:

setCostYear in interface IProject

Parameters:

year - a java ms utc time for the year.

getCostYearObject

public Timestamp getCostYearObject()

Description copied from interface: IProject

Returns the date of the major cost of the project. Used for database serialization

Specified by:

getCostYearObject in interface IProject

Returns:

timestamp for the year.

setCostYearObject

public void setCostYearObject(Timestamp time)

getFederalOandMCost

public double getFederalOandMCost()

Description copied from interface: IProject

Returns the federal operations and maintenance cost for this project.

Specified by:

getFederalOandMCost in interface IProject

Returns:

setFederalOandMCost

public void setFederalOandMCost(double cost)

Description copied from interface: IProject

Sets the federal operations and maintenance cost for this project.

Specified by:

setFederalOandMCost in interface IProject

getFederalOandMCostObject

public BigDecimal getFederalOandMCostObject()

setFederalOandMCostObject

public void setFederalOandMCostObject(BigDecimal cost)

getNonFederalOandMCost

public double getNonFederalOandMCost()

Description copied from interface: IProject

Returns the non federal operations and maintenance cost for this project.

Specified by:

getNonFederalOandMCost in interface IProject

Returns:

setNonFederalOandMCost

public void setNonFederalOandMCost(double cost)

Description copied from interface: IProject

Sets the non federal operations and maintenance cost for this project.

Specified by:

setNonFederalOandMCost in interface IProject

getNonFederalOandMCostObject

public BigDecimal getNonFederalOandMCostObject()

setNonFederalOandMCostObject

public void setNonFederalOandMCostObject(BigDecimal cost)

getRemarks

public String getRemarks()

Description copied from interface: IProject

Returns the general remarks for this project.

Specified by:

getRemarks in interface IProject

Returns:

setRemarks

public void setRemarks(String remarks)

Description copied from interface: IProject

Sets the general remarks for this project.

Specified by:

setRemarks in interface IProject

getProjectOwner

public String getProjectOwner()

Description copied from interface: IProject

Returns the assigned owner of this project.

Specified by:

getProjectOwner in interface IProject

Returns:

setProjectOwner

public void setProjectOwner(String owner)

Description copied from interface: IProject

Sets the assigned owner of this project.

Specified by:

setProjectOwner in interface IProject

getPumpbackLocation

public Location getPumpbackLocation()

Description copied from interface: IProject

Returns by reference the location associated with water pumped back into ' this project, can be null.

Specified by:

getPumpbackLocation in interface IProject

Returns:

setPumpbackLocation

public void setPumpbackLocation(Location location)

Specified by:

setPumpbackLocation in interface IProject

getNearGageLocation

public Location getNearGageLocation()

Description copied from interface: IProject

Returns by reference the location associated with the near gage for this project.

Specified by:

getNearGageLocation in interface IProject

Returns:

setNearGageLocation

public void setNearGageLocation(Location location)

Specified by:

setNearGageLocation in interface IProject

getBankFullCapacityDescription

public String getBankFullCapacityDescription()

Specified by:

getBankFullCapacityDescription in interface IProject

getDownstreamUrbanDescription

public String getDownstreamUrbanDescription()

Specified by:

getDownstreamUrbanDescription in interface IProject

getHydropowerDescription

public String getHydropowerDescription()

Specified by:

getHydropowerDescription in interface IProject

getSedimentationDescription

public String getSedimentationDescription()

Specified by:

getSedimentationDescription in interface IProject

getYieldTimeFrameEnd

public long getYieldTimeFrameEnd()

Specified by:

getYieldTimeFrameEnd in interface IProject

getYieldTimeFrameStart

public long getYieldTimeFrameStart()

Specified by:

getYieldTimeFrameStart in interface IProject

getYieldTimeFrameEndTimestamp

public Timestamp getYieldTimeFrameEndTimestamp()

Specified by:

getYieldTimeFrameEndTimestamp in interface IProject

setYieldTimeFrameEndTimestamp

public void setYieldTimeFrameEndTimestamp(Timestamp input)

getYieldTimeFrameStartTimestamp

public Timestamp getYieldTimeFrameStartTimestamp()

Specified by:

getYieldTimeFrameStartTimestamp in interface IProject

setYieldTimeFrameStartTimestamp

public void setYieldTimeFrameStartTimestamp(Timestamp input)

buildElement

public void buildElement(org.jdom.Element element)

Description copied from class: AbstractJDomDataObject

Populates the element with data from this object.

Specified by:

buildElement in class AbstractJDomDataObject

getFederalCost

public void getFederalCost(ParamDouble paramDouble)

Specified by:

getFederalCost in interface IProject

getNonFederalCost

public void getNonFederalCost(ParamDouble paramDouble)

Specified by:

getNonFederalCost in interface IProject

getFederalOandMCost

public void getFederalOandMCost(ParamDouble paramDouble)

Specified by:

getFederalOandMCost in interface IProject

getNonFederalOandMCost

public void getNonFederalOandMCost(ParamDouble paramDouble)

Specified by:

getNonFederalOandMCost in interface IProject