Package hec.rss.model.globalvariable

Class ExternalGlobalVariable

java.lang.Object

java.util.Observable

hec.lang.NamedType

hec.rss.model.globalvariable.BaseGlobalVariable

hec.rss.model.globalvariable.ExternalGlobalVariable

All Implemented Interfaces:

AsciiSerializable, FieldAccessor, GlobalVariable, Serializable, Cloneable, Comparable, Observer, rma.lang.Modifiable

public class ExternalGlobalVariable
extends BaseGlobalVariable

See Also:

• Serialized Form

Field Summary

Fields inherited from class hec.rss.model.globalvariable.BaseGlobalVariable

_altGvData, _network

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
ExternalGlobalVariable()
ExternalGlobalVariable(RssSystem network)

Method Summary

Modifier and Type	Method	Description
String	getDataLocation()	get the location of the external data
String	getDescriptiveText()	gets a description of the type of the global variable
ExternalDataType	getExternalDataDefinition()	get the GlobalVariable's data type definition
ExternalDataLocation	getExternalDataLocation()	get the ExternalDataLocation that's been assigned to this ExternalGlobalVariable
Object	getFieldObject(Field fld)	This method allows access to java.lang.reflect.Field objects within the implementing class.
RssSystem	getNetwork()	get the GlobalVariable's Network
String	getParameterType()	get the Parameter type for the GlobalVariable
String	getSource()	get the source of the external data
GlobalVariableType	getType()
void	outputReport(AlternativeInputReport report, org.jdom.Element myElem)	add the external global variable information to the alternative report
void	setExternalDataDefinition(ExternalDataType dataDefinition)
boolean	setFieldObject(Field fld, Object obj)	This allows access to fields withing the implementing object to set there data.
void	setParameterType(String paramType)	set the ParameterType for the GlobalVariable

Methods inherited from class hec.rss.model.globalvariable.BaseGlobalVariable

clone, finalizeCompute, getComputeMsg, getIsDataLocation, getUsageType, hasValidValue, initializeGv, isInput, printToComputeLog, printToComputeWindow, setGlobalVariableData, setInput, setIsDataLocation

Methods inherited from class hec.lang.NamedType

addModifiableListener, compareTo, fireModifiedStateChanged, getDescription, getDisplayName, getIgnoreModifiedEvents, getIndex, getName, isModified, isValid, readResolve, removeModifiableListener, rename, set, setDescription, 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

Methods inherited from interface hec.rss.model.globalvariable.GlobalVariable

getDescription, getIndex, getName, setDescription, setIndex, setName

Constructor Details

ExternalGlobalVariable

public ExternalGlobalVariable()

ExternalGlobalVariable

public ExternalGlobalVariable(RssSystem network)

Method Details

getType

public GlobalVariableType getType()

getDescriptiveText

public String getDescriptiveText()

Description copied from interface: GlobalVariable

gets a description of the type of the global variable

Returns:

descriptive text

getNetwork

public RssSystem getNetwork()

get the GlobalVariable's Network

Specified by:

getNetwork in interface GlobalVariable

Overrides:

getNetwork in class BaseGlobalVariable

Returns:

the GlobalVariable's network

outputReport

public void outputReport(AlternativeInputReport report,
 org.jdom.Element myElem)

add the external global variable information to the alternative report

Specified by:

outputReport in interface GlobalVariable

Overrides:

outputReport in class BaseGlobalVariable

Parameters:

report - the alternative report

myElem - the element for this global variable

getExternalDataDefinition

public ExternalDataType getExternalDataDefinition()

get the GlobalVariable's data type definition

Returns:

the GlobalVariable's data type definition

setExternalDataDefinition

public void setExternalDataDefinition(ExternalDataType dataDefinition)

setParameterType

public void setParameterType(String paramType)

set the ParameterType for the GlobalVariable

Parameters:

paramType -

getParameterType

public String getParameterType()

get the Parameter type for the GlobalVariable

Returns:

the Parameter type

getDataLocation

public String getDataLocation()

get the location of the external data

Returns:

getSource

public String getSource()

get the source of the external data

Returns:

getExternalDataLocation

public ExternalDataLocation getExternalDataLocation()

get the ExternalDataLocation that's been assigned to this ExternalGlobalVariable

Returns:

getFieldObject

public Object getFieldObject(Field fld)

Description copied from interface: FieldAccessor

This method allows access to java.lang.reflect.Field objects within the implementing class.

Specified by:

getFieldObject in interface FieldAccessor

Overrides:

getFieldObject in class BaseGlobalVariable

Parameters:

fld - The field to get.

Returns:

The data object that is stored in the given field

setFieldObject

public boolean setFieldObject(Field fld,
 Object obj)

Description copied from interface: FieldAccessor

This allows access to fields withing the implementing object to set there data.

Specified by:

setFieldObject in interface FieldAccessor

Overrides:

setFieldObject in class BaseGlobalVariable

Parameters:

fld - The java field object representing the member field to be set

obj - The data to set in that field

Returns:

returns true if successful