org.jdesktop.swing.data
Class NumberMetaData

java.lang.Object
  org.jdesktop.swing.data.MetaData
      org.jdesktop.swing.data.NumberMetaData

public class NumberMetaData

extends MetaData

Class for representing meta-data for a numerical data field which is one of the following types:

• java.lang.Integer
• java.lang.Long
• java.lang.Short
• java.lang.Float
• java.lang.Double

This meta-data class defines additional properties and edit constraints which are applicable to numerical values, such as minimum, maximum, whether or not the value is a currency, etc. Example usage:

     NumberMetaData metaData = new NumberMetaData("interestrate",
                                                  Float.class, "Interest Rate");
     metaData.setMinimum(new Float(4.5));
     metaData.setMaximum(new Float(6.8));
 

Setting a minimum and/or maximum constraint will implicitly cause a range validator to be added to the meta-data object.

Field Summary

protected boolean	currency
protected Number	maximum
protected Number	minimum

Fields inherited from class org.jdesktop.swing.data.MetaData

converter, decodeFormat, encodeFormat, klass, label, maxValueCount, minValueCount, name, pcs, readOnly, validators

Constructor Summary

NumberMetaData()
Instantiates a meta-data object with a default name "numbervalue" and a default field class equal to java.lang.Integer.

NumberMetaData(String name)
Instantiates a meta-data object with the specified name and a default field class equal to java.lang.Integer.

NumberMetaData(String name, Class klass)
Instantiates a meta-data object with the specified name and field class.

NumberMetaData(String name, Class klass, String label)
Instantiates a meta-data object with the specified name, field class, and label.

Method Summary

Number	getMaximum() Gets the meta-data "maximum" property which indicates the maximum value of the associated data field.
Number	getMinimum() Gets the meta-data "minimum" property which indicates the minimum value of the associated data field.
boolean	isCurrency() Gets the meta-data "currency" property which indicates whether this data field represents a currency value.
void	setCurrency(boolean currency) Sets the meta-data "currency" property.
void	setMaximum(Number maximum) Sets the meta-data "maximum" property.
void	setMinimum(Number minimum) Sets the meta-data "minimum" property.

Methods inherited from class org.jdesktop.swing.data.MetaData

addPropertyChangeListener, addValidator, getConverter, getDecodeFormat, getElementClass, getEncodeFormat, getLabel, getMaxValueCount, getMinValueCount, getName, getPropertyChangeListeners, getValidators, isReadOnly, isRequired, removePropertyChangeListener, removeValidator, setConverter, setDecodeFormat, setElementClass, setEncodeFormat, setLabel, setMaxValueCount, setMinValueCount, setName, setReadOnly, setRequired

Methods inherited from class java.lang.Object

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

Field Detail

minimum

protected Number minimum

maximum

protected Number maximum

currency

protected boolean currency

Constructor Detail

NumberMetaData

public NumberMetaData()

Instantiates a meta-data object with a default name "numbervalue" and a default field class equal to java.lang.Integer. This provides the no-argument constructor required for JavaBeans. It is recommended that the program explicitly set a meaningful "name" property.

NumberMetaData

public NumberMetaData(String name)

Instantiates a meta-data object with the specified name and a default field class equal to java.lang.Integer.

Parameters:

name - String containing the name of the data field

NumberMetaData

public NumberMetaData(String name,
                      Class klass)

Instantiates a meta-data object with the specified name and field class.

Parameters:

name - String containing the name of the data field

klass - Class indicating type of data field

NumberMetaData

public NumberMetaData(String name,
                      Class klass,
                      String label)

Instantiates a meta-data object with the specified name, field class, and label.

Parameters:

name - String containing the name of the data field

klass - Class indicating type of data field

label - String containing the user-displayable label for the data field

Method Detail

getMinimum

public Number getMinimum()

Gets the meta-data "minimum" property which indicates the minimum value of the associated data field. The default is null, which indicates no minimum.

Returns:

Number containing the minimum value of the data field.

See Also:

setMinimum(java.lang.Number)

setMinimum

public void setMinimum(Number minimum)

Sets the meta-data "minimum" property. Setting a minimum and/or maximum will cause an appropriate range validator object to be added to this meta-data object.

Parameters:

minimum - Number containing the minimum value of the data field.

Throws:

IllegalArgumentException - if the minimum object's class does not equal the meta-data's field class

See Also:

getMinimum()

getMaximum

public Number getMaximum()

Gets the meta-data "maximum" property which indicates the maximum value of the associated data field. The default is null, which indicates no maximum.

Returns:

Number containing the maximum value of the data field.

See Also:

setMaximum(java.lang.Number)

setMaximum

public void setMaximum(Number maximum)

Sets the meta-data "maximum" property. Setting a minimum and/or maximum will cause an appropriate range validator object to be added to this meta-data object.

Parameters:

maximum - Number containing the maximum value of the data field.

Throws:

IllegalArgumentException - if the maximum object's class does not equal the meta-data's field class

See Also:

getMaximum()

isCurrency

public boolean isCurrency()

Gets the meta-data "currency" property which indicates whether this data field represents a currency value. The default is false.

Returns:

boolean indicating whether the data field represents a currency

See Also:

setCurrency(boolean)

setCurrency

public void setCurrency(boolean currency)

Sets the meta-data "currency" property.

Parameters:

currency - boolean indicating whether the data field represents a currency

See Also:

isCurrency()