Package hec.data

Class Parameter

java.lang.Object
mil.army.usace.hec.metadata.Parameter
hec.data.Parameter
All Implemented Interfaces:
Serializable
@Deprecated public class Parameter extends mil.army.usace.hec.metadata.Parameter
Deprecated.
As of 02/08/2021 use Parameter from hec-nucleus-metadata instead.
The Class Parameter.
See Also:

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    PARAMID_AREA
    Deprecated.
    The Constant PARAMID_AREA.
    static final int
    PARAMID_AREABASIN
    Deprecated.
    The Constant PARAMID_AREABASIN.
    static final int
    PARAMID_AREAIMPACTED
    Deprecated.
    The Constant PARAMID_AREAIMPACTED.
    static final int
    PARAMID_AREAKA
    Deprecated.
    The Constant PARAMID_AREAKA.
    static final int
    PARAMID_AREARESERVOIR
    Deprecated.
    The Constant PARAMID_AREARESERVOIR.
    static final int
    PARAMID_AREASURFACE
    Deprecated.
    The Constant PARAMID_AREASURFACE.
    static final int
    PARAMID_ATI
    Deprecated.
    The Constant PARAMID_ATI.
    static final int
    PARAMID_BOTTOM_LENGTH
    Deprecated.
    The Constant PARAMID_BOTTOM_LENGTH.
    static final int
    PARAMID_COLDRATE
    Deprecated.
    The Constant PARAMID_COLDRATE.
    static final int
    PARAMID_CONC
    Deprecated.
    The Constant PARAMID_CONC.
    static final int
    PARAMID_COSTKAF
    Deprecated.
    The Constant PARAMID_COSTKAF.
    static final int
    PARAMID_COUNT
    Deprecated.
    The Constant PARAMID_COUNT.
    static final int
    PARAMID_CURENCY
    Deprecated.
    The Constant PARAMID_CURENCY.
    static final int
    PARAMID_DENSITY
    Deprecated.
    The Constant PARAMID_DENSITY.
    static final int
    PARAMID_DEPOSITION
    Deprecated.
    The Constant PARAMID_DEPOSITION.
    static final int
    PARAMID_DEPTH
    Deprecated.
    The Constant PARAMID_DEPTH.
    static final int
    PARAMID_DISTANCE
    Deprecated.
    The Constant PARAMID_DISTANCE.
    static final int
    PARAMID_ELEV
    Deprecated.
    The Constant PARAMID_ELEV.
    static final int
    PARAMID_ENERGY
    Deprecated.
    The Constant PARAMID_ENERGY.
    static final int
    PARAMID_EVAP
    Deprecated.
    The Constant PARAMID_EVAP.
    static final int
    PARAMID_EVAPRATE
    Deprecated.
    The Constant PARAMID_EVAPRATE.
    static final int
    PARAMID_EXTINCTION
    Deprecated.
    The Constant PARAMID_EXTINCTION.
    static final int
    PARAMID_FLOW
    Deprecated.
    The Constant PARAMID_FLOW.
    static final int
    PARAMID_FLOWKAF
    Deprecated.
    The Constant PARAMID_FLOWKAF.
    static final int
    PARAMID_FLOWPERAREA
    Deprecated.
    The Constant PARAMID_FLOWPERAREA.
    static final int
    PARAMID_GROWTH_RATE
    Deprecated.
    The Constant PARAMID_GROWTH_RATE.
    static final int
    PARAMID_LENGTH
    Deprecated.
    The Constant PARAMID_LENGTH.
    static final int
    PARAMID_LOSSDEFICIT
    Deprecated.
    The Constant PARAMID_LOSSDEFICIT.
    static final int
    PARAMID_LOSSRATE
    Deprecated.
    The Constant PARAMID_LOSSRATE.
    static final int
    PARAMID_MELTRATE
    Deprecated.
    The Constant PARAMID_MELTRATE.
    static final int
    PARAMID_OPENING
    Deprecated.
    The Constant PARAMID_OPENING.
    static final int
    PARAMID_PENALTY
    Deprecated.
    The Constant PARAMID_PENALTY.
    static final int
    PARAMID_PERC
    Deprecated.
    The Constant PARAMID_PERC.
    static final int
    PARAMID_PERCENT
    Deprecated.
    The Constant PARAMID_PERCENT.
    static final int
    PARAMID_PERCRATE
    Deprecated.
    The Constant PARAMID_PERCRATE.
    static final int
    PARAMID_POWER
    Deprecated.
    The Constant PARAMID_POWER.
    static final int
    PARAMID_PRECIP
    Deprecated.
    The Constant PARAMID_PRECIP.
    static final int
    PARAMID_PRESSURE
    Deprecated.
    The Constant PARAMID_PRESSURE.
    static final int
    PARAMID_RATE_OF_RISE
    Deprecated.
    The Constant PARAMID_RATE_OF_RISE.
    static final int
    PARAMID_SALINITY
    Deprecated.
    The Constant PARAMID_SALINITY.
    static final int
    PARAMID_SED_LOAD
    Deprecated.
    The Constant PARAMID_SED_LOAD.
    static final int
    PARAMID_SED_SIZE
    Deprecated.
    The Constant PARAMID_SED_SIZE.
    static final int
    PARAMID_SEDIMENT_DISCHARGE
    Deprecated.
    The Constant PARAMID_SEDIMENT_DISCHARGE.
    static final int
    PARAMID_SHADE_FRAC
    Deprecated.
    The Constant PARAMID_SHADE_FRAC.
    static final int
    PARAMID_SPEED
    Deprecated.
     
    static final int
    PARAMID_SPINRATE
    Deprecated.
    The Constant PARAMID_SPINRATE.
    static final int
    PARAMID_STAGE
    Deprecated.
    The Constant PARAMID_STAGE.
    static final int
    PARAMID_STOR
    Deprecated.
    The Constant PARAMID_STOR.
    static final int
    PARAMID_STORKAF
    Deprecated.
    The Constant PARAMID_STORKAF.
    static final int
    PARAMID_SUSP_SOLIDS
    Deprecated.
    The Constant PARAMID_SUSP_SOLIDS.
    static final int
    PARAMID_TEMP
    Deprecated.
    The Constant PARAMID_TEMP.
    static final int
    PARAMID_THICKNESS
    Deprecated.
    The Constant PARAMID_THICKNESS.
    static final int
    PARAMID_TIMING
    Deprecated.
    The Constant PARAMID_TIMING.
    static final int
    PARAMID_TIMING_OFFSET
    Deprecated.
    The Constant PARAMID_TIMING_OFFSET.
    static final int
    PARAMID_TIMING_PERIOD
    Deprecated.
    The Constant PARAMID_TIMING_PERIOD.
    static final int
    PARAMID_TRAVEL
    Deprecated.
    The Constant PARAMID_TRAVEL.
    static final int
    PARAMID_VOLUME
    Deprecated.
    The Constant PARAMID_VOLUME.
    static final int
    PARAMID_WIDTH
    Deprecated.
    The Constant PARAMID_WIDTH.
    static final int
    UNDEF_PARAMETER_ID
    Deprecated.
    The Constant UNDEF_PARAMETER_ID.

    Fields inherited from class mil.army.usace.hec.metadata.Parameter

    PARAMID_COEFF, PARAMID_CURRENCY, PARAMID_PROBABILITY

  • Constructor Summary

    Constructors
    Constructor
    Description
    Parameter()
    Deprecated.
    Instantiates a new parameter.
    Parameter(Parameter parameter)
    Deprecated.
    Instantiates a new parameter.
    Parameter(String parameter)
    Deprecated.
    Instantiates a new parameter.
    Parameter(String baseParameter, String subParameter)
    Deprecated.
    Instantiates a new parameter.
    Parameter(mil.army.usace.hec.metadata.Parameter parameter)
    Deprecated.
     

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Parameter parameter)
    Deprecated.
    Use the object equals instead cause it is more accurate.
    static String[]
    getAvailableParameters()
    Deprecated.
     
    static Parameter
    getParameter(int paramID)
    Deprecated.
    Gets the Parameter for the given ParamID.
    static Parameter
    getParameterForUnitsString(String units)
    Deprecated.
    Gets the parameter for units string.
    static String
    getParamString(int parameterId)
    Deprecated.
     
    Units
    getUnits()
    Deprecated.
    Gets the units.
    static String
    getUnitsStringForSystem(int paramId, int unitSystem)
    Deprecated.
    returns the english or si units string for the given parameter id.
    static String
    getUnitsStringForSystem(String param, int unitSystem)
    Deprecated.
    returns the english or si units string for the given parameter.
    static boolean
    isNotValid(String parameter)
    Deprecated.
    Checks if is not valid.
    static boolean
    isValid(String parameter)
    Deprecated.
    Checks if is valid.
    void
    setBaseParameter(String baseParameter)
    Deprecated.
     
    void
    setParameter(String parameter)
    Deprecated.
    Sets the parameter.
    void
    setParameter(String baseParameter, String subParameter)
    Deprecated.
    Sets the parameter.

    Methods inherited from class mil.army.usace.hec.metadata.Parameter

    baseParameterMatches, equals, generateParameterId, getBaseParameter, getDefaultUnits, getParameter, getParameterId, getSubParameter, getUnitsString, getUnitsStringForSystem, hashCode, hasSubParameter, setSubParameter, toString

    Methods inherited from class java.lang.Object

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

  • Field Details

    • UNDEF_PARAMETER_ID

      public static final int UNDEF_PARAMETER_ID
      Deprecated.
      The Constant UNDEF_PARAMETER_ID.
      See Also:

    • PARAMID_PERCENT

      public static final int PARAMID_PERCENT
      Deprecated.
      The Constant PARAMID_PERCENT.

    • PARAMID_AREA

      public static final int PARAMID_AREA
      Deprecated.
      The Constant PARAMID_AREA.

    • PARAMID_CONC

      public static final int PARAMID_CONC
      Deprecated.
      The Constant PARAMID_CONC.

    • PARAMID_COUNT

      public static final int PARAMID_COUNT
      Deprecated.
      The Constant PARAMID_COUNT.

    • PARAMID_CURENCY

      public static final int PARAMID_CURENCY
      Deprecated.
      The Constant PARAMID_CURENCY.

    • PARAMID_DEPTH

      public static final int PARAMID_DEPTH
      Deprecated.
      The Constant PARAMID_DEPTH.

    • PARAMID_ELEV

      public static final int PARAMID_ELEV
      Deprecated.
      The Constant PARAMID_ELEV.

    • PARAMID_EVAP

      public static final int PARAMID_EVAP
      Deprecated.
      The Constant PARAMID_EVAP.

    • PARAMID_EVAPRATE

      public static final int PARAMID_EVAPRATE
      Deprecated.
      The Constant PARAMID_EVAPRATE.

    • PARAMID_FLOW

      public static final int PARAMID_FLOW
      Deprecated.
      The Constant PARAMID_FLOW.

    • PARAMID_LENGTH

      public static final int PARAMID_LENGTH
      Deprecated.
      The Constant PARAMID_LENGTH.

    • PARAMID_OPENING

      public static final int PARAMID_OPENING
      Deprecated.
      The Constant PARAMID_OPENING.

    • PARAMID_PERCRATE

      public static final int PARAMID_PERCRATE
      Deprecated.
      The Constant PARAMID_PERCRATE.

    • PARAMID_PERC

      public static final int PARAMID_PERC
      Deprecated.
      The Constant PARAMID_PERC.

    • PARAMID_PRECIP

      public static final int PARAMID_PRECIP
      Deprecated.
      The Constant PARAMID_PRECIP.

    • PARAMID_STAGE

      public static final int PARAMID_STAGE
      Deprecated.
      The Constant PARAMID_STAGE.

    • PARAMID_STOR

      public static final int PARAMID_STOR
      Deprecated.
      The Constant PARAMID_STOR.

    • PARAMID_TEMP

      public static final int PARAMID_TEMP
      Deprecated.
      The Constant PARAMID_TEMP.

    • PARAMID_WIDTH

      public static final int PARAMID_WIDTH
      Deprecated.
      The Constant PARAMID_WIDTH.

    • PARAMID_LOSSDEFICIT

      public static final int PARAMID_LOSSDEFICIT
      Deprecated.
      The Constant PARAMID_LOSSDEFICIT.

    • PARAMID_LOSSRATE

      public static final int PARAMID_LOSSRATE
      Deprecated.
      The Constant PARAMID_LOSSRATE.

    • PARAMID_AREABASIN

      public static final int PARAMID_AREABASIN
      Deprecated.
      The Constant PARAMID_AREABASIN.

    • PARAMID_AREAIMPACTED

      public static final int PARAMID_AREAIMPACTED
      Deprecated.
      The Constant PARAMID_AREAIMPACTED.

    • PARAMID_AREARESERVOIR

      public static final int PARAMID_AREARESERVOIR
      Deprecated.
      The Constant PARAMID_AREARESERVOIR.

    • PARAMID_AREASURFACE

      public static final int PARAMID_AREASURFACE
      Deprecated.
      The Constant PARAMID_AREASURFACE.

    • PARAMID_POWER

      public static final int PARAMID_POWER
      Deprecated.
      The Constant PARAMID_POWER.

    • PARAMID_ENERGY

      public static final int PARAMID_ENERGY
      Deprecated.
      The Constant PARAMID_ENERGY.

    • PARAMID_TRAVEL

      public static final int PARAMID_TRAVEL
      Deprecated.
      The Constant PARAMID_TRAVEL.

    • PARAMID_SPINRATE

      public static final int PARAMID_SPINRATE
      Deprecated.
      The Constant PARAMID_SPINRATE.

    • PARAMID_SPEED

      public static final int PARAMID_SPEED
      Deprecated.

    • PARAMID_SALINITY

      public static final int PARAMID_SALINITY
      Deprecated.
      The Constant PARAMID_SALINITY.

    • PARAMID_FLOWPERAREA

      public static final int PARAMID_FLOWPERAREA
      Deprecated.
      The Constant PARAMID_FLOWPERAREA.

    • PARAMID_STORKAF

      public static final int PARAMID_STORKAF
      Deprecated.
      The Constant PARAMID_STORKAF.

    • PARAMID_FLOWKAF

      public static final int PARAMID_FLOWKAF
      Deprecated.
      The Constant PARAMID_FLOWKAF.

    • PARAMID_COSTKAF

      public static final int PARAMID_COSTKAF
      Deprecated.
      The Constant PARAMID_COSTKAF.

    • PARAMID_AREAKA

      public static final int PARAMID_AREAKA
      Deprecated.
      The Constant PARAMID_AREAKA.

    • PARAMID_MELTRATE

      public static final int PARAMID_MELTRATE
      Deprecated.
      The Constant PARAMID_MELTRATE.

    • PARAMID_PENALTY

      public static final int PARAMID_PENALTY
      Deprecated.
      The Constant PARAMID_PENALTY.

    • PARAMID_THICKNESS

      public static final int PARAMID_THICKNESS
      Deprecated.
      The Constant PARAMID_THICKNESS.

    • PARAMID_SEDIMENT_DISCHARGE

      public static final int PARAMID_SEDIMENT_DISCHARGE
      Deprecated.
      The Constant PARAMID_SEDIMENT_DISCHARGE.

    • PARAMID_SED_SIZE

      public static final int PARAMID_SED_SIZE
      Deprecated.
      The Constant PARAMID_SED_SIZE.

    • PARAMID_BOTTOM_LENGTH

      public static final int PARAMID_BOTTOM_LENGTH
      Deprecated.
      The Constant PARAMID_BOTTOM_LENGTH.

    • PARAMID_DEPOSITION

      public static final int PARAMID_DEPOSITION
      Deprecated.
      The Constant PARAMID_DEPOSITION.

    • PARAMID_VOLUME

      public static final int PARAMID_VOLUME
      Deprecated.
      The Constant PARAMID_VOLUME.

    • PARAMID_SED_LOAD

      public static final int PARAMID_SED_LOAD
      Deprecated.
      The Constant PARAMID_SED_LOAD.

    • PARAMID_DISTANCE

      public static final int PARAMID_DISTANCE
      Deprecated.
      The Constant PARAMID_DISTANCE.

    • PARAMID_RATE_OF_RISE

      public static final int PARAMID_RATE_OF_RISE
      Deprecated.
      The Constant PARAMID_RATE_OF_RISE.

    • PARAMID_GROWTH_RATE

      public static final int PARAMID_GROWTH_RATE
      Deprecated.
      The Constant PARAMID_GROWTH_RATE.

    • PARAMID_DENSITY

      public static final int PARAMID_DENSITY
      Deprecated.
      The Constant PARAMID_DENSITY.

    • PARAMID_EXTINCTION

      public static final int PARAMID_EXTINCTION
      Deprecated.
      The Constant PARAMID_EXTINCTION.

    • PARAMID_SHADE_FRAC

      public static final int PARAMID_SHADE_FRAC
      Deprecated.
      The Constant PARAMID_SHADE_FRAC.

    • PARAMID_SUSP_SOLIDS

      public static final int PARAMID_SUSP_SOLIDS
      Deprecated.
      The Constant PARAMID_SUSP_SOLIDS.

    • PARAMID_PRESSURE

      public static final int PARAMID_PRESSURE
      Deprecated.
      The Constant PARAMID_PRESSURE.

    • PARAMID_TIMING

      public static final int PARAMID_TIMING
      Deprecated.
      The Constant PARAMID_TIMING.

    • PARAMID_TIMING_OFFSET

      public static final int PARAMID_TIMING_OFFSET
      Deprecated.
      The Constant PARAMID_TIMING_OFFSET.

    • PARAMID_TIMING_PERIOD

      public static final int PARAMID_TIMING_PERIOD
      Deprecated.
      The Constant PARAMID_TIMING_PERIOD.

    • PARAMID_ATI

      public static final int PARAMID_ATI
      Deprecated.
      The Constant PARAMID_ATI.

    • PARAMID_COLDRATE

      public static final int PARAMID_COLDRATE
      Deprecated.
      The Constant PARAMID_COLDRATE.

  • Constructor Details

    • Parameter

      public Parameter()
      Deprecated.
      Instantiates a new parameter.

    • Parameter

      public Parameter(String parameter) throws DataSetIllegalArgumentException
      Deprecated.
      Instantiates a new parameter.
      Parameters:
      parameter - the parameter
      Throws:
      DataSetIllegalArgumentException - the data set illegal argument exception

    • Parameter

      public Parameter(String baseParameter, String subParameter) throws DataSetIllegalArgumentException
      Deprecated.
      Instantiates a new parameter.
      Parameters:
      baseParameter - the base parameter
      subParameter - the sub parameter
      Throws:
      DataSetIllegalArgumentException - the data set illegal argument exception

    • Parameter

      public Parameter(Parameter parameter)
      Deprecated.
      Instantiates a new parameter.
      Parameters:
      parameter - the parameter

    • Parameter

      public Parameter(mil.army.usace.hec.metadata.Parameter parameter)
      Deprecated.

  • Method Details

    • getParamString

      public static String getParamString(int parameterId)
      Deprecated.

    • getAvailableParameters

      public static String[] getAvailableParameters()
      Deprecated.

    • setParameter

      public void setParameter(String baseParameter, String subParameter) throws DataSetIllegalArgumentException
      Deprecated.
      Sets the parameter.
      Overrides:
      setParameter in class mil.army.usace.hec.metadata.Parameter
      Parameters:
      baseParameter - the base parameter
      subParameter - the sub parameter
      Throws:
      DataSetIllegalArgumentException - the data set illegal argument exception

    • setBaseParameter

      public void setBaseParameter(String baseParameter) throws DataSetIllegalArgumentException
      Deprecated.
      Overrides:
      setBaseParameter in class mil.army.usace.hec.metadata.Parameter
      Throws:
      DataSetIllegalArgumentException

    • setParameter

      public void setParameter(String parameter) throws DataSetIllegalArgumentException
      Deprecated.
      Sets the parameter.
      Overrides:
      setParameter in class mil.army.usace.hec.metadata.Parameter
      Parameters:
      parameter - the new parameter
      Throws:
      DataSetIllegalArgumentException - the data set illegal argument exception

    • getUnits

      public Units getUnits()
      Deprecated.
      Gets the units.
      Returns:
      the units

    • getParameterForUnitsString

      public static Parameter getParameterForUnitsString(String units)
      Deprecated.
      Gets the parameter for units string.
      Parameters:
      units - the units
      Returns:
      the parameter for units string

    • getParameter

      public static Parameter getParameter(int paramID) throws DataSetIllegalArgumentException
      Deprecated.
      Gets the Parameter for the given ParamID.
      Parameters:
      paramID - the param id
      Returns:
      the Parameter
      Throws:
      DataSetIllegalArgumentException - the data set illegal argument exception

    • getUnitsStringForSystem

      public static String getUnitsStringForSystem(int paramId, int unitSystem)
      Deprecated.
      returns the english or si units string for the given parameter id.
      Parameters:
      paramId - the param id
      unitSystem - the unit system
      Returns:
      the units string for system

    • getUnitsStringForSystem

      public static String getUnitsStringForSystem(String param, int unitSystem)
      Deprecated.
      returns the english or si units string for the given parameter.
      Parameters:
      param - the parameter
      unitSystem - the unit system
      Returns:
      the units string for system

    • isValid

      public static boolean isValid(String parameter)
      Deprecated.
      Checks if is valid.
      Parameters:
      parameter - the parameter
      Returns:
      true, if is valid

    • isNotValid

      public static boolean isNotValid(String parameter)
      Deprecated.
      Checks if is not valid.
      Parameters:
      parameter - the parameter
      Returns:
      true, if is not valid

    • equals

      @Deprecated public boolean equals(Parameter parameter)
      Deprecated.
      Use the object equals instead cause it is more accurate.
      This only tests the base parameter and is a type specific equals for only comparing Parameter base parameter values.
      Parameters:
      parameter - the parameter
      Returns:
      true, if successful