planetj.database.field
Class StringOrNumberField

java.lang.Object
  |
  +--planetj.database.Field
        |
        +--planetj.database.field.StringOrNumberField

All Implemented Interfaces:

Cloneable, ICSVField, IExternallyNamed, IFDFObject, IGuarded, INamed, IXMLObject, Serializable

Direct Known Subclasses:

CreditCardExpirationMonthField, CreditCardExpirationYearField, CreditCardNumberField, NumberField, PhoneNumberField, SocialSecurityNumberField, StringField, TrackingNumberField, ZipCodeField

public abstract class StringOrNumberField

extends Field

implements Cloneable, Serializable

Author:

PlanetJ Corporation

See Also:

Serialized Form

Nested Class Summary

Nested classes inherited from class planetj.database.Field

Field.FieldLocation

Field Summary

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

StringOrNumberField()

Method Summary

Object	createObject(String pStringValue) Create an object for this Field type using the given String.
Object	getCopiedValue() Gets an independent copy of this field's value.
String	getDefaultDatabaseValue() Subclass must override this method and return a default value to be placed in the database when this field is Not-nullable and not required.
String	getSQLValue(boolean pUseOriginalValue) Returns the Field's name and value in SQL format.
boolean	isValueEqual(Object obj) Return a boolean indicating if the passed in Object is equal to this Fields value.
boolean	isValueGreaterThan(Object obj) Returns a boolean indicating if this field is greater than the supplied object.
boolean	isValueLessThan(Object obj) Returns a boolean indicating if this field is less then the supplied object.
void	setValue(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

addFieldClassForDataClass, addPropertyChangeListener, appendSQLColumnDefinition, appendSQLNameAndValue, appendSQLNameAndValue, clearValidationExceptions, cloneField, commitValue, concat, create, create, createFromDataType, divide, equals, executeGetterMethod, executeSetterMethod, getAssociationOperation, getAttribute, getAutoUpdateValue, getColumnSpan, getConfigProperty, getCSVField, getCurrentValue, getCurrentValueAsString, getDataSQLOperation, getDate, getDefaultExternalName, getDefaultUsageId, getDefaultValue, getDisplayHeight, getDisplayLength, getDisplayOrder, getDisplayValue, getDisplayWidth, getExternalName, getExternalValidationKey, getFDFData, getFieldClassForDataClass, getFieldDescriptor, getFieldDescriptorSource, getFieldIncrementor, getIndex, getLibrary, getLibraryName, getMaxLength, getMaxLength, getMetaDataSystemAlias, getName, getOldValue, getOldValueAsString, getPossibleValues, getPossibleValues, getPreferredDisplayLength, getPreferredJavaDataType, getRow, getSecuredTypeId, getSecuredTypeName, getSecurityType, getSQLColumnDefinition, getSQLColumnDefinition, getSQLNameAndDefaultValue, getSQLNameAndValue, getSQLNameAndValue, getSQLObject, getSQLType, getSQLType, getSQLTypeName, getSQLTypeName, getSQLValue, getSQLValue, getStaticAttribute, getStyleClass, getStyleClass, getSystem, getSystemAlias, getSystemURL, getTable, getTableName, getValidationExceptions, getValidationInvalidLengthString, getValidationInvalidMinLengthString, getValidationInvalidValueString, getValidationInvalidValueString, getValidationRequiredString, getValidValuesString, getValue, getValueAsBoolean, getValueAsByte, getValueAsDate, getValueAsDouble, getValueAsFloat, getValueAsFullLengthString, getValueAsInt, getValueAsLong, getValueAsNumber, getValueAsShort, getValueAsString, getXMLData, getXMLTag, guessFieldClassProbability, handlePossibleValueOperation, hasMultipleStyleClasses, hasOldValue, hasPossibleValuesKeyClassOrOp, hasPossibleValuesSQLOperation, hasPossibleValuesSQLOperation, hasValue, isApplicable, isAuthorizedForEdit, isAuthorizedForRead, isAutoUpdateValue, isBoolean, isChanged, isContainsValue, isCurrentValueField, isCurrentValueString, isDate, isDecimalSQLType, isDecimalSQLType, isDefaultValue, isDerived, isDisplayable, isFieldContentDisplayable, isFieldValueDatabaseDefault, isFieldValueNotBlank, isFieldValueNull, isFileUpload, isGuarded, isHelpTextPresent, isInitialized, isNumeric, isNumericSQLType, isNumericSQLType, isPassword, isPhysical, isPossibleValuesSearch, isReadOnly, isReadOnly, isRequired, isRequired, isRequiredOnSearch, isSkeleton, isString, isStringSQLType, isStringSQLType, isTime, isUpdateable, isValidationRequiredForAutoPopulate, isValidLength, isValidLength, isValidMinLength, isValidRequired, isValidRequired, isValidValue, isValidValue, isValueEqualToString, lessThan, removePropertyChangeListener, rollbackChanges, setAttribute, setChanged, setClonedValues, setDate, setFieldContentDisplayable, setFieldDescriptor, setInitialValue, setInitialValueAsString, setMaxLength, setName, setRow, setSavepoint, setSQLType, setSQLTypeName, setStaticAttribute, setTable, setValue, setValue, setValueAsString, setValueToDefault, toString, toUpperCase, validate, validate, validate

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

StringOrNumberField

public StringOrNumberField()

Method Detail

createObject

public Object createObject(String pStringValue)
                    throws NumberFormatException

Create an object for this Field type using the given String.

Specified by:

createObject in class Field

Parameters:

pStringValue - String

NumberFormatException

getCopiedValue

public Object getCopiedValue()

Gets an independent copy of this field's value. If the value is immutable, then this method can simply return the value. Otherwise, a clone of the value should be returned.

Specified by:

getCopiedValue in class Field

getDefaultDatabaseValue

public String getDefaultDatabaseValue()

Subclass must override this method and return a default value to be placed in the database when this field is Not-nullable and not required.

Example: A SS# is not required to be filled in by users, but the database does not allow nulls in that field. SocialSecurityField must override this method and return a default value like -1; Creation date: (4/9/2002 4:42:30 PM)

Specified by:

getDefaultDatabaseValue in class Field

getSQLValue

public String getSQLValue(boolean pUseOriginalValue)
                   throws CMException

Returns the Field's name and value in SQL format.

Specified by:

getSQLValue in class Field

Parameters:

pUseOriginalValue -

Returns:

String

CMException

isValueEqual

public boolean isValueEqual(Object obj)

Return a boolean indicating if the passed in Object is equal to this Fields value.

Specified by:

isValueEqual in class Field

isValueGreaterThan

public boolean isValueGreaterThan(Object obj)

Returns a boolean indicating if this field is greater than the supplied object. the Row the Field belongs to.

Specified by:

isValueGreaterThan in class Field

Returns:

boolean

isValueLessThan

public boolean isValueLessThan(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.

Specified by:

isValueLessThan in class Field

Returns:

boolean

setValue

public void setValue(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 Field

CMException