Package hec.data.rating

Class JDomRatingSpecification

java.lang.Object

hec.data.rating.JDomRatingSpecification

All Implemented Interfaces:

ILocationRef, IRatingSpecification, Comparable<IRatingSpecification>

public class JDomRatingSpecification
extends Object
implements IRatingSpecification, Comparable<IRatingSpecification>

Describes a rating specification. Has a location, rating template, and a specification version. TULA.Stage;Flow.USGS-shifted.Production ARCA.Count-Conduit_Gates ,Opening-Conduit_Gates,Elev-Pool;Flow-Conduit_Gates.Normal.Production Location.Template.SpecVersion Eventually this object will be able to read and write itself using the XML formats.

Field Summary

Fields

Modifier and Type	Field	Description
final Pattern	parsingPattern	pattern for parsing the specification.
final String	parsingRegexp	regexp for parsing the specification.
final Pattern	validationPattern	pattern for validating the specification.
final String	validationRegexp	regexp for validating the specification.

Fields inherited from interface hec.data.rating.IRatingSpecification

PART_DELIM

Constructor Summary

Constructors

Constructor	Description
JDomRatingSpecification()	Default constructor.
JDomRatingSpecification(LocationTemplate locationRef, IRatingTemplate template, Version specVersion)	Parameterized constructor that has the args required to be valid.
JDomRatingSpecification(IRatingSpecification ratingSpecification)	Copy constructor that creates a copy of the arg rating specification.
JDomRatingSpecification(String officeId, String specificationId)	String parsing constructor to create a populating rating specification.

Method Summary

Modifier and Type	Method	Description
int	compareTo(IRatingSpecification o)	Performs a comparison of this spec to the arg spec and returns a number that can be used for ordering.
boolean	equals(Object obj)	Returns if this spec is equal to the arg object.
LocationTemplate	getLocationRef()	Returns the location of this spec.
Version	getSpecVersion()	Returns the version of this spec.
IRatingTemplate	getTemplate()	Returns the template for this spec.
int	hashCode()	Returns a hashcode for this spec.
boolean	isSimple()	Returns if this spec can be used in a reverse rating.
void	setLocationRef(LocationTemplate locRef)	Sets the location of this spec.
void	setSpecVersion(Version specVersion)	Sets the version of this spec.
void	setTemplate(IRatingTemplate template)	Sets the template for this spec.
String	toString()	Returns the string representation of this spec.

Methods inherited from class java.lang.Object

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

Field Details

parsingRegexp

public final String parsingRegexp

regexp for parsing the specification.

See Also:

• Constant Field Values

validationRegexp

public final String validationRegexp

regexp for validating the specification.

See Also:

• Constant Field Values

validationPattern

public final Pattern validationPattern

pattern for validating the specification.

parsingPattern

public final Pattern parsingPattern

pattern for parsing the specification.

Constructor Details

JDomRatingSpecification

public JDomRatingSpecification()

Default constructor. Fill in the object with the setters to become valid.

JDomRatingSpecification

public JDomRatingSpecification(String officeId,
 String specificationId)
                        throws DataSetException

String parsing constructor to create a populating rating specification.

Parameters:

officeId -

specificationId -

Throws:

DataSetException

JDomRatingSpecification

public JDomRatingSpecification(LocationTemplate locationRef,
 IRatingTemplate template,
 Version specVersion)

Parameterized constructor that has the args required to be valid.

Parameters:

locationRef -

template -

specVersion -

JDomRatingSpecification

public JDomRatingSpecification(IRatingSpecification ratingSpecification)

Copy constructor that creates a copy of the arg rating specification.

Parameters:

ratingSpecification -

Method Details

compareTo

public int compareTo(IRatingSpecification o)

Performs a comparison of this spec to the arg spec and returns a number that can be used for ordering.

Specified by:

compareTo in interface Comparable<IRatingSpecification>

getLocationRef

public LocationTemplate getLocationRef()

Returns the location of this spec.

Specified by:

getLocationRef in interface ILocationRef

Returns:

setLocationRef

public void setLocationRef(LocationTemplate locRef)

Sets the location of this spec.

Specified by:

setLocationRef in interface ILocationRef

getSpecVersion

public Version getSpecVersion()

Returns the version of this spec.

Specified by:

getSpecVersion in interface IRatingSpecification

Returns:

setSpecVersion

public void setSpecVersion(Version specVersion)

Sets the version of this spec.

Specified by:

setSpecVersion in interface IRatingSpecification

getTemplate

public IRatingTemplate getTemplate()

Returns the template for this spec.

Specified by:

getTemplate in interface IRatingSpecification

Returns:

setTemplate

public void setTemplate(IRatingTemplate template)

Sets the template for this spec.

Specified by:

setTemplate in interface IRatingSpecification

hashCode

public int hashCode()

Returns a hashcode for this spec.

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Returns if this spec is equal to the arg object.

Overrides:

equals in class Object

toString

public String toString()

Returns the string representation of this spec. TULA.Stage;Flow.USGS-shifted.Production ARCA.Count-Conduit_Gates,Opening-Conduit_Gates ,Elev-Pool;Flow-Conduit_Gates.Normal.Production

Overrides:

toString in class Object

Returns:

isSimple

public boolean isSimple()

Returns if this spec can be used in a reverse rating.

Specified by:

isSimple in interface IRatingSpecification

Returns: