planetj.database.field
Class StringField

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

All Implemented Interfaces:

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

Direct Known Subclasses:

AbstractBooleanField, Address1Field, Address2Field, CityField, ConnectionStatusField, CreditCardTypeField, DataLinkField, FDLibraryNameField, FDNameField, FirstAndLastNameField, FirstNameField, FlatFileReferenceField, GenderField, HTMLCodeField, ImageURLReferenceField, JavaClassNameField, JSPFileNameField, LastNameField, LowerCaseStringField, PasswordField, RegistrationModeField, StateField, TableField, UpperCaseStringField, URLReferenceField, UserIdField

public class StringField

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

StringField()

Method Summary

java.lang.Object	createObject(java.lang.String pStringValue) Create an object for this Field type using the given String.
java.lang.String	getCSVField() Returns the String value of the Object, that will be written to the CSV file.
java.lang.String	getExternalValidationKey() Get the key that may be used to uniquely identify Field subclasses for external validation.
boolean	getValueAsBoolean() Subclasses must override this to detirmine what their boolean value is.
boolean	isNumber() This is a not a Number field.
boolean	isString() This is a String field.
boolean	isValidLength(ExecutingContext ec) Check to see if the given value is equal to this field's value.
boolean	isValueEqual(java.lang.Object obj, boolean ignoreCase) Check to see if the given value is equal to this field's value.
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, getCopiedValue, getDefaultDatabaseValue, getSQLValue, isValueEqual, 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, 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, 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, isNumeric, 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, 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

StringField

public StringField()

Method Detail

createObject

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

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

Overrides:

createObject in class StringOrNumberField

Parameters:

pStringValue - String

getCSVField

public java.lang.String getCSVField()

Returns the String value of the Object, that will be written to the CSV file. If the toString method of any Object already does this, then there is no need to implement this interface.

VARCHAR Enclosed by double quotation marks and are not padded to create a fixed length field.

CHAR Enclosed by double quotation marks but are padded with blanks if necessary to create a fixed length field

In a CMException was thrown, or there were problems, then [Invalid Field] will be returned Creation date: (4/22/2002 2:28:25 PM)

Specified by:

getCSVField in interface ICSVField

Overrides:

getCSVField in class Field

Returns:

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

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

isNumber

public boolean isNumber()

This is a not a Number field.

isString

public boolean isString()

This is a String field.

Overrides:

isString in class Field

Returns:

boolean

isValidLength

public boolean isValidLength(ExecutingContext ec)

Check to see if the given value is equal to this field's value. If specified, the value's case is ignored.

Overrides:

isValidLength in class Field

Parameters:

ec - The current executing context, which may be null

Returns:

boolean true if valid

isValueEqual

public boolean isValueEqual(java.lang.Object obj,
                            boolean ignoreCase)

Check to see if the given value is equal to this field's value. If specified, the value's case is ignored.

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