planetj.database.fielddescriptors
Class FieldDescriptorRow

java.lang.Object
  |
  +--planetj.database.Row
        |
        +--planetj.database.fielddescriptors.FieldDescriptorRow

All Implemented Interfaces:

Cloneable, IBatchProcessObject, IBusinessObject, ICSVRow, IDistributedExecutableObject, IFDFObject, IFieldData, IGuarded, INamedCollection, INavigationObject, IOwner, IRowCreator, IXMLObject, Serializable

Direct Known Subclasses:

AbstractDerivedFieldDescriptor, DerivedFieldDescriptor, TableDescriptor

public class FieldDescriptorRow

extends Row

implements IFieldData, Serializable, IOwner

Represents metadata describing a field that was read from a row in the database.

Author:

PlanetJ Corporation

See Also:

Serialized Form

Nested Class Summary

Nested classes inherited from class planetj.database.Row

Row.SpacingRow

Field Summary

Fields inherited from class planetj.database.Row

className, COPY, DELETE, INSERT, MODE_COPY, MODE_DELETE, MODE_INSERT, MODE_READ, MODE_SEARCH, MODE_UNKNOWN, MODE_UPDATE, READ, UPDATE

Fields inherited from interface planetj.database.fielddescriptors.IFieldData

APPLICATION_ID, ASSOCIATION_FIELD_ID, ASSOCIATION_ID, AUTHORIZE_EDIT_OPERATION, AUTHORIZE_READ_OPERATION, AUTO_TRIM_ON_READ, AUTO_TRIM_ON_WRITE, AUTO_TRIM_SPACES, AUTO_UPDATE_VALUE, BUFFER_LENGTH, CHAR_OCTET_LENGTH, COLUMN_DEF, COLUMN_NAME, COLUMN_SIZE, COMPANY_ID, CONCURRENCY, CONCURRENT_DELETES_ALLOWED, CONCURRENT_UPDATES_ALLOWED, CONCURRENT_UPDATES_AND_DELETES_ALLOWED, DATA_SQL_OPERATION_ID, DATA_TYPE, DECIMAL_DIGITS, DISPLAY_COMPONENT, DISPLAY_COMPONENT_ASSOC_OPERATION, DISPLAY_COMPONENT_EDITABLE_SELECT, DISPLAY_COMPONENT_EDITABLE_SELECT_TEXT_AREA, DISPLAY_COMPONENT_FILE_UPLOAD, DISPLAY_COMPONENT_LIST, DISPLAY_COMPONENT_RADIO_BUTTON_PV_SELECT, DISPLAY_COMPONENT_SYSTEM, DISPLAY_COMPONENT_TEXT_AREA, DISPLAY_HEIGHT, DISPLAY_LENGTH, DISPLAY_ORDER, DISPLAY_RULE, DISPLAY_RULE_ADMINISTRATOR, DISPLAY_RULE_ALWAYS, DISPLAY_RULE_HIDE_IF_NA_ALWAYS, DISPLAY_RULE_HIDE_IF_NA_ON_INSERT, DISPLAY_RULE_HIDE_IF_NA_ON_UPDATE, DISPLAY_RULE_HIDE_IF_NA_ON_UPDATE_AND_INSERT, DISPLAY_RULE_HIDE_ON_INSERT, DISPLAY_RULE_HIDE_ON_UPDATE, DISPLAY_RULE_HIDE_ON_UPDATE_AND_INSERT, DISPLAY_RULE_NEVER, DIVISION_ID, EXTERNAL_NAME, FIELD_CLASS, FIELD_CLASS_ID, FIELD_DATA_TABLE_NAME, FIELD_DESCRIPTOR_TYPE, FIELD_SET, FORMATTER_CLASS, FORMATTER_CLASS_ID, GETTER_METHOD, HELP_TEXT, ID, IS_AUTO_INCREMENT, IS_CASE_SENSITIVE, IS_CURRENCY, IS_DEFINITELY_WRITABLE, IS_NULLABLE, IS_READ_ONLY, IS_REQUIRED, IS_REQUIRED_ON_SEARCH, IS_SEARCHABLE, IS_SIGNED, IS_SORTABLE, IS_WRITABLE, KEY_POSITION, MAX_LIBRARY_NAME_LENGTH, MAX_TABLE_NAME_LENGTH, NO_CONCURRENT_ALTERATIONS_ALLOWED, NULLABLE, NUM_PREC_RADIX, ORDINAL_POSITION, ORIGIN_DB_METADATA, ORIGIN_FIELDDATA_FILE, ORIGIN_RS_METADATA, OWNER_ID, PARAM_DIGIT_REQUIRED, PARAM_MIN_LENGTH, POSSIBLE_VALUES_KEY, PV_CLASS, PV_CLASS_ID, PV_SQL_OPERATION_ID, REMARKS, SECURITY_ID, SECURITY_TYPE, SETTER_METHOD, SQL_DATA_TYPE, SQL_DATETIME_SUB, STATUS_CHANGE, STATUS_CHANGE_DEFAULT, STATUS_CHANGE_NO, STATUS_CHANGE_YES, STYLE_CLASS, SWITCHES, SYSTEM_ALIAS, SYSTEM_URL, TABLE_CAT, TABLE_ID, TABLE_NAME, TABLE_SCHEM, TYPE_DEFAULT_FIELD_DESCRIPTOR, TYPE_DERIVED_FIELD_DESCRIPTOR, TYPE_DRILL_DOWN_FIELD_DESCRIPTOR, TYPE_NAME, TYPE_ONE_TO_MANY_ASSOCIATION_FIELD_DESCRIPTOR, TYPE_ONE_TO_ONE_ASSOCIATION_FIELD_DESCRIPTOR, TYPE_POSSIBLE_VALUES_FIELD_DESCRIPTOR, TYPE_TABLE_DESCRIPTOR, USAGE_ID, XML_TAG

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

FieldDescriptorRow()

Method Summary

FieldDescriptorRow	cloneFD() Clones this FieldDescriptorRow.
Field	createDefaultField() Creates a default field for this field descriptor.
Field	createDefaultField(String pFieldName) Creates a default field for this field descriptor.
Field	createField() Creates a new field of the appropriate type
Field	createField(String pFieldName) Creates a new field of the appropriate type
Row	createRow(Row pDefaultRow) Creates a new Row.
String	getApplicationID()
int	getAssociationFieldId() Gets the id of the association group field that this field belongs to.
int	getAssociationId() Gets the id of the association group that this field belongs to.
Operation	getAssociationOperation() Gets the SQLOperation describing how the data for fields should be retrieved
int	getAssociationOperationId() Gets the id of the SQLOperation which is used to retrieve the data described by this field descriptor
String	getAutoUpdateStringValue(ExecutingContext pEc) Gets the auto update String parameter for the described fields.
String	getAutoUpdateValue() Gets the default value for the described fields.
String	getCatalog() Gets the Table's catalog (may be null).
String	getColumnName() Gets the Column name.
int	getColumnSize() Gets the column's size.
DBSystem	getColumnSystem() Gets the table that this field descriptor is in.
Table	getColumnTable() Returns the table that this field descriptor is in.
Table	getColumnTable(boolean oldValue) Returns the table that this field descriptor is in.
String	getColumnTableName() Gets the Table name.
String	getCompanyID()
int	getConcurrency() Gets the concurrency for the described field,, which determines if it is okay for concurrent update/deletes to occur.
String	getConnectionAlias() Gets the system alias.
SQLOperation	getDataSQLOperation() Deprecated. replaced with getAssociationOperation()
int	getDataSQLOperationId() Deprecated. replaced with getAssociationID()
short	getDataType() The returned value can be compated to values in java.sql.Types Creation date: (6/20/2002 1:28:30 PM)
short	getDecimalDigits() Gets the column's number of fractional digits.
String	getDefaultStringValue(ExecutingContext pEc) Return the string parameter specified as the default value.
String	getDefaultValue() Return the string parameter specified as the default value.
String	getDeleteConfirmationMessage() Get the delete confirmation message.
int	getDisplayComponent() Gets the display component for this field.
int	getDisplayHeight() Gets the Field's display height.
int	getDisplayLength() Deprecated. replaced with getDisplayWidth() to keep consistent with what a user sees when they view the field (e.g. width and height of a field)
int	getDisplayOrder() Gets the order in which this field should be displayed.
int	getDisplayRule() Gets the display rule for this field.
int	getDisplayWidth() Gets the Field's display width.
String	getDivisionID()
String	getExternalName() Sets the external name of the described fields.
String	getFieldClass() Deprecated. Use getFieldClassName() instead
String	getFieldClassName() Gets the name of the Java Class to use for instances of the described field.
boolean	getFieldClassParameterDigitRequired() Gets the digitRequired parameter following the FieldClass such as Example: planetj.database.field.PasswordField,digitRequired=true **NOTE** Digit requird default to false
int	getFieldClassParameterMinLength() Gets the minLength parameter following the FieldClass such as Example: planetj.database.field.PasswordField,minLength=7
String[]	getFieldClassParameters() Gets the parameters following the Field Class Example java.text.SimpleDateFormat, MMddyyyy
String	getFieldClassString() Different from getFieldClassName in that we do not trim off the parameters.
int	getFieldDescriptorType() Gets the type of this field descriptor
String	getFieldSet() Gets the field set for the described fields.
String	getFormatterClass() Gets the class name of the formatter for the described fields.
String[]	getFormatterClassParameters() Gets the parameters following the Formatter Class Example java.text.SimpleDateFormat, MMddyyyy
String	getGetterMethod()
String	getHelpText() Gets the help text for the described fields.
int	getId() Gets the ID of this field descriptor
String	getIsNullable() Gets whether or not NULL is allowed.
Class	getJavaFieldClass() Gets the Java Class to use for instances of the described field.
int	getKeyPostion() Gets the position of the described field in the primary key of that field's table.
int	getMaxBytes() Gets the maximum number of bytes in the column for char types.
String	getName() Gets the name of the described fields.
int	getNullable() Gets whether or not NULL is allowed.
int	getOrdinalPosition() Gets the index of the column in the table (starting at 1).
short	getOrigin() Indicates how this FD was created.
int	getOwnerId() Returns the Owner Id
Field	getOwnerIdField() Returns the Owner Id Field
String	getPossibleValueClass() Returns the fully qualified name for a class implementing the IPossibleValueGetter interface which will handle the retrieving of possible values for Fields associated with this descriptor.
RowCollection	getPossibleValues(Field fld) Returns a RowCollection containing the possible values for the Field.
String	getPossibleValuesKey() Gets the possible values key.
int	getPossibleValuesSQLOperationId() Gets the id of the SQLOperation which is used to retrieve the possible values for this field descriptor
int	getRadix() Gets the column's radix.
String	getRemarks() Gets the comment describing the column (may be null)
RowCollection	getSampleFieldData() Returns a RowCollection of sample Data that relates to the field that this FD describes Creation date: (6/20/2002 11:12:15 AM)
RowCollection	getSampleTableData() Returns a RowCollection of sample Data that relates to the library and table that this FD describes Creation date: (6/20/2002 11:12:15 AM)
String	getSchema() Gets the Table's schema (may be null).
int	getSecuredTypeId() Gets the id of the secured type.
String	getSecuredTypeName() Gets the secured type name of the secured object.
int	getSecurityId() Gets the id of the security entity pertaining to the Fields this FieldDescriptorRow describes.
int	getSecurityType() Gets the security type of the Fields this FieldDescriptorRow describes.
String	getSetterMethod()
int	getSQLType() Gets the SQL type of the described fields.
String	getSQLTypeName() getSQLTypeName method comment.
int	getStatusChange() Returns whether or not we notify on a status change
String	getStyleClass() Gets the style class for this FieldDescriptor's Fields
String	getSwitches() Gets the switches, swithces is an extra field for holding special indicators which may be used for influencing how the DataEngine behaves.
String	getSystemURL() Gets the system url.
int	getUsageId() Gets the usageId of the field.
String	getXMLTag()
Class	guessFieldClass() Here is where we will take an educated guess at what the Field Class will be for this FD Row.
boolean	hasAutoPopulateOperation() This method simply tells whether or not there is a value in the PV_LV_ID column.
boolean	hasDefaultValue() Tests if Fields associated with this descriptor have a default value.
boolean	hasFormatter() Tests if a formatter class exists for the described field.
boolean	hasHelpText() Tests if help text exists for the described field.
boolean	hasPossibleValuesKeyClassOrOp() This method determines if the FD has possible values of any kind.
boolean	hasPossibleValuesSQLOperation() This method simply tells whether or not there is a value in the PV_LV_ID column.
boolean	hasUsageId() Check if this FieldDescriptorRow has a usage id.
int	insert(SQLContext context) Inserts this Row into its table.
boolean	isAssignable(Class classType) Returns true if this FDRow has a fieldClass which is equal or a subclass of classType
boolean	isAssociation() Tests if this field descriptor is an association field descriptor
boolean	isAssociationOperation() Tests if the data contained in the field described by this field descriptor is the result of an SQL operation
boolean	isAssociationSpecified() Indicates whether the column has association id specified
boolean	isAuthorizedForEdit(Row pRow, ExecutingContext pEc) Tests if user can edit a field.
boolean	isAuthorizedForRead(Row pRow, ExecutingContext pEc) Tests if user can read a field.
boolean	isAutoIncrement() Checks if this Field's value is auto incremented.
boolean	isAutoPopulate()
boolean	isAutoTrimOnRead()
boolean	isAutoTrimOnWrite()
boolean	isAutoUpdateValue() Checks if this Field has a default value.
boolean	isCaseSensitive() Returns if this column is case sensitive.
boolean	isColumnTableChanged() Tests if this field descriptor is describing a different table than it was when it was read from the DB
boolean	isCurrency() Returns if this column is currency.
boolean	isCurrent() Check this FD to see if it is the most current.
boolean	isDataSQLOperation() Deprecated. replaced with isAssociationOperation()
boolean	isDefaultValue() Deprecated. (7/14/2003 10:23:14 AM) replaced with hasDefaultValue to keep method name easier to understand and make sense
boolean	isDerived() Tests if the field described by this field descriptor is derived
boolean	isDisplayable(ExecutingContext ec) Indicates whether this column is definitely not writable.
boolean	isExistInFDFile() Return true if this FieldDescriptor exists in the Field Data file
boolean	isFileUpload()
boolean	isGetterMethodSpecified() Indicates whether the column has a getter method specified.
boolean	isGuessFieldClass() Tests if the system shoulc attempt to guess the field class for the described field when this row is inserted into the DB
boolean	isInKey() Tests if the described field is part of the primary key for its table.
boolean	isLogical() Check to see if Field this FieldDescriptor describes is logical.
boolean	isNullCapable() Indicates whether this column is null capable.
boolean	isPercentage() Returns if this column is currency.
boolean	isPhysical() Tests if this field descriptor describes a field that is physically present in the database
boolean	isPossibleValuesSearch() Tests if this field descriptor describes a field that is physically present in the database
boolean	isReadFromDBMetadata() Return true if this FieldDescriptor was read from DB metadata
boolean	isReadFromRSMetadata() Return true if this FieldDescriptor was read from RS metadata
boolean	isReadOnly() Indicates whether this column is definitely not writable.
boolean	isRequired() Returns true if this field is required
boolean	isRequiredOnSearch() Check if Field's value is required on search.
boolean	isSearchable() Indicates whether the column can be used in a where clause.
boolean	isSetterMethodSpecified() Indicates whether the column has a setter method specified.
boolean	isShared() Tests if this FD is shared
boolean	isSigned() Indicates whether values in the column are signed numbers.
boolean	isSortable() Checks if this Field's value is auto incremented.
void	setApplicationID(String pApplicationID)
void	setAssociationFieldId(int id) Sets the id of the association group field that this field belongs to.
void	setAssociationId(int id) Sets the id of the association group that this field belongs to.
void	setAutoIncrement(boolean pIsAutoIncrement) Sets wheter or not this Field's value is auto incremented.
void	setAutoTrimOnRead(boolean pAutoTrimOnRead)
void	setAutoTrimOnWrite(boolean pAutoTrimOnWrite)
void	setCaseSensitive(boolean pCaseSensitive) Sets if this column is case sensitive.
void	setCatalog(String pCatalog) Sets the Table's catalog (may be null).
void	setColumnSize(int pColumnSize) Sets the column's size.
void	setColumnTableName(String pColumnTableName) Sets the Table name.
void	setCompanyID(String pCompanyID)
void	setConcurrency(int pConcurrency) Sets the concurrency for the described fields, which determines if it is okay for concurrent update/deletes to occur.
void	setConnectionAlias(String alias) Sets the system alias.
void	setCurrency(boolean pCurrency) Sets if this column is currency.
void	setCurrent(boolean current) Set whether or not this FD is the most current.
void	setDataSQLOperationId(int value) Sets the id of the SQLOperation which is used to retrieve the data described by this field descriptor
void	setDecimalDigits(int pDecimalDigits) Sets the column's number of fractional digits.
void	setDefaultValue(String pDefaultValue) Sets the default value for the described field.
void	setDisplayComponent(int component) Sets the display component for this field.
void	setDisplayHeight(int value) Sets the Field's display height.
void	setDisplayLength(int value) Deprecated. replaced with setDisplayWidth(int) to keep consistent with what a user sees when they view the field (e.g. width and height of a field) (7/7/2003 2:26:31 PM)
void	setDisplayOrder(int value) Sets the order in which this field should be displayed.
void	setDisplayRule(int rule) Sets the display rule for this field.
void	setDisplayWidth(int value) Sets the Field's display width.
void	setDivisionID(String pDivisionID)
void	setExternalName(String pExternalName) Sets the external name of the described field.
void	setFieldClass(Class pFieldClass) Sets the class name of the formatter for the field.
void	setFieldClass(String pFieldClass) Sets the class name of the formatter for the field.
void	setFieldDescriptorType(int value) Sets the type of this field descriptor
void	setFieldSet(String value) Sets the field set for the described fields.
void	setFieldValue(String fldNam, Object value) Sets the value of the specified field.
void	setFormatterClass(String pFormatter) Sets the class name of the formatter for the field.
void	setGuessFieldClass(boolean newGuessFieldClass) Sets if the system shoulc attempt to guess the field class for the described field when this row is inserted into the DB
void	setHelpText(String pHelpText) Sets the help text for the described field.
void	setIsNullable(String pIsNullable) Sets whether or not NULL is allowed.
void	setKeyPosition(int pKeyPosition) Sets the position of the described field in the primary key of that field's table.
void	setMaxBytes(int pMaxBytes) Sets the maximum number of bytes in the column for char types.
void	setName(String pName) Sets the name of the described fields.
void	setNullable(int pNullable) Sets whether or not NULL is allowed.
void	setOrdinalPosition(int pOrdinalPosition) Sets the index of the column in the table (starting at 1).
void	setPossibleValueClass(String pPVClass) Sets the fully qualified name for a class implementing the IPossibleValueGetter interface which will handle the retrieving of possible values for Fields associated with this descriptor.
void	setPossibleValuesKey(String value) Sets the possible values key.
void	setPossibleValuesSQLOperationId(int value) Sets the id of the SQLOperation which is used to retrieve the possible values for this field descriptor
void	setRadix(int pRadix) Sets the column's radix.
void	setReadOnly(boolean pReadOnly) Sets whether this column is definitely not writable.
void	setRemarks(String pRemarks) Sets the comment describing the column (may be null)
void	setRequired(boolean required) Sets if this column allows null.
void	setSchema(String pSchema) Sets the Table's schema (may be null).
void	setSearchable(boolean pSearchable) Sets whether the column can be used in a where clause.
void	setSigned(boolean pSigned) Sets whether values in the column are signed numbers.
void	setSortable(boolean pSortable)
void	setSQLType(int pSQLType) Sets the SQL type of the described fields.
void	setSQLTypeName(String pSQLTypeName) setSQLTypeName method comment.
void	setStatusChange(int pStatusChange) Sets whether or not to notify on status change
void	setSwitches(String switches) Sets the switches, swithces is an extra field for holding special indicators which may be used for influencing how the DataEngine behaves.
void	setSystemURL(String pSystemURL) Sets the system url.
void	setTable(Table pTable) Sets the table to which this row belongs.
void	setUsageId(int usageid) Gets the usageId of the field.
void	setXMLTag(String pXMLTag)
String	toString()
Row	transferDataTo(Row pDestinationRow) Transfers all the data in this Row into a different Row.
int	update(Connection conn, ExecutingContext ec) Updates the database with the values in this Row.
boolean	validate(ExecutingContext pContext) Validate this Row based on it's configuration and field values.

Methods inherited from class planetj.database.Row

add, add, addObject, addPropertyChangeListener, addPropertyChangeListener, addRowEventListener, addRowEventListeners, addTable, appendDisplayType, batchProcess, clearFields, clearTables, clearValidationException, clone, cloneRow, commitFieldValues, commitFieldValues, commitFieldValues, concatenateFieldFullLengthValues, concatenateFieldValues, containsField, copy, copyIntoRowFieldsWithCommonFieldNames, copyIntoRowFieldsWithCommonFieldNames, copyIntoRowFieldsWithCommonUsageIds, copyIntoRowFieldsWithGivenFieldNames, copyIntoRowFieldsWithGivenFieldNames, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, defaultMerge, delete, delete, delete, delete, deleteObject, divide, duplicateKey, equals, equals, equalsInstance, executeDistributedAction, fieldHasPossibleValuesSQLOperation, getAssociation, getAssociation, getAssociationByOperationUsageId, getAssociationOperation, getAttribute, getChildren, getColumnSpan, getCompleteRow, getCompleteRow, getConfigProperty, getCopiedFieldValues, getCSVRow, getCSVRow, getDatabaseRow, getDatabaseRow, getDeleteConfirmation, getDisplayValue, getDistributedRequestorURL, getExternalName, getExternalNames, getFDFData, getFDTable, getField, getField, getField, getFieldDefaultValue, getFieldDescriptor, getFieldDescriptor, getFieldDescriptor, getFieldDescriptorsWithUsage, getFieldDescriptorsWithUsageId, getFieldDescriptorWithUsageId, getFieldDisplayValue, getFieldNames, getFields, getFields, getFieldSets, getFieldSQLObject, getFieldsToDisplay, getFieldsToDisplayStrict, getFieldsToDisplayStrict, getFieldStyleClass, getFieldValue, getFieldWithUsageId, getHeaderText, getLibraryName, getMaxFieldLengths, getMaxFieldLengths, getMaxInsertRetries, getMetaDataSystemAlias, getNamed, getNamesOfUpdatedFields, getNavigationKey, getNavigationListKey, getPercentage, getPhysicalFieldNames, getPropertyGroup, getPropertyGroups, getPropertyGroups, getRowCollection, getRowDisplayAttributes, getRowDisplayAttributes, getRowKey, getSQL, getSQLContext, getStaticAttribute, getSum, getSystemAlias, getTable, getTable, getTableName, getTables, getTimestamp, getUpdatedFields, getUserMessageForOperation, getUseWOWLibrary, getValidationExceptions, getValueAsBoolean, getValueAsByte, getValueAsDate, getValueAsDate, getValueAsDouble, getValueAsDouble, getValueAsFloat, getValueAsFullLengthString, getValueAsInt, getValueAsLong, getValueAsNumber, getValueAsNumber, getValueAsShort, getValueAsString, getValueAsString, getValueByUsageId, getValues, getXMLData, getXMLData, getXMLHeaderData, handleDistributed, hasChildRows, hasMultipleStyleClasses, hasPropertyChangeListeners, insert, insert, insert, is, isARow, isARowCollection, isChanged, isChangedRealTime, isChangedSinceLastCheck, isCloneNeeded, isContainsAllFields, isCopyable, isDeletable, isDistinctRow, isDistributed, isEditable, isEmpty, isFieldApplicable, isFieldAuthorizedForEdit, isFieldAuthorizedForRead, isFieldDisplayable, isFieldReadOnly, isFieldRequired, isFieldRequiredOnSearch, isFieldsChanged, isFieldValueNotBlank, isFieldValuesDatabaseDefaults, isGenerateChildRows, isGroupByRow, isGuarded, isHasColumnNames, isInARowCollection, isIncrementorResetAfterMaxInsertRetries, isInitializeDerivedFieldsEnabled, isJoinedRow, isKeyFieldsPresent, isLogicalRow, isMultipleDeleteEnabled, isPhysicalRow, isPropertyChangeEventsEnabled, isReturningFromPossibleValuesSearch, isRowKeyed, isSelectable, isUnionRow, isValidateRequired, isValidationRequiredForAutoPopulate, isViewable, iterator, merge, newField, newField, newField, newField, populate, postCreate, prepareForDetails, prepareFromFieldNames, removeNavigationKey, removePropertyChangeListener, removePropertyChangeListener, removeRowEventListener, removeRowEventListeners, replaceField, replaceFieldValues, rollbackChanges, setAttribute, setDistributed, setDistributedRequestorURL, setDistributedTargetURL, setFieldInitialValue, setFieldValue, setFieldValue, setFieldValueAsString, setFieldValueAsString, setFieldValuesAsDate, setFieldValuesToDefault, setFieldValuesWithCommonFieldNames, setFieldValuesWithCommonFieldNames, setFieldValuesWithCommonUsageIds, setFieldValueToDefault, setMultipleDeleteEnabled, setNavigationKey, setPropertyChangeEventsEnabled, setPropertyGroups, setReturningFromPossibleValuesSearch, setSavepoint, setSavepoint, setSavepoint, setStaticAttribute, setTables, setTables, setUseWOWLibrary, setValidateRequired, setValues, size, splitAndSetFieldValues, statusChanged, toCSV, toDOC, toDOC, toFDF, toPDF, toPDF, toString, toUpperCase, toXML, transferDataTo, update, update, update, updateObject, validate, validate, validateRowOperation

Methods inherited from class java.lang.Object

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

Constructor Detail

FieldDescriptorRow

public FieldDescriptorRow()

Method Detail

cloneFD

public FieldDescriptorRow cloneFD()
                           throws CMException

Clones this FieldDescriptorRow.

CMException

createDefaultField

public Field createDefaultField()
                         throws CMException

Creates a default field for this field descriptor. Works for both logical and physical field descriptors. This method ignores the specified field class.

CMException

createDefaultField

public Field createDefaultField(String pFieldName)
                         throws CMException

Creates a default field for this field descriptor. Works for both logical and physical field descriptors. This method ignores the specified field class.

CMException

createField

public Field createField()
                  throws CMException

Creates a new field of the appropriate type

CMException

getDeleteConfirmationMessage

public String getDeleteConfirmationMessage()

Description copied from class: Row

Get the delete confirmation message.

Overrides:

getDeleteConfirmationMessage in class Row

createField

public Field createField(String pFieldName)
                  throws CMException

Creates a new field of the appropriate type

CMException

createRow

public Row createRow(Row pDefaultRow)
              throws CMException

Creates a new Row. Information from the database is read into a default Row by the DataEngine; this method is then invoked to get a Row of the correct type based on the information in the default Row. Typically the data in the Row is examined by this method, a Row of the appropriate type is created, and then the transferDataTo() method is used to move the data from the default Row to the newly created Row. Override this method if the type of Row to add needs to be dynamically determined from the retrieved data.

Specified by:

createRow in interface IRowCreator

Overrides:

createRow in class Row

Parameters:

pDefaultRow - A Row containing data read from the database (it will always be equal to this)

Returns:

A Row which the DataEngine will add to a RowCollection

CMException

getApplicationID

public String getApplicationID()

getAssociationFieldId

public int getAssociationFieldId()

Gets the id of the association group field that this field belongs to. Rows can be associated by sharing AssociationIds and AssociationFieldIDs See the documentaiton since it's pretty complicated especially for you.

getAssociationId

public int getAssociationId()

Gets the id of the association group that this field belongs to. Rows can be associated by sharing AssociationIds and AssociationFieldIDs See the documentaiton since it's pretty complicated especially for you.

getAssociationOperation

public Operation getAssociationOperation()
                                  throws CMException

Gets the SQLOperation describing how the data for fields should be retrieved

CMException

getAssociationOperationId

public int getAssociationOperationId()

Gets the id of the SQLOperation which is used to retrieve the data described by this field descriptor

getAutoUpdateStringValue

public String getAutoUpdateStringValue(ExecutingContext pEc)

Gets the auto update String parameter for the described fields.

getAutoUpdateValue

public String getAutoUpdateValue()

Gets the default value for the described fields.

getCatalog

public String getCatalog()

Gets the Table's catalog (may be null).

getColumnName

public String getColumnName()

Gets the Column name.

getColumnSize

public int getColumnSize()

Gets the column's size. For char or date types this is the maximum number of characters, for numberic or decimal types this is precision.

getColumnSystem

public DBSystem getColumnSystem()

Gets the table that this field descriptor is in.

getColumnTable

public Table getColumnTable()

Returns the table that this field descriptor is in. Creation date: (5/10/2002 11:56:07 AM)

getColumnTable

public Table getColumnTable(boolean oldValue)

Returns the table that this field descriptor is in.

Parameters:

oldValue - If this is true, then the "old" table is returned Creation date: (5/10/2002 11:56:07 AM)

getColumnTableName

public String getColumnTableName()

Gets the Table name.

getCompanyID

public String getCompanyID()

getConcurrency

public int getConcurrency()

Gets the concurrency for the described field,, which determines if it is okay for concurrent update/deletes to occur. The concurrency constants are defined in FieldDescriptorRow.

getConnectionAlias

public String getConnectionAlias()

Gets the system alias.

getDataSQLOperation

public SQLOperation getDataSQLOperation()
                                 throws CMException

Deprecated. replaced with getAssociationOperation()

Gets the SQLOperation describing how the data for fields should be retrieved

CMException

getDataSQLOperationId

public int getDataSQLOperationId()

Deprecated. replaced with getAssociationID()

Gets the id of the SQLOperation which is used to retrieve the data described by this field descriptor

getDataType

public short getDataType()

The returned value can be compated to values in java.sql.Types Creation date: (6/20/2002 1:28:30 PM)

See Also:

Types

getDecimalDigits

public short getDecimalDigits()

Gets the column's number of fractional digits. (Scale)

getDefaultStringValue

public String getDefaultStringValue(ExecutingContext pEc)

Return the string parameter specified as the default value. The parameter might be the actual default value or a keyword such as *CURRENT. The parameter might also be special text that helps to derive the value for the default - ???field

getDefaultValue

public String getDefaultValue()

Return the string parameter specified as the default value.

getDisplayComponent

public int getDisplayComponent()

Gets the display component for this field.

getDisplayHeight

public int getDisplayHeight()

Gets the Field's display height. This only controls the number of rows in the text field that will be displayed, or the size of the select. It does not restrict the amount of characters that can be entered for a Field's value. If no display height is specified then return -1.

Returns:

display height of for Field

getDisplayLength

public int getDisplayLength()

Deprecated. replaced with getDisplayWidth() to keep consistent with what a user sees when they view the field (e.g. width and height of a field)

Gets the column's display size. This only controls the number of columns in the text field that will be displayed. It does not restrict the amount of characters that can be entered. If no display size is specified then return -1. Creation date: (4/10/2003 6:47:34 PM)

getDisplayOrder

public int getDisplayOrder()

Gets the order in which this field should be displayed. Smaller numbers get displayed before larger ones.

getDisplayRule

public int getDisplayRule()

Gets the display rule for this field.

getDisplayWidth

public int getDisplayWidth()

Gets the Field's display width. This only controls the number of columns in the text field that will be displayed. It does not restrict the amount of characters that can be entered for a Field's value. If no display size is specified then return -1.

Returns:

display width of for Field

getDivisionID

public String getDivisionID()

getExternalName

public String getExternalName()

Sets the external name of the described fields. This is the name that the user sees.

getFieldClass

public String getFieldClass()
                     throws CMException

Deprecated. Use getFieldClassName() instead

Gets the name of the Java Class to use for instances of the described field. See getJavaFieldClass() for more information.

CMException

getFieldClassName

public String getFieldClassName()
                         throws CMException

Gets the name of the Java Class to use for instances of the described field. See getJavaFieldClass() for more information.

CMException

getFieldClassParameters

public String[] getFieldClassParameters()

Gets the parameters following the Field Class Example java.text.SimpleDateFormat, MMddyyyy

Returns:

String[], null if no parameters are specified.

getFieldClassString

public String getFieldClassString()
                           throws CMException

Different from getFieldClassName in that we do not trim off the parameters. This gives us the actual value in the FieldDescriptor table for Field Class.

CMException

getFieldDescriptorType

public int getFieldDescriptorType()

Gets the type of this field descriptor

getFieldSet

public String getFieldSet()

Gets the field set for the described fields. The field set is a label which groups fields together for display purposes

getFormatterClass

public String getFormatterClass()

Gets the class name of the formatter for the described fields.

getFormatterClassParameters

public String[] getFormatterClassParameters()

Gets the parameters following the Formatter Class Example java.text.SimpleDateFormat, MMddyyyy

Returns:

String[], null if no parameters are specified.

getGetterMethod

public String getGetterMethod()

getHelpText

public String getHelpText()

Gets the help text for the described fields.

getId

public int getId()

Gets the ID of this field descriptor

getIsNullable

public String getIsNullable()

Gets whether or not NULL is allowed. "NO" means column definitely does not allow NULL values; "YES" means the column might allow NULL values. An empty string means nobody knows.

getJavaFieldClass

public Class getJavaFieldClass()
                        throws CMException

Gets the Java Class to use for instances of the described field. If this class name has been specified, in the FD then it is used to create the Class instance. If the class name is not specified in the FD then it is determined from the SQL data type.

This method is a replacement for the old getFieldClass() method which calculated the field class each time. Now it's calculated once and cached.

Returns:

The Class object which should be used to instantiate a field for this FD. Null may be returned if no appropriat Class can be determined.

Throws:

CMException - If a class name was entered, but does not correspond to a Java class

getKeyPostion

public int getKeyPostion()

Gets the position of the described field in the primary key of that field's table. The first field in a primary key has a key position of 1. If the field for this descriptor is not part of the primary key a value less than 1 is returned.

getMaxBytes

public int getMaxBytes()

Gets the maximum number of bytes in the column for char types.

getName

public String getName()

Gets the name of the described fields. This is the database name of the field.

getNullable

public int getNullable()

Gets whether or not NULL is allowed.

getOrdinalPosition

public int getOrdinalPosition()

Gets the index of the column in the table (starting at 1).

getOrigin

public short getOrigin()

Indicates how this FD was created. Possible values are ORIGIN_RS_METADATA, ORIGIN_DB_METADATA, and ORIGIN_FIELDDATA_FILE. It is possible for an FD to be promoted - if it has first been read from RS or DB metadata and is later read from the fielddata file, its origin will be altered to specify the fielddata file. If it has first been read from RS metadata and is later read from DB metadata it will also be promoted. A FD cannot be demoted - if it has been read from the fielddata file and then is read again from DB metadata, the newly read FD is discarded, and the old one read from the fielddata file is retained.

getOwnerId

public int getOwnerId()

Returns the Owner Id

See Also:

IOwner

getOwnerIdField

public Field getOwnerIdField()

Returns the Owner Id Field

Specified by:

getOwnerIdField in interface IOwner

Returns:

planetj.database.Field

See Also:

IOwner

getPossibleValueClass

public String getPossibleValueClass()

Returns the fully qualified name for a class implementing the IPossibleValueGetter interface which will handle the retrieving of possible values for Fields associated with this descriptor.

Returns:

String

getPossibleValues

public RowCollection getPossibleValues(Field fld)
                                throws CMException

Returns a RowCollection containing the possible values for the Field.

Parameters:

fld - Field

Returns:

RowCollection

CMException

getPossibleValuesKey

public String getPossibleValuesKey()

Gets the possible values key. This is the key which field descriptors that use the default possible values retrieval method will use to look up possible values in the possible values table.

getPossibleValuesSQLOperationId

public int getPossibleValuesSQLOperationId()

Gets the id of the SQLOperation which is used to retrieve the possible values for this field descriptor

getRadix

public int getRadix()

Gets the column's radix.

getRemarks

public String getRemarks()

Gets the comment describing the column (may be null)

getSampleFieldData

public RowCollection getSampleFieldData()

Returns a RowCollection of sample Data that relates to the field that this FD describes Creation date: (6/20/2002 11:12:15 AM)

getSampleTableData

public RowCollection getSampleTableData()

Returns a RowCollection of sample Data that relates to the library and table that this FD describes Creation date: (6/20/2002 11:12:15 AM)

getSchema

public String getSchema()

Gets the Table's schema (may be null).

getSecuredTypeId

public int getSecuredTypeId()

Gets the id of the secured type.

Specified by:

getSecuredTypeId in interface IGuarded

Overrides:

getSecuredTypeId in class Row

getSecuredTypeName

public String getSecuredTypeName()

Gets the secured type name of the secured object.

Specified by:

getSecuredTypeName in interface IGuarded

Overrides:

getSecuredTypeName in class Row

getSecurityId

public int getSecurityId()

Gets the id of the security entity pertaining to the Fields this FieldDescriptorRow describes.

getSecurityType

public int getSecurityType()

Gets the security type of the Fields this FieldDescriptorRow describes.

Specified by:

getSecurityType in interface IGuarded

Overrides:

getSecurityType in class Row

Returns:

security type

getSetterMethod

public String getSetterMethod()

getSQLType

public int getSQLType()

Gets the SQL type of the described fields. SQL types are defined in java.sql.Types

getSQLTypeName

public String getSQLTypeName()

getSQLTypeName method comment.

getStatusChange

public int getStatusChange()

Returns whether or not we notify on a status change

getStyleClass

public String getStyleClass()

Gets the style class for this FieldDescriptor's Fields

getSwitches

public String getSwitches()

Gets the switches, swithces is an extra field for holding special indicators which may be used for influencing how the DataEngine behaves.

getSystemURL

public String getSystemURL()

Gets the system url.

getUsageId

public int getUsageId()

Gets the usageId of the field. A FieldDescriptor can be assigned a usageId to identify a particular usage. This can be used by powerful method to dynamically copy data with the same usageId. UI code can be written to look for fields with a particular usageId such as an electronic store where JSPs might anticipate a RowCollection coming in with usage fields for ItemId, ItemImage, Item Price, etc. It is the ultimate decoupling of UI, business logic, and Data See the documentaiton since it's pretty complicated especially for you.

getXMLTag

public String getXMLTag()

guessFieldClass

public Class guessFieldClass()

Here is where we will take an educated guess at what the Field Class will be for this FD Row. If we cannot be sure of the field class, we will return null indicating we found no definite. Creation date: (6/19/2002 12:31:41 PM)

hasAutoPopulateOperation

public boolean hasAutoPopulateOperation()

This method simply tells whether or not there is a value in the PV_LV_ID column. However, this column is used for all kinds of operations. So this method does not tell whether or not it is a valid AutoPopulate operation. In order to tell this, you must check isAutoPopulate Creation date: (2/6/2003 3:50:48 PM)

Returns:

boolean

hasDefaultValue

public boolean hasDefaultValue()

Tests if Fields associated with this descriptor have a default value.

Returns:

true if Field's have a default value; false otherwise

hasFormatter

public boolean hasFormatter()

Tests if a formatter class exists for the described field.

hasHelpText

public boolean hasHelpText()

Tests if help text exists for the described field.

hasPossibleValuesKeyClassOrOp

public boolean hasPossibleValuesKeyClassOrOp()

This method determines if the FD has possible values of any kind. Creation date: (4/29/2003 10:47:45 PM)

Returns:

boolean

hasPossibleValuesSQLOperation

public boolean hasPossibleValuesSQLOperation()

This method simply tells whether or not there is a value in the PV_LV_ID column. However, this column is used both for PossibleValues and for PossibleValuesSearch, so this method does not tell whether or not it is a valid PossibleValuesSearch operation. In order to tell this, you must check isPossibleValuesSearch Creation date: (2/6/2003 3:50:48 PM)

Returns:

boolean

hasUsageId

public boolean hasUsageId()

Check if this FieldDescriptorRow has a usage id.

Returns:

true if this FieldDescriptorRow has a usage id

insert

public int insert(SQLContext context)
           throws CMException

Inserts this Row into its table.

Overrides:

insert in class Row

Returns:

The number of Rows that were inserted

CMException

isAssignable

public boolean isAssignable(Class classType)

Returns true if this FDRow has a fieldClass which is equal or a subclass of classType

isAssociation

public boolean isAssociation()

Tests if this field descriptor is an association field descriptor

isAssociationOperation

public boolean isAssociationOperation()

Tests if the data contained in the field described by this field descriptor is the result of an SQL operation

isAssociationSpecified

public boolean isAssociationSpecified()

Indicates whether the column has association id specified

isAuthorizedForEdit

public boolean isAuthorizedForEdit(Row pRow,
                                   ExecutingContext pEc)
                            throws CMException

Tests if user can edit a field.

CMException

isAuthorizedForRead

public boolean isAuthorizedForRead(Row pRow,
                                   ExecutingContext pEc)
                            throws CMException

Tests if user can read a field.

CMException

isAutoIncrement

public boolean isAutoIncrement()

Checks if this Field's value is auto incremented.

isAutoPopulate

public boolean isAutoPopulate()

isAutoTrimOnRead

public boolean isAutoTrimOnRead()

isAutoTrimOnWrite

public boolean isAutoTrimOnWrite()

isAutoUpdateValue

public boolean isAutoUpdateValue()

Checks if this Field has a default value.

isCaseSensitive

public boolean isCaseSensitive()

Returns if this column is case sensitive.

isColumnTableChanged

public boolean isColumnTableChanged()

Tests if this field descriptor is describing a different table than it was when it was read from the DB

isCurrency

public boolean isCurrency()

Returns if this column is currency.

isCurrent

public boolean isCurrent()

Check this FD to see if it is the most current.

isDataSQLOperation

public boolean isDataSQLOperation()

Deprecated. replaced with isAssociationOperation()

Tests if the data contained in the field described by this field descriptor is the result of an SQL operation

isDefaultValue

public boolean isDefaultValue()

Deprecated. (7/14/2003 10:23:14 AM) replaced with hasDefaultValue to keep method name easier to understand and make sense

Checks if this Field has a default value.

isDerived

public boolean isDerived()

Tests if the field described by this field descriptor is derived

isDisplayable

public boolean isDisplayable(ExecutingContext ec)

Indicates whether this column is definitely not writable.

isExistInFDFile

public boolean isExistInFDFile()

Return true if this FieldDescriptor exists in the Field Data file

isFileUpload

public boolean isFileUpload()

isGetterMethodSpecified

public boolean isGetterMethodSpecified()

Indicates whether the column has a getter method specified. A getter method can be used for derived fields via reflection to specify a method to run to get the derived field values.

isGuessFieldClass

public boolean isGuessFieldClass()

Tests if the system shoulc attempt to guess the field class for the described field when this row is inserted into the DB

isInKey

public boolean isInKey()

Tests if the described field is part of the primary key for its table.

isLogical

public boolean isLogical()

Check to see if Field this FieldDescriptor describes is logical. Seeing if it does not physically present in the database.

isNullCapable

public boolean isNullCapable()

Indicates whether this column is null capable.

isPercentage

public boolean isPercentage()

Returns if this column is currency.

isPhysical

public boolean isPhysical()

Tests if this field descriptor describes a field that is physically present in the database

isPossibleValuesSearch

public boolean isPossibleValuesSearch()

Tests if this field descriptor describes a field that is physically present in the database

isReadFromDBMetadata

public boolean isReadFromDBMetadata()

Return true if this FieldDescriptor was read from DB metadata

isReadFromRSMetadata

public boolean isReadFromRSMetadata()

Return true if this FieldDescriptor was read from RS metadata

isReadOnly

public boolean isReadOnly()

Indicates whether this column is definitely not writable.

isRequired

public boolean isRequired()

Returns true if this field is required

Returns:

boolean

isRequiredOnSearch

public boolean isRequiredOnSearch()

Check if Field's value is required on search.

isSearchable

public boolean isSearchable()

Indicates whether the column can be used in a where clause.

isSetterMethodSpecified

public boolean isSetterMethodSpecified()

Indicates whether the column has a setter method specified. A setter method can be used for derived fields via reflection to specify a method to run to set the derived field values.

isShared

public boolean isShared()

Tests if this FD is shared

isSigned

public boolean isSigned()

Indicates whether values in the column are signed numbers.

isSortable

public boolean isSortable()

Checks if this Field's value is auto incremented.

setApplicationID

public void setApplicationID(String pApplicationID)
                      throws CMException

CMException

setAssociationFieldId

public void setAssociationFieldId(int id)

Sets the id of the association group field that this field belongs to. Rows can be associated by sharing AssociationIds and AssociationFieldIDs See the documentaiton since it's pretty complicated especially for you.

setAssociationId

public void setAssociationId(int id)

Sets the id of the association group that this field belongs to. Rows can be associated by sharing AssociationIds and AssociationFieldIDs See the documentaiton since it's pretty complicated especially for you.

setAutoIncrement

public void setAutoIncrement(boolean pIsAutoIncrement)
                      throws CMException

Sets wheter or not this Field's value is auto incremented.

CMException

setAutoTrimOnRead

public void setAutoTrimOnRead(boolean pAutoTrimOnRead)
                       throws CMException

CMException

setAutoTrimOnWrite

public void setAutoTrimOnWrite(boolean pAutoTrimOnWrite)
                        throws CMException

CMException

setCaseSensitive

public void setCaseSensitive(boolean pCaseSensitive)
                      throws CMException

Sets if this column is case sensitive.

CMException

setCatalog

public void setCatalog(String pCatalog)
                throws CMException

Sets the Table's catalog (may be null).

CMException

setColumnSize

public void setColumnSize(int pColumnSize)
                   throws CMException

Sets the column's size. For char or date types this is the maximum number of characters, for numberic or decimal types this is precision.

CMException

setColumnTableName

public void setColumnTableName(String pColumnTableName)
                        throws CMException

Sets the Table name.

CMException

setCompanyID

public void setCompanyID(String pCompanyID)
                  throws CMException

CMException

setConcurrency

public void setConcurrency(int pConcurrency)
                    throws CMException

Sets the concurrency for the described fields, which determines if it is okay for concurrent update/deletes to occur. The concurrency constants are defined in FieldDescriptorRow.

CMException

setConnectionAlias

public void setConnectionAlias(String alias)
                        throws CMException

Sets the system alias.

CMException

setCurrency

public void setCurrency(boolean pCurrency)
                 throws CMException

Sets if this column is currency.

CMException

setCurrent

public void setCurrent(boolean current)

Set whether or not this FD is the most current.

setDataSQLOperationId

public void setDataSQLOperationId(int value)
                           throws CMException

Sets the id of the SQLOperation which is used to retrieve the data described by this field descriptor

CMException

setDecimalDigits

public void setDecimalDigits(int pDecimalDigits)
                      throws CMException

Sets the column's number of fractional digits. (Scale)

CMException

setDefaultValue

public void setDefaultValue(String pDefaultValue)
                     throws CMException

Sets the default value for the described field.

CMException

setDisplayComponent

public void setDisplayComponent(int component)
                         throws CMException

Sets the display component for this field.

CMException

setDisplayHeight

public void setDisplayHeight(int value)
                      throws CMException

Sets the Field's display height. This only controls the number of rows in the text field that will be displayed, or the size of the select. It does not restrict the amount of characters that can be entered for a Field's value.

Parameters:

value - display height for the Field

CMException

setDisplayLength

public void setDisplayLength(int value)
                      throws CMException

Deprecated. replaced with setDisplayWidth(int) to keep consistent with what a user sees when they view the field (e.g. width and height of a field) (7/7/2003 2:26:31 PM)

Sets the length this field should be displayed.

CMException

setDisplayOrder

public void setDisplayOrder(int value)
                     throws CMException

Sets the order in which this field should be displayed. Smaller numbers get displayed before larger ones.

CMException

setDisplayRule

public void setDisplayRule(int rule)
                    throws CMException

Sets the display rule for this field.

CMException

setDisplayWidth

public void setDisplayWidth(int value)
                     throws CMException

Sets the Field's display width. This only controls the number of columns in the text field that will be displayed. It does not restrict the amount of characters that can be entered for a Field's value.

Parameters:

value - display width for the Field

CMException

setDivisionID

public void setDivisionID(String pDivisionID)
                   throws CMException

CMException

setExternalName

public void setExternalName(String pExternalName)
                     throws CMException

Sets the external name of the described field. This is the name that the user sees.

CMException

setFieldClass

public void setFieldClass(Class pFieldClass)
                   throws CMException

Sets the class name of the formatter for the field.

CMException

setFieldClass

public void setFieldClass(String pFieldClass)
                   throws CMException

Sets the class name of the formatter for the field.

CMException

setFieldDescriptorType

public void setFieldDescriptorType(int value)
                            throws CMException

Sets the type of this field descriptor

CMException

setFieldSet

public void setFieldSet(String value)
                 throws CMException

Sets the field set for the described fields. The field set is a label which groups fields together for display purposes

CMException

setFieldValue

public void setFieldValue(String fldNam,
                          Object value)
                   throws CMException

Sets the value of the specified field.

Overrides:

setFieldValue in class Row

Parameters:

fldNam - The name of the field to set. If no such field exists in this Row, a skeleton field will be created to hold the value, and added to this row.

value - The value to set the field to.

CMException

setFormatterClass

public void setFormatterClass(String pFormatter)
                       throws CMException

Sets the class name of the formatter for the field.

CMException

setGuessFieldClass

public void setGuessFieldClass(boolean newGuessFieldClass)

Sets if the system shoulc attempt to guess the field class for the described field when this row is inserted into the DB

setHelpText

public void setHelpText(String pHelpText)
                 throws CMException

Sets the help text for the described field.

CMException

setIsNullable

public void setIsNullable(String pIsNullable)
                   throws CMException

Sets whether or not NULL is allowed. "NO" means column definitely does not allow NULL values; "YES" means the column might allow NULL values. An empty string means nobody knows. Defaults to ResultSetMetaData.columnNullableUnknown

CMException

setKeyPosition

public void setKeyPosition(int pKeyPosition)
                    throws CMException

Sets the position of the described field in the primary key of that field's table. The first field in a primary key has a key position of 1.

CMException

setMaxBytes

public void setMaxBytes(int pMaxBytes)
                 throws CMException

Sets the maximum number of bytes in the column for char types.

CMException

setName

public void setName(String pName)
             throws CMException

Sets the name of the described fields. This is the database name of the field.

CMException

setNullable

public void setNullable(int pNullable)
                 throws CMException

Sets whether or not NULL is allowed.

CMException

setOrdinalPosition

public void setOrdinalPosition(int pOrdinalPosition)
                        throws CMException

Sets the index of the column in the table (starting at 1).

CMException

setPossibleValueClass

public void setPossibleValueClass(String pPVClass)
                           throws CMException

Sets the fully qualified name for a class implementing the IPossibleValueGetter interface which will handle the retrieving of possible values for Fields associated with this descriptor.

Returns:

String

CMException

setPossibleValuesKey

public void setPossibleValuesKey(String value)
                          throws CMException

Sets the possible values key. This is the key which field descriptors that use the default possible values retrieval method will use to look up possible values in the possible values table.

CMException

setPossibleValuesSQLOperationId

public void setPossibleValuesSQLOperationId(int value)
                                     throws CMException

Sets the id of the SQLOperation which is used to retrieve the possible values for this field descriptor

CMException

setRadix

public void setRadix(int pRadix)
              throws CMException

Sets the column's radix.

CMException

setReadOnly

public void setReadOnly(boolean pReadOnly)
                 throws CMException

Sets whether this column is definitely not writable.

CMException

setRemarks

public void setRemarks(String pRemarks)
                throws CMException

Sets the comment describing the column (may be null)

CMException

setRequired

public void setRequired(boolean required)
                 throws CMException

Sets if this column allows null. Checks the Nullablity of the column and returns a Boolean object or null if unknown. WK++ (6/18/2002 4:54:28 PM) heavy bugs caused by this method

CMException

setSchema

public void setSchema(String pSchema)
               throws CMException

Sets the Table's schema (may be null).

CMException

setSearchable

public void setSearchable(boolean pSearchable)
                   throws CMException

Sets whether the column can be used in a where clause.

CMException

setSigned

public void setSigned(boolean pSigned)
               throws CMException

Sets whether values in the column are signed numbers.

CMException

setSortable

public void setSortable(boolean pSortable)
                 throws CMException

CMException

setSQLType

public void setSQLType(int pSQLType)
                throws CMException

Sets the SQL type of the described fields. SQL types are defined in java.sql.Types

CMException

setSQLTypeName

public void setSQLTypeName(String pSQLTypeName)
                    throws CMException

setSQLTypeName method comment.

CMException

setStatusChange

public void setStatusChange(int pStatusChange)
                     throws CMException

Sets whether or not to notify on status change

CMException

setSwitches

public void setSwitches(String switches)
                 throws CMException

Sets the switches, swithces is an extra field for holding special indicators which may be used for influencing how the DataEngine behaves.

CMException

setSystemURL

public void setSystemURL(String pSystemURL)
                  throws CMException

Sets the system url.

CMException

setTable

public void setTable(Table pTable)

Sets the table to which this row belongs.

setUsageId

public void setUsageId(int usageid)
                throws CMException

Gets the usageId of the field. A FieldDescriptor can be assigned a usageId to identify a particular usage. This can be used by powerful method to dynamically copy data with the same usageId. UI code can be written to look for fields with a particular usageId such as an electronic store where JSPs might anticipate a RowCollection coming in with usage fields for ItemId, ItemImage, Item Price, etc. It is the ultimate decoupling of UI, business logic, and Data See the documentaiton since it's pretty complicated especially for you.

CMException

setXMLTag

public void setXMLTag(String pXMLTag)
               throws CMException

CMException

toString

public String toString()

Overrides:

toString in class Object

transferDataTo

public Row transferDataTo(Row pDestinationRow)
                   throws DataEngineException

Transfers all the data in this Row into a different Row. If this Row is part of one or more RowCollections, it is replaced in those RowCollections with the destination Row. This row will no longer contain any information after this method completes; any further operations involving this Row will fail or behave in unexpected ways. Note that property change listeners are removed from this Row, but are NOT transferred to the destination Row.

Overrides:

transferDataTo in class Row

Parameters:

pDestinationRow - The Row to copy the data to.

Returns:

The destination Row, containing the data from this Row.

DataEngineException

update

public int update(Connection conn,
                  ExecutingContext ec)
           throws CMException

Description copied from class: Row

Updates the database with the values in this Row. If concurrent alterations to the database prevent this row from being updated, a ConcurrentAlterationException is thrown.

Overrides:

update in class Row

Returns:

The number of updated rows

CMException

validate

public boolean validate(ExecutingContext pContext)
                 throws CMException

Description copied from class: Row

Validate this Row based on it's configuration and field values.

Overrides:

validate in class Row

Returns:

true, if Row and Fields are valid; false otherwise.

CMException

getFieldClassParameterDigitRequired

public boolean getFieldClassParameterDigitRequired()

Gets the digitRequired parameter following the FieldClass such as Example: planetj.database.field.PasswordField,digitRequired=true **NOTE** Digit requird default to false

Returns:

boolean; true if digitRequired=true set as a FC parameter

getFieldClassParameterMinLength

public int getFieldClassParameterMinLength()

Gets the minLength parameter following the FieldClass such as Example: planetj.database.field.PasswordField,minLength=7

Returns:

int; -1 if no minLength is set