planetj.database.field
Class SocialSecurityNumberField

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

All Implemented Interfaces:

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

public class SocialSecurityNumberField

extends StringOrNumberField

Represents a Social Security Number. Creation date: (5/7/2002 2:48:13 PM)

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

SocialSecurityNumberField()

Method Summary

java.lang.Object	createObject(java.lang.String pStringValue) Create an object for this Field type using the given String.
java.lang.String	getExternalValidationKey() Get the key that may be used to uniquely identify Field subclasses for external validation.
java.lang.Object	getSQLObject() Gets this field's value as an Object in SQL format.
java.lang.String	getValidValuesString() This method should be overriden by subclasses that want to display possible or valid values to a user Example PhoneNumber would return "Example: (123) 456-7890, 1234567890, 123-456-7890" Creation date: (4/5/2002 2:52:46 PM)
boolean	getValueAsBoolean() Subclasses must override this to detirmine what their boolean value is.
static short	guessFieldClassProbability(FieldDescriptorRow pFDRow, RowCollection pSampleData) Subclasses will override to take an educated guess at what the Field Class will be for this FD Row.
boolean	isValidLength(ExecutingContext ec) Validate this Field based on its max length attribute.
boolean	isValidRequired(ExecutingContext ec) Validate this Field based on its required attribute.
boolean	isValidValue(ExecutingContext ec) Validate this Field value.
boolean	isValueEqual(java.lang.Object pValue) Returns a boolean indicating if this field is equal to the supplied object.
void	setValue(java.lang.Object pValue) SocialSecurityNumber Fields must be stored internally as a String becasue they can start with a 0 Creation date: (5/15/2002 6:57:28 PM)

Methods inherited from class planetj.database.field.StringOrNumberField

correctValue, getCopiedValue, getDefaultDatabaseValue, getSQLValue, isValueGreaterThan, isValueLessThan

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, getDisplayValue, 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, 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, getValue, getValueAsByte, getValueAsDate, getValueAsDouble, getValueAsFloat, getValueAsFullLengthString, getValueAsInt, getValueAsLong, getValueAsNumber, getValueAsShort, getValueAsString, getXMLData, getXMLTag, 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, isNumeric, isNumericSQLType, isNumericSQLType, isPassword, isPhysical, isPossibleValuesSearch, isPrepareFieldValue, isReadOnly, isReadOnly, isReadOnlyOnSearch, isRequired, isRequired, isRequiredOnSearch, isSkeleton, isStatusChange, isString, isStringSQLType, isStringSQLType, isTime, isTimestamp, isUpdateable, isValidationRequiredForAutoPopulate, isValidLength, isValidMinLength, 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

SocialSecurityNumberField

public SocialSecurityNumberField()

Method Detail

createObject

public java.lang.Object createObject(java.lang.String pStringValue)
                              throws java.lang.NumberFormatException

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

Overrides:

createObject in class StringOrNumberField

Parameters:

pStringValue - String

Throws:

java.lang.NumberFormatException

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

getSQLObject

public java.lang.Object getSQLObject()
                              throws CMException

Description copied from class: Field

Gets this field's value as an Object in SQL format.

Overrides:

getSQLObject in class Field

Throws:

CMException

getValidValuesString

public java.lang.String getValidValuesString()

This method should be overriden by subclasses that want to display possible or valid values to a user Example PhoneNumber would return "Example: (123) 456-7890, 1234567890, 123-456-7890" Creation date: (4/5/2002 2:52:46 PM)

Overrides:

getValidValuesString in class Field

Returns:

java.lang.String

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

guessFieldClassProbability

public static short guessFieldClassProbability(FieldDescriptorRow pFDRow,
                                               RowCollection pSampleData)

Subclasses will override to take an educated guess at what the Field Class will be for this FD Row. Each subclass will examin fields such as : {DECIMAL_DIGITS, COLUMN_NAME, COLUMN_SIZE, REMARKS, DATA_TYPE, TYPE_NAME} Each subclass will detirmine the probability that it should be the field class for this FD Row. -1 will be returned if there is no chance (0%)this field is the fieldClass for pFDRow. 100 or greater will be returned if this is absolutely 100% the field class for pFDRow Creation date: (6/19/2002 2:55:49 PM)

isValidLength

public boolean isValidLength(ExecutingContext ec)

Validate this Field based on its max length attribute. If the value is is too big, the return false

Overrides:

isValidLength in class Field

Parameters:

ec - The current executing context, which may be null

Returns:

boolean true if valid

isValidRequired

public boolean isValidRequired(ExecutingContext ec)

Validate this Field based on its required attribute. If the value is null and the field is required, then return false

Overrides:

isValidRequired 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 pValue)

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

setValue

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

SocialSecurityNumber Fields must be stored internally as a String becasue they can start with a 0 Creation date: (5/15/2002 6:57:28 PM)

Overrides:

setValue in class StringOrNumberField

Throws:

CMException