de.esoco.data.element

Class BigDecimalDataElement

java.lang.Object

de.esoco.lib.property.AbstractStringProperties

de.esoco.lib.property.StringProperties

de.esoco.data.element.DataElement<java.math.BigDecimal>

de.esoco.data.element.BigDecimalDataElement

All Implemented Interfaces:

de.esoco.lib.property.HasProperties, de.esoco.lib.property.MutableProperties, java.io.Serializable

public class BigDecimalDataElement
extends DataElement<java.math.BigDecimal>

A data element implementation for BigDecimal values.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BigDecimalDataElement.DisplayStyle Enumeration of the available display styles.

Nested classes/interfaces inherited from class de.esoco.data.element.DataElement

DataElement.CopyMode, DataElement.Flag

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CURRENCY_CONSTRAINT Input constraint for positive currency values.
static java.lang.String	DECIMAL_GROUP_CHAR The placeholder string for the decimal grouping character.
static java.lang.String	DECIMAL_SEPARATOR_CHAR The placeholder string for the decimal separator character.
static java.lang.String	DEFAULT_CONSTRAINT Default input constraint for positive or negative decimal values with optional grouping characters.
static de.esoco.lib.property.PropertyName<BigDecimalDataElement.DisplayStyle>	DISPLAY_STYLE A style property that defines the rendering of big decimal values.
static java.lang.String	SIGNED_CURRENCY_CONSTRAINT A variant of CURRENCY_CONSTRAINT that allows both positive and negative valuess.

Fields inherited from class de.esoco.data.element.DataElement

ALLOWED_VALUES_CHANGED, ANONYMOUS_ELEMENT_PREFIX, DISPLAY_FLAGS, HIDDEN_URL, INPUT_FLAGS, INTERACTION_URL, ITEM_ALL_RESOURCE, ITEM_NEW_RESOURCE, ITEM_RESOURCE_PREFIX, PATH_SEPARATOR_CHAR, SERVER_PROPERTIES

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BigDecimalDataElement() Default constructor for serialization.
	BigDecimalDataElement(java.lang.String sName, java.math.BigDecimal nValue) Creates a new read-only instance with a certain name and value.
	BigDecimalDataElement(java.lang.String sName, java.math.BigDecimal rValue, Validator<? super java.math.BigDecimal> rValidator, java.util.Set<DataElement.Flag> rFlags) Creates a new instance with a certain initial value and validator.

Method Summary

Modifier and Type	Method and Description
BigDecimalDataElement	copy(DataElement.CopyMode eMode, de.esoco.lib.property.PropertyName<?>... rCopyProperties) Returns a copy of this data element that contains all or a subset of it's current state.
java.math.BigDecimal	getValue() //~ Methods ---------------------------------------------------------------- /*************************************** Returns the value of this element.
protected BigDecimalDataElement	newInstance() Returns a new instance of the respective data element sub-type on which it is invoked.
void	setStringValue(java.lang.String sValue) Sets a string value.
protected void	updateValue(java.math.BigDecimal rNewValue) Updates the element value.
protected boolean	valuesEqual(java.math.BigDecimal a, java.math.BigDecimal b) Checks two values for equality.

Methods inherited from class de.esoco.data.element.DataElement

checkImmutable, checkValidValue, copyAttributes, copyValue, createItemName, createItemResource, createResourceId, equals, getAllowedValues, getElementValidator, getName, getParent, getPath, getResourceId, getRoot, getSimpleName, getValidator, getValueHashCode, hasEqualValueAs, hashCode, init, isImmutable, isModified, isOptional, isSelected, isValidValue, markAsChanged, readFrom, removeProperty, setModified, setProperty, setSelected, setValidator, setValue, toDebugString, toString, writeTo

Methods inherited from class de.esoco.lib.property.StringProperties

clearFlag, clearProperties, setFlag, setProperties, setProperty, setProperty

Methods inherited from class de.esoco.lib.property.AbstractStringProperties

convertCollection, convertMap, convertValue, ensurePropertyMapExists, findValue, getIntProperty, getProperty, getPropertyCount, getPropertyMap, getPropertyNames, hasEqualProperties, hasFlag, hasProperty, parseCollection, parseMap, parseValue, setPropertyMap

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.esoco.lib.property.HasProperties

getIntProperty, getProperty, getPropertyCount, getPropertyNames, hasFlag, hasProperty

Field Detail

DISPLAY_STYLE

public static final de.esoco.lib.property.PropertyName<BigDecimalDataElement.DisplayStyle> DISPLAY_STYLE

A style property that defines the rendering of big decimal values.

DECIMAL_GROUP_CHAR

public static final java.lang.String DECIMAL_GROUP_CHAR

The placeholder string for the decimal grouping character.

See Also:

Constant Field Values

DECIMAL_SEPARATOR_CHAR

public static final java.lang.String DECIMAL_SEPARATOR_CHAR

The placeholder string for the decimal separator character.

See Also:

Constant Field Values

DEFAULT_CONSTRAINT

public static final java.lang.String DEFAULT_CONSTRAINT

Default input constraint for positive or negative decimal values with optional grouping characters. Contains the input character placeholders DECIMAL_GROUP_CHAR and DECIMAL_SEPARATOR_CHAR which must be replaced with the actual locale-specific pattern before using the string as a regular expression.

See Also:

Constant Field Values

CURRENCY_CONSTRAINT

public static final java.lang.String CURRENCY_CONSTRAINT

Input constraint for positive currency values. To also allow negative values use SIGNED_CURRENCY_CONSTRAINT. See the remarks for DEFAULT_CONSTRAINT.

See Also:

Constant Field Values

SIGNED_CURRENCY_CONSTRAINT

public static final java.lang.String SIGNED_CURRENCY_CONSTRAINT

A variant of CURRENCY_CONSTRAINT that allows both positive and negative valuess.

See Also:

Constant Field Values

Constructor Detail

BigDecimalDataElement

public BigDecimalDataElement(java.lang.String sName,
                             java.math.BigDecimal nValue)

Creates a new read-only instance with a certain name and value.

Parameters:

sName - The name of this element

nValue - The initial value

BigDecimalDataElement

public BigDecimalDataElement(java.lang.String sName,
                             java.math.BigDecimal rValue,
                             Validator<? super java.math.BigDecimal> rValidator,
                             java.util.Set<DataElement.Flag> rFlags)

Creates a new instance with a certain initial value and validator.

Parameters:

sName - The name of this element

rValue - The initial value

rValidator - The validator for the value or NULL for none

rFlags - The optional flags for this data element

BigDecimalDataElement

protected BigDecimalDataElement()

Default constructor for serialization.

Method Detail

copy

public BigDecimalDataElement copy(DataElement.CopyMode eMode,
                                  de.esoco.lib.property.PropertyName<?>... rCopyProperties)

Returns a copy of this data element that contains all or a subset of it's current state. Always copied are the name and flags. Never copied is the parent reference because upon copying typically a reference to a copied parent needs to be set. The further data the copy contains depends on the copy mode:

• DataElement.CopyMode.FULL: The copy contains all data (except the parent reference).
• DataElement.CopyMode.FLAT: like DataElement.CopyMode.FULL but without sub-ordinate data elements.
• DataElement.CopyMode.PROPERTIES: The copy contains only the properties but not the element value and attributes.
• DataElement.CopyMode.PLACEHOLDER: The copy contains only the element name to serve as a placeholder.

The copy instance is created by invoking DataElement.newInstance() which has the recommendation to overwrite the return type to the concrete subtype to prevent the need for casting by the invoking code. For the same reason it is recommended that subclasses also override this method with the concrete return type and cast the result of super.copy() to that type.

Overrides:

copy in class DataElement<java.math.BigDecimal>

Parameters:

eMode - The copy mode

rCopyProperties - An optional list of properties to copy. If not provided all properties will be copied (unless the mode is DataElement.CopyMode.PLACEHOLDER)

Returns:

The copied instance

getValue

public final java.math.BigDecimal getValue()

//~ Methods ---------------------------------------------------------------- /*************************************** Returns the value of this element. Each subclass must implement this method separately because some environments (like GWT) require serializable objects to use specific types for serializable fields. Therefore it is not possible to store a generic Object value in the base class.

Specified by:

getValue in class DataElement<java.math.BigDecimal>

Returns:

The element value

setStringValue

public void setStringValue(java.lang.String sValue)

Sets a string value. This method must be overridden by subclasses that want to support the setting of string values in parallel to their native datatype. The default implementation always throws a runtime exception.

Overrides:

setStringValue in class DataElement<java.math.BigDecimal>

Parameters:

sValue - The new string value

newInstance

protected BigDecimalDataElement newInstance()

Returns a new instance of the respective data element sub-type on which it is invoked. This is needed for GWT which doesn't support reflection. Used by DataElement.copy(CopyMode, PropertyName...) for cloning an instance. Implementations should overwrite the return type with their concrete type to prevent the need for casting by the invoking code.

Specified by:

newInstance in class DataElement<java.math.BigDecimal>

Returns:

The new instance

updateValue

protected void updateValue(java.math.BigDecimal rNewValue)

Updates the element value. Will be invoked by DataElement.setValue(Object) to store a new value after validation. If a subclass wants to reject certain values it should do so in the DataElement.isValidValue(Validator, Object) method. Subclasses that are always immutable should implement an assertion because if the element has been initialized correctly (validator = NULL) this method should then be reached.

Specified by:

updateValue in class DataElement<java.math.BigDecimal>

Parameters:

rNewValue - The new value for this element

valuesEqual

protected boolean valuesEqual(java.math.BigDecimal a,
                              java.math.BigDecimal b)

Checks two values for equality. The default implementation invokes the method Object.equals(Object) but subclasses can override this for more specific comparisons (e.g. by using Comparable).

Overrides:

valuesEqual in class DataElement<java.math.BigDecimal>

Parameters:

a - The first value to compare (can be be NULL)

b - The second value to compare (can be be NULL)

Returns:

TRUE if the values are equal