FieldDescriptorRow

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

planetj.database.fielddescriptors
Class FieldDescriptorRow

java.lang.Object
  planetj.database.Row
      planetj.database.fielddescriptors.FieldDescriptorRow

All Implemented Interfaces:: java.lang.Cloneable, IActionObject, IBatchProcessObject, IBusinessObject, ICSVRow, IFDFObject, IFieldData, IGuarded, INamedCollection, INavigationObject, IOwner, IRowCreator, IXMLObject, java.io.Serializable

Direct Known Subclasses:: AbstractDerivedFieldDescriptor, DerivedFieldDescriptor, TableDescriptor

public class FieldDescriptorRow
extends Row
implements IFieldData, java.io.Serializable, IOwner

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

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, DISPLAY_ORDER_COMPARATOR, MODE_ALTER, MODE_COPY, MODE_DELETE, MODE_INSERT, MODE_READ, MODE_SEARCH, MODE_UNKNOWN, MODE_UPDATE, mRowEventListeners

Fields inherited from interface planetj.database.fielddescriptors.IFieldData

APPLICATION_ID, ASSOCIATION_FIELD_ID, ASSOCIATION_ID, AUTHORIZE_EDIT_OPERATION, AUTHORIZE_READ_OPERATION, AUTO_INCREMENT_DATABASE_DRIVEN, AUTO_INCREMENT_NO, AUTO_INCREMENT_WOW_DRIVEN, 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_RADIO_BUTTON_PV, 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_COMPONENT_TEXT_FIELD, 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, FDPV_DEFAULT_VALUE, 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
`protected java.lang.Class`	`calculateFieldClass()` Gets the class to instantiate for this field.
`void`	`clearJavaFieldClass()` Clears the Java Class that is used for instances of the described field.
`FieldDescriptorRow`	`cloneFD()` Clones this FieldDescriptorRow.
`Row`	`copy(boolean pFullCopy)` Copy this Row.
`Field`	`createDefaultField()` Creates a default field for this field descriptor.
`Field`	`createDefaultField(java.lang.String pFieldName)` Creates a default field for this field descriptor.
`Field`	`createField()` Creates a new field of the appropriate type
`Field`	`createField(java.lang.String pFieldName)` Creates a new field of the appropriate type
`Field`	`createField(java.lang.String pFieldName, java.lang.Class fieldClass)` Creates a new field of the specified type
`Row`	`createRow(Row pDefaultRow)` Creates a new Row.
`protected SQLContext`	`createSQLContextForUpdate(ExecutingContext ec)` Creates a new SQLContext which will be used for updating this row.
`boolean`	`duplicateKey(int retriesLeft, ExecutingContext ec)` Method called when a duplicate key is encountered attempting to insert this Row.
`java.lang.String`	`getApplicationID()`
`int`	`getAssociationFieldId()` Deprecated. old way of specifing associations
`int`	`getAssociationId()` Deprecated. used by old way of getting associations
`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
`java.lang.String`	`getAutoUpdateStringValue(ExecutingContext pEc)` Deprecated. should also pass Field object to allow for ?? parameters
`java.lang.String`	`getAutoUpdateStringValue(Field field, ExecutingContext pEc)` Gets the auto update String parameter for the described fields.
`java.lang.String`	`getAutoUpdateValue()` Gets the default value for the described fields.
`java.lang.String`	`getCatalog()` Gets the Table's catalog (may be null).
`java.lang.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.
`java.lang.String`	`getColumnTableName()` Gets the Table name.
`java.lang.String`	`getCompanyID()`
`int`	`getConcurrency()` Gets the concurrency for the described field,, which determines if it is okay for concurrent update/deletes to occur.
`java.lang.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()` Deprecated. replaced with getScale() which returns -1 if FD doesn't have a scale (decimal digits) versus this method which returns 0
`java.lang.String`	`getDefaultStringValue(ExecutingContext pEc)` Deprecated. actual Field getting value for should be passed as well
`java.lang.String`	`getDefaultStringValue(Field field, ExecutingContext pEc)` Get the string parameter specified as the default value.
`java.lang.String`	`getDefaultValue()` Return the string parameter specified as the default value.
`java.lang.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.
`java.lang.String`	`getDivisionID()`
`java.lang.String`	`getExternalName()` Sets the external name of the described fields.
`java.lang.String`	`getFieldClass()` Deprecated. Use getFieldClassName() instead
`java.lang.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
`java.lang.String[]`	`getFieldClassParameters()` Gets the parameters following the Field Class Example java.text.SimpleDateFormat, MMddyyyy
`java.lang.String`	`getFieldClassString()` Different from getFieldClassName in that we do not trim off the parameters.
`static java.lang.Class`	`getFieldDescriptorClass(int fdType)` Gets the FieldDescriptor java class which should be used to represent an FD of the specified type
`java.lang.String`	`getFieldDescriptorSource()` Convience method used to return a string containing the fields name, connection alias, library name, and table name.
`int`	`getFieldDescriptorType()` Gets the type of this field descriptor
`int`	`getFieldDisplayOrder(Field field)` Gets the order of which the given Field will appear in its FieldSet
`java.lang.String`	`getFieldFieldSetName(Field field)` Gets the name of the given Field's FieldSet NOTE: This method will not get called unless you override the isUseRowForFieldSets method to return true.
`java.lang.String`	`getFieldSet()` Gets the field set for the described fields.
`java.lang.String`	`getFormatterClass()` Gets the class name of the formatter for the described fields.
`java.lang.String[]`	`getFormatterClassParameters()` Gets the parameters following the Formatter Class Example java.text.SimpleDateFormat, MMddyyyy
`java.lang.String`	`getGetterMethod()`
`java.lang.String`	`getHelpText()` Gets the help text for the described fields.
`int`	`getId()` Gets the ID of this field descriptor
`protected java.lang.Integer`	`getIdAsInteger()` Gets the ID of this field descriptor.
`java.lang.String`	`getIsNullable()` Gets whether or not NULL is allowed.
`java.lang.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.
`java.lang.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
`java.lang.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 field)` Returns a RowCollection containing the possible values for the Field.
`java.lang.String`	`getPossibleValuesKey()` Gets the possible values key.
`Operation`	`getPossibleValuesOperation()` Gets the SQLOperation describing how the possible values for fields should be retrieved
`int`	`getPossibleValuesOperationId()` Gets the id of the Operation which is used to retrieve the possible values for this field descriptor
`SQLOperation`	`getPossibleValuesSQLOperation()` Deprecated. possible values are not just restricted to sql use getPossibleValuesOperation()
`int`	`getPossibleValuesSQLOperationId()` Deprecated. possible values are not tied to just sql - use getPossibleValuesOperationId
`int`	`getRadix()` Gets the column's radix.
`java.lang.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)
`short`	`getScale()` Gets the column's number of fractional digits.
`java.lang.String`	`getSchema()` Gets the Table's schema (may be null).
`int`	`getSecuredTypeId()` Gets the id of the secured type.
`java.lang.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.
`java.lang.String`	`getSetterMethod()`
`int`	`getSQLType()` Gets the SQL type of the described fields.
`java.lang.String`	`getSQLTypeName()` getSQLTypeName method comment.
`int`	`getStatusChange()` Returns whether or not we notify on a status change
`java.lang.String`	`getStyleClass()` Gets the style class for this FieldDescriptor's Fields
`java.lang.String`	`getSwitches()` Gets the switches, swithces is an extra field for holding special indicators which may be used for influencing how the DataEngine behaves.
`java.lang.String`	`getSystemURL()` Gets the system url.
`int`	`getUsageId()` Gets the usageId of the field.
`protected java.lang.String`	`getUserFieldStringValue(Field field, java.lang.String fdFieldName, ExecutingContext ec)` Gets the default or auto update String parameter for the described fields.
`protected java.lang.String`	`getUserFieldStringValue(java.lang.String fieldName, ExecutingContext ec)` Deprecated. should passed Field object as parameter as well to allow for ?? parameter
`java.lang.String`	`getUserMessageForOperation(int changeCount, int mode)` Return a message to the user after an operation completes.
`java.lang.String`	`getXMLTag()`
`java.lang.Class`	`guessFieldClass()` Here is where we will take an educated guess at what the Field Class will be for this FD Row.
`boolean`	`hasAssociationOperation()` This method simply tells whether or not there is a value in the DATA_LV_ID column.
`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`	`hasPossibleValuesOperation()` This method simply tells whether or not there is a value in the PV_LV_ID column.
`boolean`	`hasPossibleValuesSQLOperation()` Deprecated. replaced with hasPossibleValueOperation - might not just be sql
`boolean`	`hasScale()` Check if scale (decimal digits) exists and has been set on this FD.
`boolean`	`hasUsageId()` Check if this FieldDescriptorRow has a usage id.
`int`	`insert(SQLContext context)` Inserts this Row into its table.
`boolean`	`isAssignable(java.lang.Class classType)` Returns true if this FDRow has a fieldClass which is equal or a subclass of classType
`boolean`	`isAuthorizedForEdit(Field field, Row row, ExecutingContext ec)` Check to see if Field in Row can be edited.
`boolean`	`isAuthorizedForRead(Field field, Row row, ExecutingContext ec)` Check to see if the given Field in the given Row can be read.
`boolean`	`isAutoIncrement()` Checks if this Field's value is auto incremented.
`boolean`	`isAutoIncrementDatabaseDriven()` Checks to see if this is set to a WOW driven auto increment field.
`boolean`	`isAutoIncrementWOWDriven()` Checks to see if this is set to a WOW driven auto increment field.
`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`	`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`	`isFieldApplicable(Field fld, ExecutingContext ec)` Tests if a field is applicable in the current scenario
`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`	`isNumericSQLType()` Returns true if the SQL Type is numeric according to Types
`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.
`boolean`	`isStatusChange()` Check whether or not this FD is status change.
`boolean`	`isUseRowForFieldSets()` Check to see if the row should be used to obtain field sets.
`protected void`	`postDelete(int changed, ExecutingContext ec)` This method provides a "hook" for altering the current Row after a delete is performed.
`void`	`setApplicationID(java.lang.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)` Deprecated. Auto increment is no longer a boolean field. WOW now has the functionality to handle database driven auto increment fields. Possible values for auto increment are now N=Not, Y=WOW, and D=Database. This method assumes true is WOW driven so the auto increment value will be set to Y. setAutoIncrement(String) should be used to set to types other then Y and N.
`void`	`setAutoIncrment(java.lang.String type)` Set the type of auto increment to use.
`void`	`setAutoTrimOnRead(boolean pAutoTrimOnRead)`
`void`	`setAutoTrimOnWrite(boolean pAutoTrimOnWrite)`
`void`	`setCaseSensitive(boolean pCaseSensitive)` Sets if this column is case sensitive.
`void`	`setCatalog(java.lang.String pCatalog)` Sets the Table's catalog (may be null).
`void`	`setColumnSize(int pColumnSize)` Sets the column's size.
`void`	`setColumnTableName(java.lang.String pColumnTableName)` Sets the Table name.
`void`	`setCompanyID(java.lang.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(java.lang.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(java.lang.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(java.lang.String pDivisionID)`
`void`	`setExternalName(java.lang.String pExternalName)` Sets the external name of the described field.
`void`	`setFieldClass(java.lang.Class pFieldClass)` Sets the class name of the formatter for the field.
`void`	`setFieldClass(java.lang.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(java.lang.String value)` Sets the field set for the described fields.
`void`	`setFieldValue(java.lang.String fldNam, java.lang.Object value)` Sets the value of the specified field.
`void`	`setFormatterClass(java.lang.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(java.lang.String pHelpText)` Sets the help text for the described field.
`void`	`setIsNullable(java.lang.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(java.lang.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`	`setOwnerId(int value)` Sets the owner id of this field descriptor
`void`	`setOwnerId(java.lang.Integer id)` Sets the owner id of this field descriptor
`void`	`setPossibleValueClass(java.lang.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(java.lang.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(java.lang.String pRemarks)` Sets the comment describing the column (may be null)
`void`	`setRequired(boolean required)` Sets if this column allows null.
`void`	`setSchema(java.lang.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(java.lang.String pSQLTypeName)` setSQLTypeName method comment.
`void`	`setStatusChange(int pStatusChange)` Sets whether or not to notify on status change
`void`	`setSwitches(java.lang.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(java.lang.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(java.lang.String pXMLTag)`
`Row`	`statusChanged(Field field, ExecutingContext ec)` Invoked when a status change takes place on of this Row's fields.
`java.lang.String`	`toString()`
`Row`	`transferDataTo(Row pDestinationRow)` Transfers all the data in this Row into a different Row.
`int`	`update(java.sql.Connection conn, ExecutingContext ec)` Updates the database with the values in this Row.
`void`	`updateFieldValues(java.util.Map fields)` Updates the values of any Fields in this Row with the value in the given Map that has the same key as the Field's name.
`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, addToRowCollection, appendDisplayType, batchProcess, clearFields, clearTables, clearValidationException, clone, cloneRow, commitFieldValues, commitFieldValues, commitFieldValues, concatenateFieldFullLengthValues, concatenateFieldValues, containsField, copyIntoRowFieldsWithCommonFieldNames, copyIntoRowFieldsWithCommonFieldNames, copyIntoRowFieldsWithCommonUsageIds, copyIntoRowFieldsWithGivenFieldNames, copyIntoRowFieldsWithGivenFieldNames, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, createAction, createNamedActionRequest, createSQLContextForDelete, createSQLContextForInsert, dataTransferred, defaultMerge, delete, delete, delete, delete, deleteObject, divide, duplicateKey, enforceExclusiveOr, equals, equals, equalsInstance, fieldHasPossibleValuesSQLOperation, firePropertyChange, fireRowEvent, getActionDefaultLocation, getActionDescriptor, getActionRequest, getActionRequest, getActions, getActionsForFields, getActionsForOperation, getAssociation, getAssociation, getAssociationByOperationUsageId, getAssociationOperation, getAttribute, getAutoIncrementDatabaseDrivenField, getBackgroundColor, getChangedFields, getChildren, getColumnSpan, getCompleteRow, getCompleteRow, getConcurrentFields, getConfigProperty, getCopiedFieldValues, getCreationContext, getCSVRow, getCSVRow, getDatabaseRow, getDatabaseRow, getDatabaseRow, getDatabaseRow, getDBSystem, getDeleteConfirmation, getDisjointRowClass, getDisplayValue, getDisplayValueByUsageId, getDisplayValueForKey, getErrorMessageForOperation, getExternalName, getExternalNames, getFDFData, getFDTable, getField, getField, getField, getFieldAssociationOperation, getFieldCollection, getFieldDefaultValue, getFieldDescriptor, getFieldDescriptor, getFieldDescriptor, getFieldDescriptorsWithUsage, getFieldDescriptorsWithUsageId, getFieldDescriptorWithUsageId, getFieldDisplayComponent, getFieldDisplayValue, getFieldDisplayValue, getFieldExternalName, getFieldFieldClassParameters, getFieldIncrementor, getFieldMaxLength, getFieldNames, getFieldNames, getFieldPossibleValues, getFields, getFields, getFieldSearchDefaultValue, getFieldSets, getFieldsForInsert, getFieldSQLObject, getFieldStatusChange, getFieldsToDisplay, getFieldsToDisplayStrict, getFieldsToDisplayStrict, getFieldStyleClass, getFieldsWithUsageId, getFieldUsageIds, getFieldValue, getFieldValueWithUsageId, getFieldWithUsageId, getHeaderText, getHorizontalAlignment, getJSPFor, getKeyFieldNames, getKeyFields, getKeyFields, getLibraryName, getMaxFieldLengths, getMaxFieldLengths, getMaxInsertRetries, getMetaDataSystemAlias, getNamed, getNamed, getNamesOfUpdatedFields, getNavigationKey, getNavigationListKey, getNextOperationToRun, getOperation, getOperation, getOperationFromDB, getOperationFromDBByUsage, getPercentage, getPhysicalFieldNames, getPossibleValueClass, getPossibleValueClass, getPossibleValuesKey, getPossibleValuesOperation, getPropertyChangeSupport, getPropertyGroup, getPropertyGroups, getPropertyGroups, getReplacementFieldsToDisplay, getReplacementFieldsToDisplay, getRequiredFields, getRow, getRowCollection, getRowDisplayAttributes, getRowDisplayAttributes, getRowHandledActionNames, getRowKey, getSQL, getSQLContext, getStaticAttribute, getStaticAttributes, getSum, getSystemAlias, getTabbedOperation, getTable, getTable, getTableName, getTables, getTimestamp, getUpdatedFields, getUserMessageForOperation, getUseWOWLibrary, getValidationExceptions, getValueAsBoolean, getValueAsByte, getValueAsDate, getValueAsDate, getValueAsDouble, getValueAsDouble, getValueAsFloat, getValueAsFullLengthString, getValueAsInt, getValueAsInt, getValueAsLong, getValueAsNumber, getValueAsNumber, getValueAsShort, getValueAsString, getValueAsString, getValueAsStringByUsageId, getValueByUsageId, getValueForKey, getValues, getXMLData, getXMLData, getXMLHeaderData, goToNextOperation, handleAction, hasAssociationOperation, hasChildRows, hasMultipleStyleClasses, hasPossibleValuesKeyClassOrOp, hasPossibleValuesOperation, hasPropertyChangeListeners, incrementFieldValue, initializeRow, initializeRow, initializeRow, initializeRow, initializeRow, initializeRow, insert, insert, insert, is, isActionApplicable, isActionRepeatable, isARow, isARowCollection, isChanged, isChanged, isChangedRealTime, isChangedSinceLastCheck, isCloneNeeded, isContainsAllFields, isCopyable, isDeletable, isDistinctRow, isEditable, isEmpty, isFieldAuthorizedForEdit, isFieldAuthorizedForRead, isFieldAutoIncrement, isFieldAutoIncrementDatabaseDriven, isFieldAutoIncrementWOWDriven, isFieldDisplayable, isFieldPresent, isFieldReadOnly, isFieldReadOnlyOnSearch, isFieldRequired, isFieldRequiredOnSearch, isFieldsChanged, isFieldUpdateable, isFieldValueNotBlank, isFieldValuePossibleValue, isFieldValuesDatabaseDefaults, isGenerateChildRows, isGroupByRow, isGuarded, isHasColumnNames, isInARowCollection, isIncrementorResetAfterMaxInsertRetries, isInitializeDerivedFieldEnabled, isInitializeDerivedFieldsEnabled, isJoinedRow, isKeyFieldsPresent, isLogicalRow, isMultipleDeleteEnabled, isParameterRow, isPersistent, isPhysicalRow, isPrepareFieldValue, isPropertyChangeEventsEnabled, isReturningFromPossibleValuesSearch, isRowDisplayable, isRowKeyed, isSelectable, isStatusChange, isToBeSelected, isUnionRow, isUpdateable, isValidateDerivedFields, isValidateRequired, isValidationRequiredForAutoPopulate, isViewable, iterator, joinedDatabaseAccessFailure, joinedDelete, joinedDelete, joinedInsert, joinedInsert, joinedUpdate, joinedUpdate, merge, newField, newField, newField, newField, openFor, persist, populate, populate, populate, populateFD, postCreate, postExtract, postInsert, postInsert, postUpdate, postUpdate, preDelete, preInsert, prepareForDetails, prepareForParameters, prepareForResultsDisplay, prepareFromFieldNames, preUpdate, removeField, removeField, removeNavigationKey, removePropertyChangeListener, removePropertyChangeListener, removeRowEventListener, removeRowEventListeners, replaceField, replaceFields, replaceFieldValues, replaceNumbersWithNames, reread, rereadIfNeeded, resetDisplayValues, rollbackChanges, runSQLQuery, runSQLQuery, runSQLStatement, runSQLStatement, setAttribute, setAutoUpdateFieldValues, setCreationContext, setCreationOperation, setFieldInitialValue, setFieldValue, setFieldValue, setFieldValue, setFieldValueAsString, setFieldValueAsString, setFieldValuesAsDate, setFieldValuesToDefault, setFieldValuesWithCommonFieldNames, setFieldValuesWithCommonFieldNames, setFieldValuesWithCommonFieldNames, setFieldValuesWithCommonUsageIds, setFieldValueToDefault, setMultipleDeleteEnabled, setNavigationKey, setParameterRow, setPersistent, setPropertyChangeEventsEnabled, setPropertyGroups, setReturningFromPossibleValuesSearch, setRowDisplayAttributes, setSavepoint, setSavepoint, setSavepoint, setStaticAttribute, setTables, setTables, setUseWOWLibrary, setValidateDerivedFields, setValidateRequired, setValues, size, splitAndSetFieldValues, swapFieldValues, toCSV, toDOC, toDOC, toFDF, toPDF, toPDF, toString, toUpperCase, toXML, transferDataTo, update, update, update, updateGlobalValues, updateObject, validate, validate, validateField, validateRowOperation

Methods inherited from class java.lang.Object

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

Constructor Detail

FieldDescriptorRow

public FieldDescriptorRow()

Method Detail

calculateFieldClass

protected java.lang.Class calculateFieldClass()
                                       throws CMException

Gets the class to instantiate for this field. For example, a char field from the database may actually be created as a EMailField or PhoneField. Giving fields more intellience and behavior. If no field class has been configured in the FieldData for this field just use the basic SQL type.

Throws:: CMException

clearJavaFieldClass

public void clearJavaFieldClass()
                         throws CMException

Clears the Java Class that is used 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.

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

cloneFD

public FieldDescriptorRow cloneFD()
                           throws CMException

Clones this FieldDescriptorRow.

Throws:: CMException

copy

public Row copy(boolean pFullCopy)
         throws CMException

Description copied from class: Row

Copy this Row. If specified, copy all of its Fields from the database.

Overrides:: copy in class Row

Parameters:: pFullCopy - whether or not to copy the complete Row
Returns:: Row
Throws:: 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.

Throws:: CMException

createDefaultField

public Field createDefaultField(java.lang.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.

Throws:: CMException

createField

public Field createField()
                  throws CMException

Creates a new field of the appropriate type

Throws:: CMException

getDeleteConfirmationMessage

public java.lang.String getDeleteConfirmationMessage()

Description copied from class: Row

Get the delete confirmation message.

Overrides:: getDeleteConfirmationMessage in class Row

createField

public Field createField(java.lang.String pFieldName)
                  throws CMException

Creates a new field of the appropriate type

Throws:: CMException

createField

public Field createField(java.lang.String pFieldName,
                         java.lang.Class fieldClass)
                  throws CMException

Creates a new field of the specified type

Throws:: 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
Throws:: CMException

createSQLContextForUpdate

protected SQLContext createSQLContextForUpdate(ExecutingContext ec)
                                        throws CMException

Creates a new SQLContext which will be used for updating this row. Subclasses may override if necessary

Overrides:: createSQLContextForUpdate in class Row

Throws:: CMException

duplicateKey

public boolean duplicateKey(int retriesLeft,
                            ExecutingContext ec)
                     throws CMException

Method called when a duplicate key is encountered attempting to insert this Row. Subclasses may override to provide additional logic before insert is attempted again.

Overrides:: duplicateKey in class Row

Parameters:: retriesLeft - The number of retry attemps left; ec - context in which the Row is being processed.
Returns:: true if the insert should be attempted again, false if the insert should fail without any warnings or messages
Throws:: CMException

getApplicationID

public java.lang.String getApplicationID()

getAssociationFieldId

public int getAssociationFieldId()

Deprecated. old way of specifing associations

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

Deprecated. used by old way of getting associations

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

Throws:: 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 java.lang.String getAutoUpdateStringValue(ExecutingContext pEc)

Deprecated. should also pass Field object to allow for ?? parameters

Gets the auto update String parameter for the described fields.

getAutoUpdateStringValue

public java.lang.String getAutoUpdateStringValue(Field field,
                                                 ExecutingContext pEc)

Gets the auto update String parameter for the described fields.

getAutoUpdateValue

public java.lang.String getAutoUpdateValue()

Gets the default value for the described fields.

getCatalog

public java.lang.String getCatalog()

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

getColumnName

public java.lang.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 java.lang.String getColumnTableName()

Gets the Table name.

getCompanyID

public java.lang.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 java.lang.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

Throws:: 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()

Deprecated. replaced with getScale() which returns -1 if FD doesn't have a scale (decimal digits) versus this method which returns 0

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

getDefaultStringValue

public java.lang.String getDefaultStringValue(ExecutingContext pEc)

Deprecated. actual Field getting value for should be passed as well

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

getDefaultStringValue

public java.lang.String getDefaultStringValue(Field field,
                                              ExecutingContext pEc)

Get 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 java.lang.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 java.lang.String getDivisionID()

getExternalName

public java.lang.String getExternalName()

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

getFieldClass

public java.lang.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.

Throws:: CMException

getFieldClassName

public java.lang.String getFieldClassName()
                                   throws CMException

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

Throws:: 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

getFieldClassParameters

public java.lang.String[] getFieldClassParameters()

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

Returns:: String[], null if no parameters are specified.

getFieldClassString

public java.lang.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.

Throws:: CMException

getFieldDescriptorClass

public static java.lang.Class getFieldDescriptorClass(int fdType)

Gets the FieldDescriptor java class which should be used to represent an FD of the specified type

getFieldDescriptorSource

public java.lang.String getFieldDescriptorSource()

Convience method used to return a string containing the fields name, connection alias, library name, and table name.

Returns:: concatination of connection alias, library name, table name, and field name.

getFieldDescriptorType

public int getFieldDescriptorType()

Gets the type of this field descriptor

getFieldDisplayOrder

public int getFieldDisplayOrder(Field field)

Description copied from class: Row

Gets the order of which the given Field will appear in its FieldSet

Overrides:: getFieldDisplayOrder in class Row

getFieldFieldSetName

public java.lang.String getFieldFieldSetName(Field field)

Description copied from class: Row

Gets the name of the given Field's FieldSet NOTE: This method will not get called unless you override the isUseRowForFieldSets method to return true.

Overrides:: getFieldFieldSetName in class Row

getFieldSet

public java.lang.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 java.lang.String getFormatterClass()

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

getFormatterClassParameters

public java.lang.String[] getFormatterClassParameters()

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

Returns:: String[], null if no parameters are specified.

getGetterMethod

public java.lang.String getGetterMethod()

getHelpText

public java.lang.String getHelpText()

Gets the help text for the described fields.

getId

public int getId()

Gets the ID of this field descriptor

getIdAsInteger

protected java.lang.Integer getIdAsInteger()

Gets the ID of this field descriptor. This is necessary because the keys in the hashmap which maps ID's to FD's are Integers.

getIsNullable

public java.lang.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 java.lang.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 java.lang.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 java.lang.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 field)
                                throws CMException

Returns a RowCollection containing the possible values for the Field.

Overrides:: getPossibleValues in class Row

Parameters:: field - Field
Returns:: RowCollection
Throws:: CMException

getPossibleValuesKey

public java.lang.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.

getPossibleValuesOperation

public Operation getPossibleValuesOperation()
                                     throws CMException

Gets the SQLOperation describing how the possible values for fields should be retrieved

Throws:: CMException

getPossibleValuesSQLOperation

public SQLOperation getPossibleValuesSQLOperation()
                                           throws CMException

Deprecated. possible values are not just restricted to sql use getPossibleValuesOperation()

Gets the SQLOperation describing how the possible values for fields should be retrieved

Throws:: CMException

getPossibleValuesSQLOperationId

public int getPossibleValuesSQLOperationId()

Deprecated. possible values are not tied to just sql - use getPossibleValuesOperationId

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

getPossibleValuesOperationId

public int getPossibleValuesOperationId()

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

getRadix

public int getRadix()

Gets the column's radix.

getRemarks

public java.lang.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)

getScale

public short getScale()

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

getSchema

public java.lang.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 java.lang.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 java.lang.String getSetterMethod()

getSQLType

public int getSQLType()

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

getSQLTypeName

public java.lang.String getSQLTypeName()

getSQLTypeName method comment.

getStatusChange

public int getStatusChange()

Returns whether or not we notify on a status change

getStyleClass

public java.lang.String getStyleClass()

Gets the style class for this FieldDescriptor's Fields

getSwitches

public java.lang.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 java.lang.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.

getUserFieldStringValue

protected java.lang.String getUserFieldStringValue(java.lang.String fieldName,
                                                   ExecutingContext ec)

Deprecated. should passed Field object as parameter as well to allow for ?? parameter

Gets the default or auto update String parameter for the described fields.

Parameters:: fieldName - name of Field containing value to get.; ec - context in which code is executing.

getUserFieldStringValue

protected java.lang.String getUserFieldStringValue(Field field,
                                                   java.lang.String fdFieldName,
                                                   ExecutingContext ec)

Gets the default or auto update String parameter for the described fields.

Parameters:: field - Field to which the default value is being retrieved for; fdFieldName - name of field on this FD to get a value from.; ec - context in which code is executing.

getUserMessageForOperation

public java.lang.String getUserMessageForOperation(int changeCount,
                                                   int mode)

Description copied from class: Row

Return a message to the user after an operation completes. This allows you to return something besides the generic "1 row updated, etc" By default, return null which will use the default message from the request.

Overrides:: getUserMessageForOperation in class Row

See Also:: (see Row constants to find the modes.

getXMLTag

public java.lang.String getXMLTag()

guessFieldClass

public java.lang.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)

hasAssociationOperation

public boolean hasAssociationOperation()

This method simply tells whether or not there is a value in the DATA_LV_ID column.

Returns:: boolean

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

Deprecated. replaced with hasPossibleValueOperation - might not just be sql

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

hasScale

public boolean hasScale()

Check if scale (decimal digits) exists and has been set on this FD.

hasPossibleValuesOperation

public boolean hasPossibleValuesOperation()

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
Throws:: CMException

isAssignable

public boolean isAssignable(java.lang.Class classType)

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

isAuthorizedForEdit

public boolean isAuthorizedForEdit(Field field,
                                   Row row,
                                   ExecutingContext ec)
                            throws CMException

Check to see if Field in Row can be edited.

Throws:: CMException

isAuthorizedForRead

public boolean isAuthorizedForRead(Field field,
                                   Row row,
                                   ExecutingContext ec)
                            throws CMException

Check to see if the given Field in the given Row can be read.

Throws:: CMException

isAutoIncrement

public boolean isAutoIncrement()

Checks if this Field's value is auto incremented.

isAutoIncrementWOWDriven

public boolean isAutoIncrementWOWDriven()

Checks to see if this is set to a WOW driven auto increment field.

Returns:

isAutoIncrementDatabaseDriven

public boolean isAutoIncrementDatabaseDriven()

Checks to see if this is set to a WOW driven auto increment field.

Returns:

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.

Overrides:: isCurrent in class Row

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

isFieldApplicable

public boolean isFieldApplicable(Field fld,
                                 ExecutingContext ec)
                          throws CMException

Description copied from class: Row

Tests if a field is applicable in the current scenario

Overrides:: isFieldApplicable in class Row

Parameters:: fld - The field which may or may not be applicable
Throws:: CMException

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.

isNumericSQLType

public boolean isNumericSQLType()

Returns true if the SQL Type is numeric according to Types

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.

isStatusChange

public boolean isStatusChange()

Check whether or not this FD is status change.

postDelete

protected void postDelete(int changed,
                          ExecutingContext ec)
                   throws CMException

This method provides a "hook" for altering the current Row after a delete is performed.

Overrides:: postDelete in class Row

Parameters:: ec - current context in which code is running
Throws:: CMException

setApplicationID

public void setApplicationID(java.lang.String pApplicationID)
                      throws CMException

Throws:: 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

Deprecated. Auto increment is no longer a boolean field. WOW now has the functionality to handle database driven auto increment fields. Possible values for auto increment are now N=Not, Y=WOW, and D=Database. This method assumes true is WOW driven so the auto increment value will be set to Y. setAutoIncrement(String) should be used to set to types other then Y and N.

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

Throws:: CMException

setAutoIncrment

public void setAutoIncrment(java.lang.String type)
                     throws CMException

Set the type of auto increment to use. N=None Y=WOW Driven D=Database Driven

Parameters:: type -
Throws:: CMException

setAutoTrimOnRead

public void setAutoTrimOnRead(boolean pAutoTrimOnRead)
                       throws CMException

Throws:: CMException

setAutoTrimOnWrite

public void setAutoTrimOnWrite(boolean pAutoTrimOnWrite)
                        throws CMException

Throws:: CMException

setCaseSensitive

public void setCaseSensitive(boolean pCaseSensitive)
                      throws CMException

Sets if this column is case sensitive.

Throws:: CMException

setCatalog

public void setCatalog(java.lang.String pCatalog)
                throws CMException

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

Throws:: 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.

Throws:: CMException

setColumnTableName

public void setColumnTableName(java.lang.String pColumnTableName)
                        throws CMException

Sets the Table name.

Throws:: CMException

setCompanyID

public void setCompanyID(java.lang.String pCompanyID)
                  throws CMException

Throws:: 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.

Throws:: CMException

setConnectionAlias

public void setConnectionAlias(java.lang.String alias)
                        throws CMException

Sets the system alias.

Throws:: CMException

setCurrency

public void setCurrency(boolean pCurrency)
                 throws CMException

Sets if this column is currency.

Throws:: 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

Throws:: CMException

setDecimalDigits

public void setDecimalDigits(int pDecimalDigits)
                      throws CMException

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

Throws:: CMException

setDefaultValue

public void setDefaultValue(java.lang.String pDefaultValue)
                     throws CMException

Sets the default value for the described field.

Throws:: CMException

setDisplayComponent

public void setDisplayComponent(int component)
                         throws CMException

Sets the display component for this field.

Throws:: 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
Throws:: 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.

Throws:: 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.

Throws:: CMException

setDisplayRule

public void setDisplayRule(int rule)
                    throws CMException

Sets the display rule for this field.

Throws:: 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
Throws:: CMException

setDivisionID

public void setDivisionID(java.lang.String pDivisionID)
                   throws CMException

Throws:: CMException

setExternalName

public void setExternalName(java.lang.String pExternalName)
                     throws CMException

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

Throws:: CMException

setFieldClass

public void setFieldClass(java.lang.Class pFieldClass)
                   throws CMException

Sets the class name of the formatter for the field.

Throws:: CMException

setFieldClass

public void setFieldClass(java.lang.String pFieldClass)
                   throws CMException

Sets the class name of the formatter for the field.

Throws:: CMException

setFieldDescriptorType

public void setFieldDescriptorType(int value)
                            throws CMException

Sets the type of this field descriptor

Throws:: CMException

setFieldSet

public void setFieldSet(java.lang.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

Throws:: CMException

setFieldValue

public void setFieldValue(java.lang.String fldNam,
                          java.lang.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.
Throws:: CMException

setFormatterClass

public void setFormatterClass(java.lang.String pFormatter)
                       throws CMException

Sets the class name of the formatter for the field.

Throws:: 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(java.lang.String pHelpText)
                 throws CMException

Sets the help text for the described field.

Throws:: CMException

setIsNullable

public void setIsNullable(java.lang.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

Throws:: 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.

Throws:: CMException

setMaxBytes

public void setMaxBytes(int pMaxBytes)
                 throws CMException

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

Throws:: CMException

setName

public void setName(java.lang.String pName)
             throws CMException

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

Throws:: CMException

setNullable

public void setNullable(int pNullable)
                 throws CMException

Sets whether or not NULL is allowed.

Throws:: CMException

setOrdinalPosition

public void setOrdinalPosition(int pOrdinalPosition)
                        throws CMException

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

Throws:: CMException

setOwnerId

public void setOwnerId(int value)
                throws CMException

Sets the owner id of this field descriptor

Throws:: CMException

setOwnerId

public void setOwnerId(java.lang.Integer id)
                throws CMException

Sets the owner id of this field descriptor

Throws:: CMException

setPossibleValueClass

public void setPossibleValueClass(java.lang.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
Throws:: CMException

setPossibleValuesKey

public void setPossibleValuesKey(java.lang.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.

Throws:: 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

Throws:: CMException

setRadix

public void setRadix(int pRadix)
              throws CMException

Sets the column's radix.

Throws:: CMException

setReadOnly

public void setReadOnly(boolean pReadOnly)
                 throws CMException

Sets whether this column is definitely not writable.

Throws:: CMException

setRemarks

public void setRemarks(java.lang.String pRemarks)
                throws CMException

Sets the comment describing the column (may be null)

Throws:: 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

Throws:: CMException

setSchema

public void setSchema(java.lang.String pSchema)
               throws CMException

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

Throws:: CMException

setSearchable

public void setSearchable(boolean pSearchable)
                   throws CMException

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

Throws:: CMException

setSigned

public void setSigned(boolean pSigned)
               throws CMException

Sets whether values in the column are signed numbers.

Throws:: CMException

setSortable

public void setSortable(boolean pSortable)
                 throws CMException

Throws:: 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

Throws:: CMException

setSQLTypeName

public void setSQLTypeName(java.lang.String pSQLTypeName)
                    throws CMException

setSQLTypeName method comment.

Throws:: CMException

setStatusChange

public void setStatusChange(int pStatusChange)
                     throws CMException

Sets whether or not to notify on status change

Throws:: CMException

setSwitches

public void setSwitches(java.lang.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.

Throws:: CMException

setSystemURL

public void setSystemURL(java.lang.String pSystemURL)
                  throws CMException

Sets the system url.

Throws:: CMException

setTable

public void setTable(Table pTable)

Sets the table to which this row belongs.

setUsageId

public void setUsageId(int usageid)
                throws CMException

Throws:: CMException

setXMLTag

public void setXMLTag(java.lang.String pXMLTag)
               throws CMException

Throws:: CMException

toString

public java.lang.String toString()

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.
Throws:: DataEngineException

update

public int update(java.sql.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
Throws:: CMException

updateFieldValues

public void updateFieldValues(java.util.Map fields)
                       throws CMException

Description copied from class: Row

Updates the values of any Fields in this Row with the value in the given Map that has the same key as the Field's name.

Overrides:: updateFieldValues in class Row

Throws:: 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

Parameters:: pContext - current context in which application is executing
Returns:: true, if Row and Fields are valid; false otherwise.
Throws:: CMException

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

isUseRowForFieldSets

public boolean isUseRowForFieldSets()
                             throws CMException

Description copied from class: Row

Check to see if the row should be used to obtain field sets. Subclasses may override to allow field's to have dynamic display order and field set values.

Overrides:: isUseRowForFieldSets in class Row

Throws:: CMException

statusChanged

public Row statusChanged(Field field,
                         ExecutingContext ec)
                  throws CMException

Description copied from class: Row

Invoked when a status change takes place on of this Row's fields. Subclasses may override this method, but they should call it on the superclass when they do.

Overrides:: statusChanged in class Row

Parameters:: field - The field whose status has changed; ec - The current executing context
Returns:: The "new" row resulting from the status change. Usually this is this same row, but a row may choose to replace itself with another row and return that other row.
Throws:: CMException

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

planetj.database.fielddescriptors Class FieldDescriptorRow

FieldDescriptorRow

calculateFieldClass

clearJavaFieldClass

cloneFD

copy

createDefaultField

createDefaultField

createField

getDeleteConfirmationMessage

createField

createField

createRow

createSQLContextForUpdate

duplicateKey

getApplicationID

getAssociationFieldId

getAssociationId

getAssociationOperation

getAssociationOperationId

getAutoUpdateStringValue

getAutoUpdateStringValue

getAutoUpdateValue

getCatalog

getColumnName

getColumnSize

getColumnSystem

getColumnTable

getColumnTable

getColumnTableName

getCompanyID

getConcurrency

getConnectionAlias

getDataSQLOperation

getDataSQLOperationId

getDataType

getDecimalDigits

getDefaultStringValue

getDefaultStringValue

getDefaultValue

getDisplayComponent

getDisplayHeight

getDisplayLength

getDisplayOrder

getDisplayRule

getDisplayWidth

getDivisionID

getExternalName

getFieldClass

getFieldClassName

getFieldClassParameterDigitRequired

getFieldClassParameters

getFieldClassString

getFieldDescriptorClass

getFieldDescriptorSource

getFieldDescriptorType

getFieldDisplayOrder

getFieldFieldSetName

getFieldSet

getFormatterClass

getFormatterClassParameters

getGetterMethod

getHelpText

getId

getIdAsInteger

getIsNullable

getJavaFieldClass

getKeyPostion

getMaxBytes

getName

getNullable

getOrdinalPosition

getOrigin

getOwnerId

getOwnerIdField

getPossibleValueClass

getPossibleValues

getPossibleValuesKey

getPossibleValuesOperation

getPossibleValuesSQLOperation

planetj.database.fielddescriptors
Class FieldDescriptorRow