Package hec.data.timeSeriesText

Class TextDescriptionTx

java.lang.Object
hec.data.timeSeriesText.TextDescriptionTx
All Implemented Interfaces:
ITimeSeriesDescription
@Deprecated(forRemoval=true) public class TextDescriptionTx extends Object implements ITimeSeriesDescription
Deprecated, for removal: This API element is subject to removal in a future version.
This class is marked for removal and should not be used. Update to use hec-nucleus data types instead. Replaced by TimeSeriesIdentifier

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static class 
    TextDescriptionTx.TextDescriptionTxComparator
    Deprecated, for removal: This API element is subject to removal in a future version.
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    TextDescriptionTx()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    TextDescriptionTx(TextDescriptionTx textDescriptionTx)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    TextDescriptionTx(String officeId, String delimString)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Creates a new TextDescriptionTx

  • Method Summary

    Modifier and Type
    Method
    Description
    ITimeSeriesDescription
    copy()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    boolean
    equals(Object obj)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    boolean
    getActive()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    Duration
    getDuration()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    Interval
    getInterval()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    LocationTemplate
    getLocationRef()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    rma.util.lookup.Lookup
    getLookup()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Returns a lookup of capabilites that can be done on this object
    String
    getOfficeId()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    String
    getParameterId()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    ParameterType
    getParameterType()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    String
    getTimeSeriesId()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    int
    getUserPrivilege()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    IntervalOffset
    getUtcIntervalOffsetObject()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    Version
    getVersion()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    int
    hashCode()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    boolean
    isRegular()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    void
    setDuration(Duration duration)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    void
    setInterval(Interval interval)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    void
    setLocationRef(LocationTemplate template)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    void
    setParameterType(ParameterType parameterType)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    void
    setUtcIntervalOffset(IntervalOffset utcOffset)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    void
    setVersion(Version version)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    String
    toString()
    Deprecated, for removal: This API element is subject to removal in a future version.
     

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • TextDescriptionTx

      public TextDescriptionTx(String officeId, String delimString) throws DataSetIllegalArgumentException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Creates a new TextDescriptionTx

      Parameters:
      officeId - a valid USACE office id i.e. "SWF", "LRH", "SWT"
      delimString - a delimited string delimited by '.' characters of the form [locationId].[parameterId].[parameterTypeId].[intervaId].[durationId].[versionId]
    • location id = a simple name of the location to be retrieved
    • parameter id = Must be the string value "Text", otherwise a DataSetIllegalArugmentException is thrown
    • parameter type id = must be one of the valid "Parameter Type" strings as defined in the ParmaeterType class
    • interval id = must be a valid interval such as 1HOUR, 1DAY, etc. Valid interval values are defined by the hec.data.Interval class
    • duration id = a valid duration string as defined by the Duration class. Similar to Interval.
    • version id = a valid version string as defined by the Version class. Similar to FPART in DSS.

      • Throws:
      DataSetIllegalArgumentException - if the delimited string is incorrect in any way.
      See Also:

    • TextDescriptionTx

      public TextDescriptionTx()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • TextDescriptionTx

      public TextDescriptionTx(TextDescriptionTx textDescriptionTx)
      Deprecated, for removal: This API element is subject to removal in a future version.

  • Method Details

    • getLookup

      public rma.util.lookup.Lookup getLookup()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Returns a lookup of capabilites that can be done on this object
      Specified by:
      getLookup in interface ITimeSeriesDescription

    • getOfficeId

      public String getOfficeId()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Specified by:
      getOfficeId in interface ITimeSeriesDescription

    • getLocationRef

      public LocationTemplate getLocationRef()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Specified by:
      getLocationRef in interface ITimeSeriesDescription

    • setLocationRef

      public void setLocationRef(LocationTemplate template)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Specified by:
      setLocationRef in interface ITimeSeriesDescription

    • getParameterId

      public String getParameterId()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Specified by:
      getParameterId in interface ITimeSeriesDescription

    • getParameterType

      public ParameterType getParameterType()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Specified by:
      getParameterType in interface ITimeSeriesDescription

    • setParameterType

      public void setParameterType(ParameterType parameterType)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • getInterval

      public Interval getInterval()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Specified by:
      getInterval in interface ITimeSeriesDescription

    • setInterval

      public void setInterval(Interval interval)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • getDuration

      public Duration getDuration()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Specified by:
      getDuration in interface ITimeSeriesDescription

    • setDuration

      public void setDuration(Duration duration)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • getVersion

      public Version getVersion()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Specified by:
      getVersion in interface ITimeSeriesDescription

    • setVersion

      public void setVersion(Version version)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • getUserPrivilege

      public int getUserPrivilege()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Specified by:
      getUserPrivilege in interface ITimeSeriesDescription

    • getActive

      public boolean getActive()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Specified by:
      getActive in interface ITimeSeriesDescription

    • isRegular

      public boolean isRegular()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Specified by:
      isRegular in interface ITimeSeriesDescription

    • getUtcIntervalOffsetObject

      public IntervalOffset getUtcIntervalOffsetObject()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Specified by:
      getUtcIntervalOffsetObject in interface ITimeSeriesDescription

    • setUtcIntervalOffset

      public void setUtcIntervalOffset(IntervalOffset utcOffset)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • getTimeSeriesId

      public String getTimeSeriesId()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Specified by:
      getTimeSeriesId in interface ITimeSeriesDescription

    • toString

      public String toString()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Overrides:
      toString in class Object

    • copy

      public ITimeSeriesDescription copy()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Specified by:
      copy in interface ITimeSeriesDescription

    • hashCode

      public int hashCode()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Overrides:
      hashCode in class Object

    • equals

      public boolean equals(Object obj)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Overrides:
      equals in class Object