Package hec.data.tx

Class DSSTimeSeriesUtil

java.lang.Object
hec.data.tx.DSSTimeSeriesUtil
public final class DSSTimeSeriesUtil extends Object

  • Method Details

    • getLocationIdStrLen

      public static int getLocationIdStrLen()

    • getBaseLocationStrLen

      public static int getBaseLocationStrLen()

    • getSubLocationStrLen

      public static int getSubLocationStrLen()

    • getSubParameterStrLen

      public static int getSubParameterStrLen()

    • getVersionStrLen

      public static int getVersionStrLen()

    • getDefaultPathname

      public static String getDefaultPathname(mil.army.usace.hec.data.timeseries.math.TimeSeriesTemplate dataSetTxTemplate)

    • getDefaultPathname

      public static String getDefaultPathname(mil.army.usace.hec.metadata.timeseries.TimeSeriesIdentifier description)

    • getParameterType

      public static mil.army.usace.hec.metadata.ParameterType getParameterType(String dssType)
      getParameterType returns a CWMS ParameterType object derived from a DSS Type. If the DSS Type is not known to CWMS, the parameter type this returned as a null.

    • getIntervalFromDssInterval

      public static mil.army.usace.hec.metadata.Interval getIntervalFromDssInterval(String dssIntervalStr) throws mil.army.usace.hec.metadata.DataSetIllegalArgumentException
      getIntervalFromDssInterval returns a CWMS Interval object derived from a DSS Interval String. If the DSS Interval is not known to CWMS, the Interval this returned as a null.
      Throws:
      mil.army.usace.hec.metadata.DataSetIllegalArgumentException

    • getDSSType

      public static String getDSSType(mil.army.usace.hec.metadata.timeseries.TimeSeriesIdentifier description)

    • getDSSType

      public static String getDSSType(mil.army.usace.hec.metadata.Parameter parameter, mil.army.usace.hec.metadata.ParameterType parameterType)
      getDSSType returns a string of DSS type derived from the CWMS parameter and parameter type.

    • getDefaultDescription

      public static mil.army.usace.hec.metadata.timeseries.TimeSeriesIdentifier getDefaultDescription(String dssPath, String dssType, mil.army.usace.hec.metadata.timeseries.TimeSeriesIdentifier similarDesc) throws mil.army.usace.hec.metadata.DataSetIllegalArgumentException
      getDefaultDescription returns a TimeSeriesIdentifier object derived from the DSS Pathname string, a DSS Type string, and a CWMS Description object.

      The description method argument is may be null, in which case appropriate exceptions are thrown for unrecognized DSS pathname C-PART and DSS data types.

      If the DSS Pathname C-PART string contains the parameterType and duration in the form "parameter--parameterType-duration", these are overridden by the specified argument string "dssType".

      If the "dssType" is specified as "null", the parameterType will be taken from the pathname C-Part first, or if the C-Part contains no parameterType, from the description argument object.

      Duration will come from the description argument object when it is not null and its duration is compatible with parameterType determined as above. When the description argument is null or its duration is incompatible, duration will come first from the C-Part when it is specified, or it will be set to the value of interval.

      If the DSS Pathname C-PART contains a CWMS recognized parameter, it will be used in the resulting description. Otherwise the parameter from the method argument TimeSeriesIdentifier object "similarDesc" will be used.

      If the DSS Pathame E-PART is a recognized DSS interval, it will be used in the resulting description.

      Throws:
      mil.army.usace.hec.metadata.DataSetIllegalArgumentException
      mil.army.usace.hec.metadata.DataSetIllegalArgumentException

    • getDescriptionDifferences

      public static StringBuilder getDescriptionDifferences(mil.army.usace.hec.metadata.timeseries.TimeSeriesIdentifier desc1, mil.army.usace.hec.metadata.timeseries.TimeSeriesIdentifier desc2)
      getDescriptionDifferences returns list of differences between two descriptions, excluding location or labeling, or null if no differences. Optional String arguments identify the DSS-Pathname or DSS-type equivalent to each description, which are used to construct additional labels in the first or second description's interval or parameterType difference messages.

    • getDescriptionDifferences

      public static StringBuilder getDescriptionDifferences(mil.army.usace.hec.metadata.timeseries.TimeSeriesIdentifier desc1, String desc1DssType, mil.army.usace.hec.metadata.timeseries.TimeSeriesIdentifier desc2)

    • getDescriptionDifferences

      public static StringBuilder getDescriptionDifferences(mil.army.usace.hec.metadata.timeseries.TimeSeriesIdentifier desc1, mil.army.usace.hec.metadata.timeseries.TimeSeriesIdentifier desc2, String desc2DssType)

    • getDescriptionDifferences

      public static StringBuilder getDescriptionDifferences(mil.army.usace.hec.metadata.timeseries.TimeSeriesIdentifier desc1, String pathname1, String desc1DssType, mil.army.usace.hec.metadata.timeseries.TimeSeriesIdentifier desc2)

    • getDescriptionDifferences

      public static StringBuilder getDescriptionDifferences(mil.army.usace.hec.metadata.timeseries.TimeSeriesIdentifier desc1, mil.army.usace.hec.metadata.timeseries.TimeSeriesIdentifier desc2, String pathname2, String desc2DssType)

    • getDescriptionDifferences

      public static StringBuilder getDescriptionDifferences(mil.army.usace.hec.metadata.timeseries.TimeSeriesIdentifier desc1, String pathname1, String dssType1, mil.army.usace.hec.metadata.timeseries.TimeSeriesIdentifier desc2, String pathname2, String dssType2)