Package hec.data.tx

Class TimeSeriesGroup

java.lang.Object
java.util.Observable
hec.lang.NamedType
hec.data.tx.TimeSeriesGroup
All Implemented Interfaces:
AsciiSerializable, FieldAccessor, Serializable, Cloneable, Comparable, Observer, Modifiable
public class TimeSeriesGroup extends NamedType
Represents a database time series group owned by a time series category.
See Also:

  • Field Details

  • Constructor Details

    • TimeSeriesGroup

      public TimeSeriesGroup()
      Instantiates a new timeseries group.

    • TimeSeriesGroup

      public TimeSeriesGroup(String groupId, TimeSeriesCategoryRef categoryRef, String groupDescription, String dbOfficeId, String sharedLocAliasId, String sharedTimeSeriesRef)
      Instantiates a new timeseries group.
      Parameters:
      groupId - the group id
      categoryRef - the category ref
      groupDescription - the group description
      dbOfficeId - the db office id
      sharedLocAliasId - Shared timeseries alias assigned to all members of this group by virtue of membership
      sharedTimeSeriesRef - Shared reference to existing timeseries assigned to all members of this group by virtue of membership

    • TimeSeriesGroup

      public TimeSeriesGroup(TimeSeriesGroupRef group, String groupDescription, String locAliasId, String timeSeriesRef)

    • TimeSeriesGroup

      public TimeSeriesGroup(org.jdom.Element element)
      Instantiates a new timeseries group.
      Parameters:
      element - the element

  • Method Details

    • getTimeSeriesGroupRef

      public TimeSeriesGroupRef getTimeSeriesGroupRef()

    • setTimeSeriesGroupRef

      public void setTimeSeriesGroupRef(TimeSeriesGroupRef tsGroupRef)

    • buildAssignedTimeSeries

      protected AssignedTimeSeries buildAssignedTimeSeries(org.jdom.Element element)

    • buildElement

      public void buildElement(org.jdom.Element element)
      Builds the element.
      Parameters:
      element - the element

    • getGroupDescription

      public String getGroupDescription()
      Gets the group description.
      Returns:
      the group description

    • setGroupDescription

      public void setGroupDescription(String groupDescription)
      Sets the group description.
      Parameters:
      groupDescription - the new group description

    • getId

      public String getId()
      Gets the group id.
      Returns:
      the group id

    • setId

      public void setId(String groupId)
      Sets the group id.
      Parameters:
      groupId - the new group id

    • getDbOfficeId

      public String getDbOfficeId()
      Gets the db office id.
      Returns:
      the db office id

    • setDbOfficeId

      public void setDbOfficeId(String dbOfficeId)
      Sets the db office id.
      Parameters:
      dbOfficeId - the new db office id

    • getCategoryRef

      public TimeSeriesCategoryRef getCategoryRef()
      Gets the category ref.
      Returns:
      the category ref

    • setCategoryRef

      public void setCategoryRef(TimeSeriesCategoryRef categoryRef)
      Sets the category ref.
      Parameters:
      categoryRef - the new category ref

    • getSharedTsAliasId

      public String getSharedTsAliasId()

    • setSharedTsAliasId

      public void setSharedTsAliasId(String aliasId)

    • getSharedTsRef

      public String getSharedTsRef()

    • setSharedTsRef

      public void setSharedTsRef(String sharedLocRef)

    • getAssignedTimeSeries

      public Set<AssignedTimeSeries> getAssignedTimeSeries()
      Gets the assigned timeseries by reference, this is not a copy so be careful.
      Returns:
      the assigned timeseries

    • getAssignedTimeSeriesSorted

      public List<AssignedTimeSeries> getAssignedTimeSeriesSorted()
      Gets a list containing the assigned timeseries sorted by assigned_timeseries.attribute.
      Returns:
      the assigned timeseries

    • setAssignedTimeSeries

      public void setAssignedTimeSeries(Set<AssignedTimeSeries> newSeries)
      Sets the assigned timeseries.
      Parameters:
      newSeries - the new assigned timeseries

    • addAssignedTimeSeries

      public void addAssignedTimeSeries(AssignedTimeSeries newTimeSeries)

    • addAssignedTimeSeriesToEnd

      public void addAssignedTimeSeriesToEnd(Collection<AssignedTimeSeries> after)

    • addAssignedTimeSeriesToEnd

      public void addAssignedTimeSeriesToEnd(AssignedTimeSeries newTimeSeries)

    • toXmlString

      public String toXmlString()

    • getCategoryId

      public String getCategoryId()
      Gets the category id from the containing category.
      Returns:
      the category id

    • removeTimeSeries

      public AssignedTimeSeries removeTimeSeries(String tsId)

    • containsTimeSeriesRef

      public boolean containsTimeSeriesRef(String tsId)

    • toString

      public String toString()
      Returns a String concatenation of the category id and group id separated by a "-".
      Overrides:
      toString in class NamedType

    • moveUp

      public void moveUp(String tsId)

    • moveDown

      public void moveDown(String tsId)