Package hec.data.tx

Class DataSetTxTemplate

All Implemented Interfaces:
Serializable
Direct Known Subclasses:
DataSetTx

@Deprecated public class DataSetTxTemplate extends AbstractDataSetT implements Serializable
Deprecated.
Template to define characteristics of a data set. Templates can be used to define what data is desired to be read from a database, to be derived from another compatable data set, or other purpose. Because a DataSetTx extends a DataSetTxTemplate, a DataSetTx may be used as a template.
See Also:
  • Constructor Details

  • Method Details

    • equals

      public boolean equals(Object o)
      Deprecated.
      Overrides:
      equals in class Object
    • hashCode

      public int hashCode()
      Deprecated.
      Overrides:
      hashCode in class Object
    • getTimeSeriesTemplate

      public final mil.army.usace.hec.data.timeseries.math.TimeSeriesTemplate getTimeSeriesTemplate()
      Deprecated.
    • equals

      public boolean equals(DataSetTxTemplate dataSetTxTemplate)
      Deprecated.
    • toString

      public String toString()
      Deprecated.
      Overrides:
      toString in class Object
    • toString

      public String toString(String timeZone)
      Deprecated.
    • getUnits

      public Units getUnits()
      Deprecated.
      Returns:
      copy of the units used in this template
    • setUnits

      public final void setUnits(Units units) throws DataSetTxIllegalArgumentException
      Deprecated.
      Sets the units used in this template
      Parameters:
      units - new units for this template
      Throws:
      DataSetTxIllegalArgumentException
    • setPreserveRejectedAndMissingValues

      public void setPreserveRejectedAndMissingValues(boolean preserveRejectedAndMissingValues)
      Deprecated.
    • getPreserveRejectedAndMissingValues

      public boolean getPreserveRejectedAndMissingValues()
      Deprecated.
    • setMaxTimeGap

      public void setMaxTimeGap(long maxTimeGap)
      Deprecated.
    • setMaxTimeGapDefinedByIntervals

      public void setMaxTimeGapDefinedByIntervals(int maxTimeGapDefinedByIntervals)
      Deprecated.
    • setMaxTimeGapDefinedByMinutes

      public void setMaxTimeGapDefinedByMinutes(int maxTimeGapDefinedByMinutes)
      Deprecated.
    • setMaxTimeGapDefinedByHours

      public void setMaxTimeGapDefinedByHours(int maxTimeGapDefinedByHours)
      Deprecated.
    • getMaxTimeGap

      public long getMaxTimeGap()
      Deprecated.
    • getStartTimeString

      public String getStartTimeString()
      Deprecated.
    • getStartTimeString

      public String getStartTimeString(String timeZone)
      Deprecated.
    • getEndTimeString

      public String getEndTimeString()
      Deprecated.
    • getEndTimeString

      public String getEndTimeString(String timeZone)
      Deprecated.
    • getStartTime

      public long getStartTime()
      Deprecated.
    • getEndTime

      public long getEndTime()
      Deprecated.
    • clearTimeWindow

      public void clearTimeWindow()
      Deprecated.
    • clearTimeWindowInternal

      protected void clearTimeWindowInternal()
      Deprecated.
    • setStartTime

      public void setStartTime(long startTime) throws DataSetTxIllegalArgumentException
      Deprecated.
      Throws:
      DataSetTxIllegalArgumentException
    • setStartTimeInternal

      protected void setStartTimeInternal(long startTime) throws DataSetTxIllegalArgumentException
      Deprecated.
      Throws:
      DataSetTxIllegalArgumentException
    • setEndTime

      public void setEndTime(long endTime) throws DataSetTxIllegalArgumentException
      Deprecated.
      Throws:
      DataSetTxIllegalArgumentException
    • setEndTimeInternal

      protected void setEndTimeInternal(long endTime) throws DataSetTxIllegalArgumentException
      Deprecated.
      Throws:
      DataSetTxIllegalArgumentException
    • isTemplate

      public static boolean isTemplate(DataSetTxTemplate dataSetTxTemplate)
      Deprecated.
    • getDescriptionTx

      public DescriptionTx getDescriptionTx()
      Deprecated.
      Returns a copy of the time series identifier for this template. The description was made immutable because parts of the description are dependent on the time series data and allow changes in those parts could lead to an illegal state. That said - not all parts of the description are immutable and as such, limited access to those parts should be defined via accessors in the data set tx template.
    • getOfficeId

      public String getOfficeId()
      Deprecated.
      Returns the office id of the encapsulated description tx.
      Returns:
    • setOfficeId

      public void setOfficeId(String officeId)
      Deprecated.
      Sets the office id of the encapsulated description tx.
      Parameters:
      officeId -
    • getVersion

      public Version getVersion()
      Deprecated.
      Returns a reference (not a copy) to the version associated with this object's time series identifier.
      Returns:
    • setVersion

      public void setVersion(Version version)
      Deprecated.
      Sets the version of this object's time series identifier to the argument value.
      Parameters:
      version -
    • show

      public void show()
      Deprecated.
    • show

      public void show(String timeZone)
      Deprecated.