planetj.database.field
Class JavaClassNameField

java.lang.Object
  |
  +--planetj.database.Field
        |
        +--planetj.database.field.StringOrNumberField
              |
              +--planetj.database.field.StringField
                    |
                    +--planetj.database.field.JavaClassNameField
All Implemented Interfaces:
Cloneable, ICSVField, IExternallyNamed, IFDFObject, IGuarded, INamed, IXMLObject, Serializable
Direct Known Subclasses:
DataEngineServletClassName, FieldClassName, FormatterClassName, PossibleValueGetterClassName, RowClassName, RowCollectionClassName

public class JavaClassNameField
extends StringField

A field which holds the name of a Java class

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
JavaClassNameField()
           
 
Method Summary
 Class getCompatibleClass()
          Gets the class which the class specified in this field must implement or extend
 Class getJavaClass()
          Gets the Java class object for this field's value.
 String getJavaClassName()
          Gets the Java class name set on this field's value.
 Object getJavaObject()
           
 String getValidationInvalidValueString(String givenValue)
          This method will return the long description of why this field's value is invalid and possible actions or examples we could put in this field.
 boolean isValidValue(ExecutingContext ec)
          Validate this Field value.
 void setCompatibleClass(Class newCompatibleClass)
          Sets the class which the class specified in this field must implement or extend
 
Methods inherited from class planetj.database.field.StringField
createObject, getCSVField, getExternalValidationKey, getValueAsBoolean, isNumber, isString, isValidLength, setValue
 
Methods inherited from class planetj.database.field.StringOrNumberField
getCopiedValue, getDefaultDatabaseValue, getSQLValue, isValueEqual, isValueGreaterThan, isValueLessThan
 
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, getCurrentValue, getCurrentValueAsString, getDataSQLOperation, getDate, getDefaultExternalName, getDefaultUsageId, getDefaultValue, getDisplayHeight, getDisplayLength, getDisplayOrder, getDisplayValue, getDisplayWidth, getExternalName, 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, getValidationRequiredString, getValidValuesString, getValue, 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, isStringSQLType, isStringSQLType, isTime, isUpdateable, isValidationRequiredForAutoPopulate, isValidLength, isValidMinLength, isValidRequired, isValidRequired, 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

JavaClassNameField

public JavaClassNameField()
Method Detail

getCompatibleClass

public Class getCompatibleClass()
Gets the class which the class specified in this field must implement or extend


getJavaClass

public Class getJavaClass()
                   throws CMException
Gets the Java class object for this field's value. An exception is thrown if the class name does not represent a valid Java class, or if the class is not compatible with this field's compatible class

Returns:
null if this field does not contain a class name, or the Java class if this field does contain a valid Java class.
CMException

getJavaClassName

public String getJavaClassName()
Gets the Java class name set on this field's value.

Returns:
field's value which is a Java class name.

getJavaObject

public Object getJavaObject()
                     throws CMException
CMException

getValidationInvalidValueString

public String getValidationInvalidValueString(String givenValue)
                                       throws CMException
This method will return the long description of why this field's value is invalid and possible actions or examples we could put in this field.

Overrides:
getValidationInvalidValueString in class Field
CMException

isValidValue

public boolean isValidValue(ExecutingContext ec)
                     throws CMException
Description copied from class: Field
Validate this Field value. Subclasses should override and validate according to their field types. 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
CMException

setCompatibleClass

public void setCompatibleClass(Class newCompatibleClass)
Sets the class which the class specified in this field must implement or extend