Package pulse.properties

Class NumericProperty

java.lang.Object

pulse.properties.NumericProperty

All Implemented Interfaces:

Serializable, Comparable<NumericProperty>, Property

Direct Known Subclasses:

Identifier

public class NumericProperty
extends Object
implements Property, Comparable<NumericProperty>

A Property that has a numeric value, an error associated with this value, a definition domain defining sensible value, and a dimensionFactor used to convert the value to SI.

The description, abbreviation, and all default values for a specific NumericProperty are associated with the specific type set out by the NuemricPropertyKeyword. The latter is used to link with a repository of default NumericProperties loaded from an .xml file.

See Also:

NumericPropertyKeyword, XMLConverter, Serialized Form

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	NumericProperty(Number value, NumericProperty pattern)	Creates a NumericProperty based on {
	NumericProperty(NumericProperty num)	A copy constructor for NumericProperty
	NumericProperty(NumericPropertyKeyword type, Number... params)	Constructor used by XMLConverter to create a NumericProperty with fully specified set of parameters

Method Summary

Modifier and Type	Method	Description
boolean	attemptUpdate(Object value)
int	compareTo(NumericProperty arg0)
boolean	equals(Object o)	The Object o is considered to be equal to this NumericProperty if (a) it is of the same class; (b) its value is the same as for this NumericProperty, and (c) if it is specified by the same NumericPropertyKeyword.
Number	errorInCurrentUnits()
String	formattedOutput()	Uses a NumericPropertyFormatter to generate a formatted output
String	getAbbreviation(boolean addHtmlTags)
Segment	getBounds()	Represents the bounds specified for this numeric property as a Segment object.
String	getDescriptor(boolean addHtmlTag)	Creates a String to describe this property (often used in GUI applications).
Number	getDimensionDelta()
Number	getDimensionFactor()
Number	getError()
NumericPropertyKeyword[]	getExcludeKeywords()
Number	getMaximum()
Number	getMinimum()
NumericPropertyKeyword	getType()
Object	getValue()	Retrieves the value of this Property.
boolean	isDefaultSearchVariable()
boolean	isDiscrete()
boolean	isOptimisable()
boolean	isVisibleByDefault()
static void	requireType(NumericProperty property, NumericPropertyKeyword type)
void	setAbbreviation(String abbreviation)
void	setDefaultSearchVariable(boolean defaultSearchVariable)
void	setDescriptor(String descriptor)
void	setDimensionFactor(Number dimensionFactor)
void	setDiscrete(boolean discrete)
void	setDomain(Number minimum, Number maximum)	Sets the definition domain for this NumericProperty.
void	setError(Number error)
void	setExcludeKeywords(NumericPropertyKeyword[] keys)
void	setOptimisable(boolean optimisable)
void	setValue(Number value)	Sets the value of this NumericProperty -- if and only if the new value is confined within the definition domain for this NumericProperty.
void	setVisibleByDefault(boolean autoAdjustable)
String	toString()	Prints out the type and value of this NumericProperty.
boolean	validate()
Number	valueInCurrentUnits()

Methods inherited from class java.lang.Object

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

Methods inherited from interface pulse.properties.Property

identifier

Constructor Detail

NumericProperty

protected NumericProperty(Number value,
                          NumericProperty pattern)

Creates a NumericProperty based on {

Parameters:

value - the for the {

pattern - a valid NumericProperty

NumericProperty

public NumericProperty(NumericPropertyKeyword type,
                       Number... params)

Constructor used by XMLConverter to create a NumericProperty with fully specified set of parameters

Parameters:

type - the type of this NumericProperty, set by one of the NumericPropertyKeyword constants

params - the numeric parameters in the following order: value, minimum, maximum, dimension factor.

See Also:

XMLConverter

NumericProperty

public NumericProperty(NumericProperty num)

A copy constructor for NumericProperty

Parameters:

num - another NumericProperty that is going to be replicated

Method Detail

getExcludeKeywords

public NumericPropertyKeyword[] getExcludeKeywords()

setExcludeKeywords

public void setExcludeKeywords(NumericPropertyKeyword[] keys)

getType

public NumericPropertyKeyword getType()

getValue

public Object getValue()

Description copied from interface: Property

Retrieves the value of this Property.

Specified by:

getValue in interface Property

Returns:

an object representing the value of this Property

validate

public boolean validate()

setValue

public void setValue(Number value)

Sets the value of this NumericProperty -- if and only if the new value is confined within the definition domain for this NumericProperty. Checks whether

Parameters:

value - the value to be set to this property

setDomain

public void setDomain(Number minimum,
                      Number maximum)
               throws IllegalArgumentException

Sets the definition domain for this NumericProperty.

Parameters:

minimum - the minimum value

maximum - the maximum value

Throws:

IllegalArgumentException - if any two of minimum, maximum, or this.value have different primitive types (e.g. a double and an int).

getMinimum

public Number getMinimum()

getMaximum

public Number getMaximum()

toString

public String toString()

Prints out the type and value of this NumericProperty.

Overrides:

toString in class Object

valueInCurrentUnits

public Number valueInCurrentUnits()

errorInCurrentUnits

public Number errorInCurrentUnits()

getDimensionFactor

public Number getDimensionFactor()

setDimensionFactor

public void setDimensionFactor(Number dimensionFactor)

setVisibleByDefault

public void setVisibleByDefault(boolean autoAdjustable)

isVisibleByDefault

public boolean isVisibleByDefault()

getError

public Number getError()

setError

public void setError(Number error)

getDescriptor

public String getDescriptor(boolean addHtmlTag)

Description copied from interface: Property

Creates a String to describe this property (often used in GUI applications).

Specified by:

getDescriptor in interface Property

Parameters:

addHtmlTag - if true, adds the 'html' tags at both ends of the descriptor String.

Returns:

a String, with or without 'html' tags, describing this Property

setDescriptor

public void setDescriptor(String descriptor)

getAbbreviation

public String getAbbreviation(boolean addHtmlTags)

setAbbreviation

public void setAbbreviation(String abbreviation)

equals

public boolean equals(Object o)

The Object o is considered to be equal to this NumericProperty if (a) it is of the same class; (b) its value is the same as for this NumericProperty, and (c) if it is specified by the same NumericPropertyKeyword.

Overrides:

equals in class Object

compareTo

public int compareTo(NumericProperty arg0)

Specified by:

compareTo in interface Comparable<NumericProperty>

isDiscrete

public boolean isDiscrete()

setDiscrete

public void setDiscrete(boolean discrete)

attemptUpdate

public boolean attemptUpdate(Object value)

Specified by:

attemptUpdate in interface Property

requireType

public static void requireType(NumericProperty property,
                               NumericPropertyKeyword type)

isDefaultSearchVariable

public boolean isDefaultSearchVariable()

isOptimisable

public boolean isOptimisable()

setDefaultSearchVariable

public void setDefaultSearchVariable(boolean defaultSearchVariable)

setOptimisable

public void setOptimisable(boolean optimisable)

getDimensionDelta

public Number getDimensionDelta()

getBounds

public Segment getBounds()

Represents the bounds specified for this numeric property as a Segment object. The bound numbers are taken by their double values and assigned to the segment.

Returns:

the bounds in which this property is allowed to change

formattedOutput

public String formattedOutput()

Uses a NumericPropertyFormatter to generate a formatted output

Specified by:

formattedOutput in interface Property

Returns:

a formatted string output with the value (and error -- if available) of this numeric property