planetj.database.field
Class BlankDisplayField

java.lang.Object
  |
  +--planetj.database.Field
        |
        +--planetj.database.field.LogicalField
              |
              +--planetj.database.field.BlankDisplayField

All Implemented Interfaces:

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

public class BlankDisplayField

extends LogicalField

A Field which is always displayed as blank, and whose value is null. Attempting to update the contents of this field will cause an exception to be thrown.

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

BlankDisplayField()

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	getDisplayValue() Returns an empty String
String	getSQLValue(boolean pUseOriginalValue) Returns the Field's value in SQL format.
boolean	getValueAsBoolean() Subclasses must override this to detirmine what their boolean value is.
String	getValueAsString() Returns the Field's value as a String.
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.

Methods inherited from class planetj.database.field.LogicalField

setRow

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, 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, getValueAsByte, getValueAsDate, getValueAsDouble, getValueAsFloat, getValueAsFullLengthString, getValueAsInt, getValueAsLong, getValueAsNumber, getValueAsShort, 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, setSavepoint, setSQLType, setSQLTypeName, setStaticAttribute, setTable, setValue, 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

BlankDisplayField

public BlankDisplayField()

Method Detail

createObject

public Object createObject(String pStringValue)

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

Specified by:

createObject in class Field

Parameters:

pStringValue - String

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()
                               throws CMException

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: (8/26/2002 6:49:09 PM)

Overrides:

getDefaultDatabaseValue in class LogicalField

CMException

getDisplayValue

public String getDisplayValue()

Returns an empty String

Overrides:

getDisplayValue in class Field

Returns:

java.lang.String

getSQLValue

public String getSQLValue(boolean pUseOriginalValue)
                   throws CMException

Returns the Field's value in SQL format. For example, if this field's value is the number 3 then the String "3" is returned. If this field's value is the String "Hello" then the String "'Hello'" is returned.

Overrides:

getSQLValue in class LogicalField

Parameters:

pUseOriginalValue - If this is true then the value used will be this field's original value as it was read from the database. Otherwise its current value is used.

CMException

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

getValueAsString

public String getValueAsString()

Returns the Field's value as a String.

Overrides:

getValueAsString in class Field

Returns:

String

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. Subclasses should override and implement as appropriate.

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