Package hec.data.tx

Class DescriptionTx

java.lang.Object

hec.data.AbstractDataSet

hec.data.tx.AbstractDataSetT

hec.data.tx.DescriptionTx

All Implemented Interfaces:

ITimeSeriesDescription, Serializable

@Deprecated
public class DescriptionTx
extends AbstractDataSetT
implements Serializable, ITimeSeriesDescription

Deprecated.

A DescriptionTx defines a time series data set. It is composed of: a Location, a Parameter, a ParameterType, an Interval, a Duration, and a Version.

A Description is a required part of each DataSetTx and DataSetTxTemplate.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DescriptionTx.DescriptionTxComparator	Deprecated.
static enum	DescriptionTx.Parts	Deprecated.

Field Summary

Fields inherited from class hec.data.tx.AbstractDataSetT

utcTz

Fields inherited from class hec.data.AbstractDataSet

subFieldDelimiter

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	DescriptionTx()	Deprecated.
	DescriptionTx(LocationID location, Parameter parameter, ParameterType parameterType, Interval interval, Duration duration, Version version)	Deprecated. Constructs a DescriptionTx from the arguments.
	DescriptionTx(DescriptionTx descriptionTx)	Deprecated. Constructs a copy of the argument DescriptionTx.
	DescriptionTx(String delimString)	Deprecated. Constructs a DescriptionTx from a period delimited String.
	DescriptionTx(String officeId, LocationID location, Parameter parameter, ParameterType parameterType, Interval interval, Duration duration, Version version)	Deprecated.
	DescriptionTx(String officeId, String delimString)	Deprecated.
	DescriptionTx(mil.army.usace.hec.metadata.timeseries.TimeSeriesIdentifier timeSeriesIdentifier)	Deprecated.

Method Summary

Modifier and Type	Method	Description
void	checkUtcIntervalOffset(long time)	Deprecated.
ITimeSeriesDescription	copy()	Deprecated.
boolean	describesSameDataAs(DescriptionTx descriptionTx)	Deprecated. Assures the two descriptions apply equally to a data set, even if the descriptions differ by location or labelling.
boolean	equals(Object obj)	Deprecated. Evalutes if other description is equal(identical)
void	fillTimeSeriesContainer(TimeSeriesContainer tsc)	Deprecated.
boolean	getActive()	Deprecated.
Duration	getDuration()	Deprecated.
Interval	getInterval()	Deprecated.
String	getIntervalName()	Deprecated.
TimeZone	getLocalRegularTimeZone()	Deprecated.
String	getLocalRegularTimeZoneString()	Deprecated.
LocationID	getLocationID()	Deprecated.
LocationTemplate	getLocationRef()	Deprecated.
rma.util.lookup.Lookup	getLookup()	Deprecated. Returns a lookup of capabilites that can be done on this object
int	getMinutes()	Deprecated.
String	getOfficeId()	Deprecated.
Parameter	getParameter()	Deprecated.
String	getParameterId()	Deprecated.
ParameterType	getParameterType()	Deprecated.
String	getTimeSeriesId()	Deprecated.
mil.army.usace.hec.metadata.timeseries.TimeSeriesIdentifier	getTimeSeriesIdentifierMetaData()	Deprecated.
int	getUserPrivilege()	Deprecated.
int	getUtcIntervalOffset()	Deprecated. Returns the UTC interval offset.
int	getUtcIntervalOffsetInMinutes()	Deprecated. Returns the UTC interval offset.
IntervalOffset	getUtcIntervalOffsetObject()	Deprecated.
String	getUtcIntervalOffsetString()	Deprecated.
Version	getVersion()	Deprecated.
int	hashCode()	Deprecated.
boolean	isRegular()	Deprecated.
static Map<DescriptionTx.Parts,String>	parse(String descriptionStr)	Deprecated.
protected void	set(LocationID location, Parameter parameter, ParameterType parameterType, Interval interval, Duration duration, Version version)	Deprecated.
protected void	set(String loc, String param, String type, String interv, String durat, String ver)	Deprecated.
void	setActive(boolean active)	Deprecated.
void	setIntervalName(String intervalName)	Deprecated.
void	setLocalRegularTimeZone(String strLocalRegularTimeZone)	Deprecated.
void	setLocationRef(LocationTemplate template)	Deprecated.
void	setOfficeId(String officeId)	Deprecated.
void	setUserPrivilege(int userPrivilege)	Deprecated.
void	setUtcIntervalOffset(int offset)	Deprecated. Sets the UTC interval offset.
void	setUtcIntervalOffset(String offsetString)	Deprecated.
void	setVersion(Version version)	Deprecated.
String	toString()	Deprecated.

Methods inherited from class hec.data.AbstractDataSet

sdfFULL

Methods inherited from class java.lang.Object

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

Constructor Details

DescriptionTx

public DescriptionTx(String delimString)
              throws DataSetIllegalArgumentException

Deprecated.

Constructs a DescriptionTx from a period delimited String. The String follows this format "location.param.type.interval.duration.version"

Throws:

DataSetIllegalArgumentException

DescriptionTx

public DescriptionTx(String officeId,
 String delimString)
              throws DataSetIllegalArgumentException

Deprecated.

Throws:

DataSetIllegalArgumentException

DescriptionTx

public DescriptionTx(LocationID location,
 Parameter parameter,
 ParameterType parameterType,
 Interval interval,
 Duration duration,
 Version version)
              throws DataSetIllegalArgumentException

Deprecated.

Constructs a DescriptionTx from the arguments.

Throws:

DataSetIllegalArgumentException

DescriptionTx

public DescriptionTx(String officeId,
 LocationID location,
 Parameter parameter,
 ParameterType parameterType,
 Interval interval,
 Duration duration,
 Version version)
              throws DataSetIllegalArgumentException

Deprecated.

Throws:

DataSetIllegalArgumentException

DescriptionTx

protected DescriptionTx()

Deprecated.

DescriptionTx

public DescriptionTx(mil.army.usace.hec.metadata.timeseries.TimeSeriesIdentifier timeSeriesIdentifier)

Deprecated.

DescriptionTx

public DescriptionTx(DescriptionTx descriptionTx)

Deprecated.

Constructs a copy of the argument DescriptionTx.

Method Details

fillTimeSeriesContainer

public void fillTimeSeriesContainer(TimeSeriesContainer tsc)

Deprecated.

getTimeSeriesIdentifierMetaData

public mil.army.usace.hec.metadata.timeseries.TimeSeriesIdentifier getTimeSeriesIdentifierMetaData()

Deprecated.

getLookup

public rma.util.lookup.Lookup getLookup()

Deprecated.

Returns a lookup of capabilites that can be done on this object

Specified by:

getLookup in interface ITimeSeriesDescription

set

protected void set(LocationID location,
 Parameter parameter,
 ParameterType parameterType,
 Interval interval,
 Duration duration,
 Version version)
            throws DataSetIllegalArgumentException

Deprecated.

Throws:

DataSetIllegalArgumentException

set

protected void set(String loc,
 String param,
 String type,
 String interv,
 String durat,
 String ver)
            throws DataSetIllegalArgumentException

Deprecated.

Throws:

DataSetIllegalArgumentException

parse

public static Map<DescriptionTx.Parts,String> parse(String descriptionStr)
                                             throws DataSetIllegalArgumentException

Deprecated.

Throws:

DataSetIllegalArgumentException

setIntervalName

public void setIntervalName(String intervalName)
                     throws DataSetIllegalArgumentException

Deprecated.

Throws:

DataSetIllegalArgumentException

equals

public boolean equals(Object obj)

Deprecated.

Evalutes if other description is equal(identical)

Overrides:

equals in class Object

Parameters:

obj -

Returns:

hashCode

public int hashCode()

Deprecated.

Overrides:

hashCode in class Object

describesSameDataAs

public boolean describesSameDataAs(DescriptionTx descriptionTx)

Deprecated.

Assures the two descriptions apply equally to a data set, even if the descriptions differ by location or labelling.

getOfficeId

public String getOfficeId()

Deprecated.

Specified by:

getOfficeId in interface ITimeSeriesDescription

setOfficeId

public void setOfficeId(String officeId)

Deprecated.

setUserPrivilege

public void setUserPrivilege(int userPrivilege)

Deprecated.

setActive

public void setActive(boolean active)

Deprecated.

setUtcIntervalOffset

public void setUtcIntervalOffset(String offsetString)
                          throws DataSetIllegalArgumentException

Deprecated.

Throws:

DataSetIllegalArgumentException

setUtcIntervalOffset

public void setUtcIntervalOffset(int offset)
                          throws DataSetIllegalArgumentException

Deprecated.

Sets the UTC interval offset. Must be a value less than the Interval. Units for the interval offset are in seconds.

Parameters:

offset - The new interval offset in seconds

Throws:

DataSetIllegalArgumentException

getUtcIntervalOffset

public int getUtcIntervalOffset()

Deprecated.

Returns the UTC interval offset.

Returns:

Interval offset in seconds

getUtcIntervalOffsetInMinutes

public int getUtcIntervalOffsetInMinutes()

Deprecated.

Returns the UTC interval offset.

Returns:

Interval offset in minutes

getUtcIntervalOffsetString

public String getUtcIntervalOffsetString()

Deprecated.

checkUtcIntervalOffset

public void checkUtcIntervalOffset(long time)
                            throws UtcIntervalOffsetMismatchException

Deprecated.

Throws:

UtcIntervalOffsetMismatchException

getLocationRef

public LocationTemplate getLocationRef()

Deprecated.

Specified by:

getLocationRef in interface ITimeSeriesDescription

setLocationRef

public void setLocationRef(LocationTemplate template)

Deprecated.

Specified by:

setLocationRef in interface ITimeSeriesDescription

getLocationID

public LocationID getLocationID()

Deprecated.

getParameter

public Parameter getParameter()

Deprecated.

getDuration

public Duration getDuration()

Deprecated.

Specified by:

getDuration in interface ITimeSeriesDescription

getInterval

public Interval getInterval()

Deprecated.

Specified by:

getInterval in interface ITimeSeriesDescription

getIntervalName

public String getIntervalName()

Deprecated.

getVersion

public Version getVersion()

Deprecated.

Specified by:

getVersion in interface ITimeSeriesDescription

setVersion

public void setVersion(Version version)

Deprecated.

getParameterType

public ParameterType getParameterType()

Deprecated.

Specified by:

getParameterType in interface ITimeSeriesDescription

getMinutes

public int getMinutes()

Deprecated.

isRegular

public boolean isRegular()

Deprecated.

Specified by:

isRegular in interface ITimeSeriesDescription

toString

public String toString()

Deprecated.

Overrides:

toString in class Object

setLocalRegularTimeZone

public void setLocalRegularTimeZone(String strLocalRegularTimeZone)
                             throws IllegalLocalRegularTimeZoneException

Deprecated.

Throws:

IllegalLocalRegularTimeZoneException

getLocalRegularTimeZone

public TimeZone getLocalRegularTimeZone()

Deprecated.

getLocalRegularTimeZoneString

public String getLocalRegularTimeZoneString()

Deprecated.

getActive

public boolean getActive()

Deprecated.

Specified by:

getActive in interface ITimeSeriesDescription

getUserPrivilege

public int getUserPrivilege()

Deprecated.

Specified by:

getUserPrivilege in interface ITimeSeriesDescription

getParameterId

public String getParameterId()

Deprecated.

Specified by:

getParameterId in interface ITimeSeriesDescription

getUtcIntervalOffsetObject

public IntervalOffset getUtcIntervalOffsetObject()

Deprecated.

Specified by:

getUtcIntervalOffsetObject in interface ITimeSeriesDescription

getTimeSeriesId

public String getTimeSeriesId()

Deprecated.

Specified by:

getTimeSeriesId in interface ITimeSeriesDescription

copy

public ITimeSeriesDescription copy()

Deprecated.

Specified by:

copy in interface ITimeSeriesDescription