org.opensha.sha.param
Class MagDistStringParameter

java.lang.Object
  org.opensha.commons.param.AbstractParameter<String>
      org.opensha.commons.param.impl.StringParameter
          org.opensha.sha.param.MagDistStringParameter

All Implemented Interfaces:

Serializable, Comparable<Parameter<?>>, Named, XMLSaveable, Parameter<String>

public class MagDistStringParameter
extends StringParameter

Author:

nitingupta

See Also:

Serialized Form

Field Summary

protected static String	C Class name for debugging.
protected static boolean	D If true print out debug statements.

Fields inherited from class org.opensha.commons.param.AbstractParameter

constraint, defaultValue, editable, independentParameters, info, metadataString, name, units, value, XML_COMPLEX_VAL_EL_NAME, XML_GROUP_METADATA_NAME, XML_METADATA_NAME, XML_NULL_VALUE

Fields inherited from interface org.opensha.commons.param.Parameter

XML_INDEPENDENT_PARAMS_NAME

Constructor Summary

MagDistStringParameter(String name, ArrayList strings)

MagDistStringParameter(String name, ArrayList strings, String value)

MagDistStringParameter(String name, StringConstraint constraint)

MagDistStringParameter(String name, StringConstraint constraint, String value)

MagDistStringParameter(String name, StringConstraint constraint, String units, String value)

Method Summary

Object	clone() Returns a copy so you can't edit or damage the origial.
int	compareTo(Parameter<?> param) Compares the values to if this is less than, equal to, or greater than the comparing objects.
boolean	equals(Object obj) Compares the passed in MagDistStringParameter to see if it has the same name and value.
ArrayList	getAllowedStrings() Returns a clone of the allowed strings of the constraint.
ParameterEditor<String>	getEditor() Returns the Editor for this Parameter.
String	getType() Gets the type attribute of the MagDistStringParameter object.
void	setConstraint(ParameterConstraint constraint) Sets the constraint reference if it is a StringConstraint and the parameter is currently editable, else throws an exception.

Methods inherited from class org.opensha.commons.param.impl.StringParameter

setIndividualParamValueFromXML

Methods inherited from class org.opensha.commons.param.AbstractParameter

addIndependentParameter, addParameterChangeFailListener, addParameterChangeListener, checkEditable, containsIndependentParameter, firePropertyChange, firePropertyChangeFailed, getConstraint, getConstraintName, getDefaultValue, getDependentParamMetadataString, getIndependentParameter, getIndependentParameterList, getIndependentParametersIterator, getIndependentParametersKey, getInfo, getMetadataString, getName, getNumIndependentParameters, getUnits, getValue, isAllowed, isEditable, isNullAllowed, removeIndependentParameter, removeParameterChangeFailListener, removeParameterChangeListener, setDefaultValue, setDependentParamMetadataString, setIndependentParameters, setIndepParamsFromXML, setInfo, setName, setNonEditable, setUnits, setValue, setValueAsDefault, setValueFromXMLMetadata, toXMLMetadata, toXMLMetadata, unableToSetValue, valueToXML

Methods inherited from class java.lang.Object

finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

C

protected static final String C

Class name for debugging.

See Also:

Constant Field Values

D

protected static final boolean D

If true print out debug statements.

See Also:

Constant Field Values

Constructor Detail

MagDistStringParameter

public MagDistStringParameter(String name,
                              ArrayList strings)
                       throws ConstraintException

Parameters:

name -

strings -

Throws:

ConstraintException

MagDistStringParameter

public MagDistStringParameter(String name,
                              StringConstraint constraint)
                       throws ConstraintException

Parameters:

name -

constraint -

Throws:

ConstraintException

MagDistStringParameter

public MagDistStringParameter(String name,
                              ArrayList strings,
                              String value)
                       throws ConstraintException

Parameters:

name -

strings -

value -

Throws:

ConstraintException

MagDistStringParameter

public MagDistStringParameter(String name,
                              StringConstraint constraint,
                              String value)
                       throws ConstraintException

Parameters:

name -

constraint -

value -

Throws:

ConstraintException

MagDistStringParameter

public MagDistStringParameter(String name,
                              StringConstraint constraint,
                              String units,
                              String value)
                       throws ConstraintException

Parameters:

name -

constraint -

units -

value -

Throws:

ConstraintException

Method Detail

setConstraint

public void setConstraint(ParameterConstraint constraint)
                   throws ParameterException,
                          EditableException

Sets the constraint reference if it is a StringConstraint and the parameter is currently editable, else throws an exception.

Specified by:

setConstraint in interface Parameter<String>

Overrides:

setConstraint in class StringParameter

Parameters:

constraint - to set

Throws:

ParameterException

EditableException

getType

public String getType()

Gets the type attribute of the MagDistStringParameter object. This is used to determine which type of GUI editor applies to this parameter.

Specified by:

getType in interface Parameter<String>

Overrides:

getType in class StringParameter

Returns:

The GUI editor type

getAllowedStrings

public ArrayList getAllowedStrings()

Returns a clone of the allowed strings of the constraint. Useful for presenting in a picklist

Overrides:

getAllowedStrings in class StringParameter

Returns:

The allowedStrings vector

compareTo

public int compareTo(Parameter<?> param)

Compares the values to if this is less than, equal to, or greater than the comparing objects. Implementation of comparable interface. Helps with sorting a list of parameters.

Specified by:

compareTo in interface Comparable<Parameter<?>>

Overrides:

compareTo in class AbstractParameter<String>

Parameters:

obj - The object to compare this to

Returns:

-1 if this value < obj value, 0 if equal, +1 if this value > obj value

Throws:

ClassCastException - Is thrown if the comparing object is not a MagDistStringParameter *

See Also:

Comparable

equals

public boolean equals(Object obj)

Compares the passed in MagDistStringParameter to see if it has the same name and value. If the object is not a MagDistStringParameter an exception is thrown. If the values and names are equal true is returned, otherwise false is returned.

Specified by:

equals in interface Parameter<String>

Overrides:

equals in class AbstractParameter<String>

Parameters:

obj - The object to compare this to

Returns:

True if the values are identical

Throws:

ClassCastException - Is thrown if the comparing object is not a MagDistStringParameter

clone

public Object clone()

Returns a copy so you can't edit or damage the origial. Clones this object's value and all fields. The constraints are also cloned.

Specified by:

clone in interface Parameter<String>

Overrides:

clone in class StringParameter

Returns:

Description of the Return Value

getEditor

public ParameterEditor<String> getEditor()

Description copied from interface: Parameter

Returns the Editor for this Parameter. It is recommended that editors be lazily instantiated.

Specified by:

getEditor in interface Parameter<String>

Overrides:

getEditor in class StringParameter

Returns:

the Editor