planetj.database.field
Class NumberField

java.lang.Object
  planetj.database.Field
      planetj.database.field.StringOrNumberField
          planetj.database.field.NumberField

All Implemented Interfaces:

java.lang.Cloneable, IActionObject, ICSVField, IExternallyNamed, IFDFObject, IGuarded, INamed, IPDFField, IXMLObject, java.io.Serializable

Direct Known Subclasses:

BigDecimalField, BigIntegerField, YearField

public abstract class NumberField

extends StringOrNumberField

implements java.lang.Cloneable, java.io.Serializable

See Also:

Serialized Form

Nested Class Summary

Nested classes inherited from class planetj.database.Field

Field.FieldLocation

Field Summary

Fields inherited from class planetj.database.Field

ALIGN_CENTER, ALIGN_LEFT, ALIGN_RIGHT, ALIGN_UNKNOWN

Fields inherited from interface planetj.dataengine.security.IGuarded

TYPE_ID_UNKNOWN, TYPE_NAME_FIELD, TYPE_NAME_SQLOPERATION, TYPE_SECURED_BY_LEVEL, TYPE_SECURED_BY_OPERATION, TYPE_UNSECURED

Constructor Summary

NumberField()

Method Summary

java.lang.String	getDisplayValue() Returns the display value of this Field as a String.
java.lang.String	getDisplayValue(java.lang.Object value) Returns the display value of this Field as a String.
java.lang.String	getExternalValidationKey() Get the key that may be used to uniquely identify Field subclasses for external validation.
short	getScale() Convience method to get this Field's scale if it has one.
java.math.BigDecimal	getValueAsBigDecimal() Returns a BigDecimal value.
boolean	getValueAsBoolean() Subclasses must override this to detirmine what their boolean value is.
boolean	hasScale() Convience method to check to see if the number field has a scale (i.e.
abstract boolean	isIntegersOnly() Test if this field can only contain integer values
boolean	isNumeric() This is a Number field.
boolean	isString() This is not a String field.
boolean	isValidLength(ExecutingContext ec) Tests if the field's value is too long
boolean	isValidValue(ExecutingContext ec) Validate this Field value.
boolean	isValueEqual(java.lang.Object obj) Returns a boolean indicating if this field is equal to the supplied object.
boolean	isValueGreaterThan(java.lang.Object obj) Returns a boolean indicating if this field is greater than the supplied object.
boolean	isValueLessThan(java.lang.Object obj) Returns a boolean indicating if this field is less then the supplied object.
java.math.BigDecimal	scaleValue(java.math.BigDecimal value) Scaled the given BigDecimal value with this Field's scale defined in its FD.
void	setValue(java.lang.Object pValue) Sets the current value of the Field to the specified value, and also sets the old value to the previous value.

Methods inherited from class planetj.database.field.StringOrNumberField

correctValue, createObject, getCopiedValue, getDefaultDatabaseValue, getSQLValue

Methods inherited from class planetj.database.Field

addFieldClassForDataClass, addPropertyChangeListener, appendSQLColumnDefinition, appendSQLNameAndValue, appendSQLNameAndValue, clearTable, clearValidationExceptions, clearValue, cloneFD, cloneField, commitValue, concat, correctSQLLiteral, create, create, createAction, createFromDataType, createInternal, divide, equals, executeGetterMethod, executeSetterMethod, firePropertyChange, getActionDefaultLocation, getActionDescriptor, getActionRequest, getActionRequest, getActions, getAssociationOperation, getAttribute, getAutoUpdateValue, getBackgroundColor, getBackgroundColor, getColumnSpan, getConfigProperty, getCSVDisplayField, getCSVField, getCurrentValue, getCurrentValueAsString, getDataSQLOperation, getDate, getDefaultExternalName, getDefaultUsageId, getDefaultValue, getDisplayComponent, getDisplayHeight, getDisplayLength, getDisplayOrder, getDisplayWidth, getExternalName, getFDFData, getFieldClassForDataClass, getFieldClassParameters, getFieldDescriptor, getFieldDescriptorSource, getFieldHandledActionNames, getFieldIncrementor, getFieldSetName, getFormatter, getHorizontalAlignment, getIndex, getLibrary, getLibraryName, getMaxLength, getMaxLength, getMetaDataSystemAlias, getName, getOldValue, getOldValueAsString, getPDFValue, getPossibleValueClass, getPossibleValues, getPossibleValues, getPossibleValuesKey, getPossibleValuesOperation, getPossibleValuesSQLOperation, getPreferredDisplayLength, getPreferredJavaDataType, getPVPage, getRow, getSearchDefaultValue, getSecuredTypeId, getSecuredTypeName, getSecurityType, getSQLColumnDefinition, getSQLColumnDefinition, getSQLNameAndDefaultValue, getSQLNameAndValue, getSQLNameAndValue, getSQLNullValue, getSQLObject, getSQLType, getSQLType, getSQLTypeName, getSQLTypeName, getSQLValue, getSQLValue, getStaticAttribute, getStaticAttributes, getStatusChange, getStyleClass, getStyleClass, getSystem, getSystemAlias, getSystemURL, getTable, getTableName, getUsageId, getUsageId, getUsageIds, getValidationExceptions, getValidationInvalidLengthString, getValidationInvalidMinLengthString, getValidationInvalidValueString, getValidationInvalidValueString, getValidationRequiredString, getValidValuesString, getValue, getValueAsByte, getValueAsDate, getValueAsDouble, getValueAsFloat, getValueAsFullLengthString, getValueAsInt, getValueAsLong, getValueAsNumber, getValueAsShort, getValueAsString, getXMLData, getXMLTag, guessFieldClassProbability, handleAction, handlePossibleValueOperation, hasAssociationOperation, hasMultipleStyleClasses, hasOldValue, hasPossibleValuesKeyClassOrOp, hasPossibleValuesOperation, hasPossibleValuesOperation, hasUsageId, hasUsageId, hasValue, incrementValue, isActionApplicable, isApplicable, isAuthorizedForEdit, isAuthorizedForRead, isAutoIncrement, isAutoIncrementDatabaseDriven, isAutoIncrementWOWDriven, isAutoUpdateValue, isBoolean, isChanged, isContainsValue, isCurrentValueField, isCurrentValueString, isDate, isDecimalSQLType, isDecimalSQLType, isDefaultValue, isDerived, isDisplayable, isFieldContentDisplayable, isFieldValueDatabaseDefault, isFieldValueNotBlank, isFieldValueNull, isFieldValuePossibleValue, isFieldValuesEqual, isFileUpload, isGuarded, isHelpTextPresent, isInitialized, isNumericSQLType, isNumericSQLType, isPassword, isPhysical, isPossibleValuesSearch, isPrepareFieldValue, isReadOnly, isReadOnly, isReadOnlyOnSearch, isRequired, isRequired, isRequiredOnSearch, isSkeleton, isStatusChange, isStringSQLType, isStringSQLType, isTime, isTimestamp, isUpdateable, isValidationRequiredForAutoPopulate, isValidLength, isValidMinLength, isValidRequired, isValidRequired, isValidValue, isValueEqualToString, lessThan, removePropertyChangeListener, resetDisplayValue, rollbackChanges, setAttribute, setChanged, setClonedValues, setDate, setFieldContentDisplayable, setFieldDescriptor, setHasValue, setIndex, setInitialValue, setInitialValueAsString, setMaxLength, setName, setPVPage, setRow, setSavepoint, setSkeleton, setSQLType, setSQLTypeName, setStaticAttribute, setTable, setValue, setValue, setValueAsString, setValueToDefault, statusChanged, toString, toUpperCase, validate, validate, validate

Methods inherited from class java.lang.Object

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

Constructor Detail

NumberField

public NumberField()

Method Detail

getDisplayValue

public final java.lang.String getDisplayValue()

Returns the display value of this Field as a String. If this Number is defined by the field data to be a currency, then the number is returned as a currency. However, if a formatter is specified, we only apply the formatters changes.

Overrides:

getDisplayValue in class Field

Returns:

java.lang.String

getDisplayValue

public java.lang.String getDisplayValue(java.lang.Object value)

Returns the display value of this Field as a String. If this Number is defined by the field data to be a currency, then the number is returned as a currency. However, if a formatter is specified, we only apply the formatters changes.

Returns:

java.lang.String

getExternalValidationKey

public java.lang.String getExternalValidationKey()

Get the key that may be used to uniquely identify Field subclasses for external validation. That is validation outside the Field itself. e.g. Javascript.

Overrides:

getExternalValidationKey in class Field

getScale

public short getScale()

Convience method to get this Field's scale if it has one.

Returns:

Field's scale if it has one, 0 otherwise.

getValueAsBigDecimal

public java.math.BigDecimal getValueAsBigDecimal()

Returns a BigDecimal value.

Returns:

BigDecimal

getValueAsBoolean

public boolean getValueAsBoolean()

Subclasses must override this to detirmine what their boolean value is. Returns a primitive that represents the value in the specified field.

Specified by:

getValueAsBoolean in class Field

Returns:

boolean

hasScale

public boolean hasScale()

Convience method to check to see if the number field has a scale (i.e. decimal digits)

isIntegersOnly

public abstract boolean isIntegersOnly()

Test if this field can only contain integer values

isNumeric

public boolean isNumeric()

This is a Number field.

Overrides:

isNumeric in class Field

isString

public boolean isString()

This is not a String field.

Overrides:

isString in class Field

Returns:

boolean

isValidLength

public boolean isValidLength(ExecutingContext ec)

Tests if the field's value is too long

Overrides:

isValidLength in class Field

Parameters:

ec - The current executing context, which may be null

Returns:

boolean true if valid

isValidValue

public boolean isValidValue(ExecutingContext ec)

Validate this Field value. If the field value is valid, return true,

Overrides:

isValidValue in class Field

Parameters:

ec - The executing context, which may be null

Returns:

boolean true if valid

isValueEqual

public boolean isValueEqual(java.lang.Object obj)

Returns a boolean indicating if this field is equal to the supplied object. the Row the Field belongs to. Subclasses should override and implement as appropriate.

Overrides:

isValueEqual in class StringOrNumberField

Returns:

boolean

isValueGreaterThan

public boolean isValueGreaterThan(java.lang.Object obj)

Returns a boolean indicating if this field is greater than the supplied object. the Row the Field belongs to. Subclasses should override and implement as appropriate.

Overrides:

isValueGreaterThan in class StringOrNumberField

Returns:

boolean

isValueLessThan

public boolean isValueLessThan(java.lang.Object obj)

Returns a boolean indicating if this field is less then the supplied object. the Row the Field belongs to. Subclasses should override and return the appropriate response.

Overrides:

isValueLessThan in class StringOrNumberField

Returns:

boolean

scaleValue

public java.math.BigDecimal scaleValue(java.math.BigDecimal value)

Scaled the given BigDecimal value with this Field's scale defined in its FD.

setValue

public void setValue(java.lang.Object pValue)
              throws CMException

Sets the current value of the Field to the specified value, and also sets the old value to the previous value. If called and the Field is not updatable a CMException is thrown.

Overrides:

setValue in class StringOrNumberField

Throws:

CMException