Package hec.data.tx

Class TimeSeriesCategory

java.lang.Object

java.util.Observable

hec.lang.NamedType

hec.data.tx.TimeSeriesCategory

All Implemented Interfaces:

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

public class TimeSeriesCategory
extends NamedType

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DESCRIPTION
static final Logger	logger

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
TimeSeriesCategory(TimeSeriesCategoryRef catRef, String description)
TimeSeriesCategory(String officeId, String categoryId, String description)
TimeSeriesCategory(org.jdom.Element element)

Method Summary

Modifier and Type	Method	Description
TimeSeriesGroupRef	addGroup(TimeSeriesGroupRef input)
TimeSeriesGroupRef	addGroup(String groupId)
TimeSeriesGroupRef	addGroup(String groupOfficeId, String groupId)
void	buildElement(org.jdom.Element element)
TimeSeriesCategoryRef	getCategoryRef()
String	getId()	Returns the category id.
String	getOfficeId()
void	removeGroup(TimeSeriesGroupRef toRemove)
void	setGroups(Collection<TimeSeriesGroupRef> newGroups)
int	size()	Returns a count of the timeseries groups in this category.
String	toString()
String	toXmlString()
Collection<TimeSeriesGroupRef>	values()	Returns a copy of the timeseries groups in this category.

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

Field Details

logger

public static final Logger logger

DESCRIPTION

public static final String DESCRIPTION

See Also:

• Constant Field Values

Constructor Details

TimeSeriesCategory

public TimeSeriesCategory(String officeId,
 String categoryId,
 String description)

TimeSeriesCategory

public TimeSeriesCategory(TimeSeriesCategoryRef catRef,
 String description)

TimeSeriesCategory

public TimeSeriesCategory(org.jdom.Element element)

Method Details

buildElement

public void buildElement(org.jdom.Element element)

getId

public String getId()

Returns the category id.

getOfficeId

public String getOfficeId()

getCategoryRef

public TimeSeriesCategoryRef getCategoryRef()

addGroup

public TimeSeriesGroupRef addGroup(String groupOfficeId,
 String groupId)

addGroup

public TimeSeriesGroupRef addGroup(TimeSeriesGroupRef input)

addGroup

public TimeSeriesGroupRef addGroup(String groupId)

removeGroup

public void removeGroup(TimeSeriesGroupRef toRemove)

setGroups

public void setGroups(Collection<TimeSeriesGroupRef> newGroups)

size

public int size()

Returns a count of the timeseries groups in this category.

values

public Collection<TimeSeriesGroupRef> values()

Returns a copy of the timeseries groups in this category.

Returns:

toXmlString

public String toXmlString()

toString

public String toString()

Overrides:

toString in class NamedType