| java.lang.Object
 com.jcorporate.expresso.core.dbobj.DBObjectDef
| DBObjectDef | | public class DBObjectDef implements JDBCObjectMetaData(Code) | | This object contains the "definition" of the DBObject, while the DBObject
itself contains only the data itself.
One DBObjectDef object is stored in a static HashMap in the DBObject class,
and is looked up and referenced for all definitions of the structure of the given object.
since this class is not threadsafe for adding information, it is imperitive
that all information addition, typically done when the first instance
of a DBObject is instantiated, is done in a synchronized context.
author:
Michael Nash |
| Constructor Summary | |
| public | DBObjectDef()
Default Constructor. |
| Method Summary | |
| public synchronized void | addDetail(String objName, String keyFieldsLocal, String keyFieldsForeign)
Specify a new "detail" db object, and the fields in this object
they specify the fields in the related object
Parameters:
objName - The class name of the related object. | | public synchronized void | addField(String fieldName, String fieldType, int fieldSize, int fieldPrecision, boolean allowNull, String fieldDescription)
Add a field with more details: This version allows the user to specify a
precision, for fields that use both a size and precision. | | public synchronized void | addField(String fieldName, String fieldType, int fieldSize, boolean allowNull, String fieldDescription)
Add a field with more details: This version of addfield supplies
the allowNull flags and a description of the field to be used
when reporting errors to the user. | | public synchronized void | addField(String fieldName, String fieldType, int fieldSize, boolean allowNull, String descriptionKey, String fieldDescription)
Add a field with more details: This version of addfield supplies
the allowNull flags and a description of the field to be used
when reporting errors to the user. | | public synchronized void | addInParam(String inFieldName)
Add a new field to the list of fields that are part of this
object's list of input parameters. | | public synchronized void | addIndex(String indexName, String fieldNames, boolean isUnique)
Add an index to the table. | | public synchronized void | addKey(String keyFieldName)
Add a new field to the list of fields that are part of this
object's key. | | public synchronized void | addOutParam(String outFieldName)
Add a new field to the list of fields that are part of this
object's list of output parameter. | | public synchronized void | addTransition(Transition t)
| | public synchronized void | addVirtualField(String fieldName, String fieldType, int fieldSize, String fieldDescription)
Add a new virtual field to the definition of this object. | | public synchronized void | addVirtualField(String fieldName, String fieldType, int fieldSize, String descriptionKey, String fieldDescription)
Add a new virtual field to the definition of this object. | | public synchronized void | addVirtualField(String fieldName, String fieldType, int fieldSize, int fieldPrecision, boolean allowNull, String fieldDescription)
Add a field with more details: This version allows the user to specify a
precision, for fields that use both a size and precision. | | public synchronized void | addVirtualField(String fieldName, String fieldType, int fieldSize, int fieldPrecision, boolean allowNull, String descriptionKey, String fieldDescription)
Add a field with more details: This version allows the user to specify a
precision, for fields that use both a size and precision. | | public boolean | allowsNull(String fieldName)
Returns whether the field allows null values or not. | | public boolean | checkZeroUpdate()
| | public synchronized void | disableLogging()
| | public synchronized void | enableLogging()
Enable logging of changes to this object. | | public java.util.Set | getAllAttributes(String fieldName)
Retrieve all the attributes so you can iterate through them.
Parameters:
fieldName - the name of the field to retrieve. | | public HashMap | getAllDBFields()
| | public synchronized Hashtable | getAllFields()
Return the "allFields" Hashtable, which contains all of the DBField objects
that make up this DB object. | | public Iterator | getAllFieldsIterator()
| | public HashMap | getAllFieldsMap()
Return the "allFields" Hashtable, which contains all of the DBField objects
that make up this DB object. | | public Hashtable | getAllKeys()
Return the "allKeys" hash, containing the DBField objects that make up
the primary key for this db object. | | public Iterator | getAllKeysIterator()
| | public HashMap | getAllKeysMap()
Return the "allKeys" hash, containing the DBField objects that make up
the primary key for this db object. | | public Object | getAttribute(String fieldName, String attribName)
| | public Iterator | getAttributesIterator(String fieldName)
| | public int | getCacheSize()
Get the current Cache size of this object. | | public String | getCharset()
| | public DBField | getDBField(String fieldName)
| | public String | getDefaultValue(String fieldName)
| | public String | getDescription()
Return a description of this database object. | | public String | getDescription(Locale l)
Retrieve the table description in a localized way. | | public String | getDescription(String fieldName)
| | public String | getDescription(java.util.Locale l, String fieldName)
Retrieve an i18n'ized description as per the locale defined for the
'client'
Parameters:
l - the Locale to use. | | public String | getDetailFieldsForeign(String detailName)
| | public String | getDetailFieldsLocal(String detailName)
| | public Set | getDetailSet()
Retrieve a set of detail objects. | | public Enumeration | getDetails()
| | public synchronized Enumeration | getFieldList()
| | public synchronized ArrayList | getFieldListArray()
| | public Iterator | getFieldListIterator()
Get a list of all of the fields in this object This iterator is not thread
safe. | | public DataFieldMetaData | getFieldMetadata(String fieldName)
Retrieve the metadata for the field.
Parameters:
fieldName - the name of the field to retrieve the metadata for. | | public String[] | getFields()
| | public FilterManager | getFilterManager()
| | public Iterator | getInParamFieldListIterator()
Retrieve an interator of IN param fields
Iterator of IN param fields. | | public ArrayList | getInParamListArray()
| | public synchronized Object[] | getIndexArray()
Get an array of DBIndex objects for purpose of
creating them through the schema. | | public Enumeration | getKeyFieldList()
| | public ArrayList | getKeyFieldListArray()
| | public Iterator | getKeyFieldListIterator()
Retrieve an interator of key fields
Iterator of key fields. | | public String | getLength(String fieldName)
| | public int | getLengthInt(String fieldName)
| | public String | getLookupField(String fieldName)
When you get a lookup object, to perform a complete mapping between the
two, you need to know what field name in the remote object maps to this
field.
Parameters:
fieldName - the name of the field to look up. | | public String | getLookupObject(String fieldName)
Get a field's lookup object - this is the name of another database
object that can be used to look up valid values for this object. | | public String | getName()
| | public Iterator | getOutParamFieldListIterator()
Retrieve an interator of IN param fields
Iterator of IN param fields. | | public synchronized int | getOutParamFieldsCount()
This convenience method counts
DBFields belonging to this
DBObject that are set to retrieve. | | public ArrayList | getOutParamListArray()
| | public int | getPrecision(String fieldName)
| | public String | getSchema()
| | public String | getTargetDbCatalog()
Return the Schema Name of the current database object. | | public String | getTargetDbSchema()
Return the Schema Name of the current database object. | | public String | getTargetSQLTable(String dataContext)
Return the Table Name of the current database object. | | public String | getTargetStoreProcedure()
Return the Store procedure Name of the current database object. | | public String | getTargetTable()
Return the Table Name of the current database object. | | public Iterator | getTransitionsIterator()
| | public String | getType(String fieldName)
| | public boolean | hasField(String fieldName)
This method will return a boolean true if the field is defined in the DBOBject,
false otherwise. | | public boolean | hasIndex()
Returns true if an Index exists for this array. | | public boolean | isAllowsNull(String fieldName)
Returns whether the field allows null values or not. | | public boolean | isField(String fieldName)
| | public String | isFieldIgnoreCase(String fieldName)
| | public boolean | isInField(String fieldName)
| | public boolean | isLoggingEnabled()
| | public synchronized boolean | isMultiValued(String fieldName)
| | public boolean | isOutField(String fieldName)
| | public boolean | isReadOnly(String fieldName)
| | public boolean | isReturningValue()
| | public boolean | isSecret(String fieldName)
Is a given field 'secret' - these fields are not shown
when a list is produced by the generic database maintenance servlet (DBMaint). | | public boolean | isVirtual(String fieldName)
Is a given field virtual? A virtual field is not stored in the target table
for this object - it may be computed, or stored in another table. | | public void | removeAttribute(String fieldName, String attribName)
Removes an attribute from the field. | | public synchronized void | setAttribute(String fieldName, String attribName, Object attribValue)
| | public void | setCacheSize(int newValue)
Sets the cache size for this DBObject
Parameters:
newValue - the new value. | | public synchronized void | setCharset(String newCharSet)
Set a characterset for a particular field.
Parameters:
newCharSet - The name of the characterset that you will filter against.For Western-Latin character sets use "ISO-8859-1" as the parameter.Currently, no other charactersets are implemented. | | public synchronized void | setCheckZeroUpdate(boolean newFlag)
Turn on or off the facility to verify that when an update is made that at
least one record got updated. | | public synchronized void | setDefaultValue(String fieldName, String fieldValue)
| | public synchronized void | setDescription(String newDescription)
| | public synchronized void | setLookupObject(String fieldName, String objectName)
Set a field's lookup object - this is the name of another database
object that can be used to look up valid values for this object. | | public synchronized void | setMask(String fieldName, String newMask)
Sets the field's regular expression validation mask. | | public synchronized void | setMultiValued(String fieldName)
Set this field to be multi-valued - e.g. | | public synchronized void | setName(String theName)
| | public synchronized void | setReadOnly(String fieldName)
Set a field as read-only - these fields are not offered for update
when a form is produced by the generic database maintenance servlet
(DBMaint). | | public void | setReturningValue(boolean value)
| | public synchronized void | setSchema(String schemaName)
| | public synchronized void | setSecret(String fieldName)
Set a field as 'secret' - these fields are not shown
when a list is produced by the generic database maintenance servlet. | | public synchronized void | setStringFilter(String fieldName, String filterMethod)
Set a filter for a particular field. | | public synchronized void | setTargetDbCatalog(String theCatalog)
Set the target database schema for this DBObject. | | public synchronized void | setTargetDbSchema(String theSchema)
Set the target database schema for this DBObject. | | public synchronized void | setTargetStoreProcedure(String theStoreProcedure)
Set the target store procedure for this DBObject. | | public synchronized void | setTargetTable(String theTable)
Set the target table for this DBObject. |
| DBObjectDef | | public DBObjectDef()(Code) | | Default Constructor. This allows a DB object to be dynamically
instantiated (e.g. loaded
with Class.forName()) and does all of the required initializations.
|
| addDetail | | public synchronized void addDetail(String objName, String keyFieldsLocal, String keyFieldsForeign) throws DBException(Code) | | Specify a new "detail" db object, and the fields in this object
they specify the fields in the related object
Parameters:
objName - The class name of the related object. There is assumed to bea one to one or one to many relationship from this object to the specified object
Parameters:
keyFieldsLocal - A pipe-delimited list of field names in this object
Parameters:
keyFieldsForeign - A pipe-delimieted list of field names in the other object |
| addField | | public synchronized void addField(String fieldName, String fieldType, int fieldSize, int fieldPrecision, boolean allowNull, String fieldDescription) throws DBException(Code) | | Add a field with more details: This version allows the user to specify a
precision, for fields that use both a size and precision.
Parameters:
fieldName - Name of the field
Parameters:
fieldType - Type of the field - this is the internal Expresso type,mapping in DBField to a specific database data type.
Parameters:
fieldSize - Size of the field
Parameters:
fieldPrecision - The precision of the field
Parameters:
allowNull - Does this field allow nulls?
Parameters:
fieldDescription - A longer description of this field(user-understandable hopefully!) |
| addField | | public synchronized void addField(String fieldName, String fieldType, int fieldSize, boolean allowNull, String fieldDescription) throws DBException(Code) | | Add a field with more details: This version of addfield supplies
the allowNull flags and a description of the field to be used
when reporting errors to the user. This method is only used by the class that
extends DB object, and typically only in the setupFields() method.
Parameters:
fieldName - Name of the field
Parameters:
fieldType - Type of the field - this is the "internal" Expresso type,and is mapped to a specific type for the database depending on themappings in the properties file (if any). The DBField object containsthe default mappings.
Parameters:
fieldSize - Size of this field, if specified for this type of field. Forfields that do not use a size (such as "date"), specify 0 for the size.
Parameters:
allowNull - Does this field allow nulls?
Parameters:
fieldDescription - A longer description of this field(user-understandable hopefully!) |
| addField | | public synchronized void addField(String fieldName, String fieldType, int fieldSize, boolean allowNull, String descriptionKey, String fieldDescription) throws DBException(Code) | | Add a field with more details: This version of addfield supplies
the allowNull flags and a description of the field to be used
when reporting errors to the user. This method is only used by the class that
extends DB object, and typically only in the setupFields() method.
Parameters:
fieldName - Name of the field
Parameters:
fieldType - Type of the field - this is the "internal" Expresso type,and is mapped to a specific type for the database depending on themappings in the properties file (if any). The DBField object containsthe default mappings.
Parameters:
fieldSize - Size of this field, if specified for this type of field. Forfields that do not use a size (such as "date"), specify 0 for the size.
Parameters:
allowNull - Does this field allow nulls?
Parameters:
descriptionKey - Key into the local language files for thisfield's description
Parameters:
fieldDescription - A longer description of this field(user-understandable hopefully!) |
| addInParam | | public synchronized void addInParam(String inFieldName) throws DBException(Code) | | Add a new field to the list of fields that are part of this
object's list of input parameters. Called after all of the "addField" calls in the setupFields()
method to specify which fields make up the parameter fields of this object.
Parameters:
inFieldName - The name of the field to add as part of the input parameter
throws:
DBException - if the field name is not valid or the fieldallows nulls |
| addIndex | | public synchronized void addIndex(String indexName, String fieldNames, boolean isUnique) throws IllegalArgumentException(Code) | | Add an index to the table.
Parameters:
indexName - the name to give the index in the table
Parameters:
fieldNames - A comma delimited list of all fields in the index.
Parameters:
isUnique - - True if this field is a unique index.
throws:
IllegalArgumentException - of fieldName is null or doesn't existor if indexName is null |
| addKey | | public synchronized void addKey(String keyFieldName) throws DBException(Code) | | Add a new field to the list of fields that are part of this
object's key. Called after all of the "addField" calls in the setupFields()
method to specify which fields make up the primary key of this object.
Parameters:
keyFieldName - The name of the field to add as part of the key
throws:
DBException - if the field name is not valid or the fieldallows nulls |
| addOutParam | | public synchronized void addOutParam(String outFieldName) throws DBException(Code) | | Add a new field to the list of fields that are part of this
object's list of output parameter. Called after all of the "addField" calls in the setupFields()
method to specify which fields make up the parameter fields of this object.
Parameters:
outFieldName - The name of the field to add as part of the output parameter
throws:
DBException - if the field name is not valid or the fieldallows nulls |
| addVirtualField | | public synchronized void addVirtualField(String fieldName, String fieldType, int fieldSize, String fieldDescription) throws DBException(Code) | | Add a new virtual field to the definition of this object.
A virtual field is just like a regular one, except it's
not stored in the target table
A normal call to getField or setField on a virtual field will throw
an exception - getField and setField should be extended to handle the virtual
fields for a particular object correctly.
Parameters:
fieldName - Name of the field
Parameters:
fieldType - Database type of the field
Parameters:
fieldSize - Size of the field in characters
Parameters:
fieldDescription - A longer description of this field(user-understandable hopefully!) |
| addVirtualField | | public synchronized void addVirtualField(String fieldName, String fieldType, int fieldSize, String descriptionKey, String fieldDescription) throws DBException(Code) | | Add a new virtual field to the definition of this object.
A virtual field is just like a regular one, except it's
not stored in the target table
A normal call to getField or setField on a virtual field will throw
an exception - getField and setField should be extended to handle the virtual
fields for a particular object correctly.
Parameters:
fieldName - Name of the field
Parameters:
fieldType - Database type of the field
Parameters:
fieldSize - Size of the field in characters
Parameters:
descriptionKey - Key into the local language filesfor the description of this field.
Parameters:
fieldDescription - A longer description of this field(user-understandable hopefully!) |
| addVirtualField | | public synchronized void addVirtualField(String fieldName, String fieldType, int fieldSize, int fieldPrecision, boolean allowNull, String fieldDescription) throws DBException(Code) | | Add a field with more details: This version allows the user to specify a
precision, for fields that use both a size and precision.
Parameters:
fieldName - Name of the field
Parameters:
fieldType - Type of the field - this is the internal Expresso type,mapping in DBField to a specific database data type.
Parameters:
fieldSize - Size of the field
Parameters:
fieldPrecision - The precision of the field
Parameters:
allowNull - Does this field allow nulls?
Parameters:
fieldDescription - A longer description of this field(user-understandable hopefully!) |
| addVirtualField | | public synchronized void addVirtualField(String fieldName, String fieldType, int fieldSize, int fieldPrecision, boolean allowNull, String descriptionKey, String fieldDescription) throws DBException(Code) | | Add a field with more details: This version allows the user to specify a
precision, for fields that use both a size and precision.
Parameters:
fieldName - Name of the field
Parameters:
fieldType - Type of the field - this is the internal Expresso type,mapping in DBField to a specific database data type.
Parameters:
fieldSize - Size of the field
Parameters:
fieldPrecision - The precision of the field
Parameters:
allowNull - Does this field allow nulls?
Parameters:
descriptionKey - Key into the local langauge fileswith a description of this field
Parameters:
fieldDescription - A longer description of this field(user-understandable hopefully!) |
| allowsNull | | public boolean allowsNull(String fieldName) throws DBException(Code) | | Returns whether the field allows null values or not.
Parameters:
fieldName - name of the field true if the field allows null |
| checkZeroUpdate | | public boolean checkZeroUpdate()(Code) | | |
| disableLogging | | public synchronized void disableLogging()(Code) | | Disable change logging of this object
|
| enableLogging | | public synchronized void enableLogging()(Code) | | Enable logging of changes to this object. Change logging writes an entry to
the ChangeLog object every time an add, update, or delete is made to this
object. It is used to track important tables, such as user information,
account information, etc.
|
| getAllAttributes | | public java.util.Set getAllAttributes(String fieldName)(Code) | | Retrieve all the attributes so you can iterate through them.
Parameters:
fieldName - the name of the field to retrieve. java.util.Set of all the attribute names for the given field. |
| getAllFields | | public synchronized Hashtable getAllFields()(Code) | | Return the "allFields" Hashtable, which contains all of the DBField objects
that make up this DB object.
Hashtable |
| getAllFieldsIterator | | public Iterator getAllFieldsIterator()(Code) | | Way to get an interator into the allFields objects
an Iterator into the allFields HashMap |
| getAllFieldsMap | | public HashMap getAllFieldsMap()(Code) | | Return the "allFields" Hashtable, which contains all of the DBField objects
that make up this DB object.
java.util.HashMap |
| getAllKeys | | public Hashtable getAllKeys()(Code) | | Return the "allKeys" hash, containing the DBField objects that make up
the primary key for this db object.
java.util.Hashtable |
| getAllKeysIterator | | public Iterator getAllKeysIterator()(Code) | | Non-threadsafe way to get an interator into the allKeys data
structure
java.util.Iterator of key fields (DBField) |
| getAllKeysMap | | public HashMap getAllKeysMap()(Code) | | Return the "allKeys" hash, containing the DBField objects that make up
the primary key for this db object.
java.util.HashMap |
| getAttribute | | public Object getAttribute(String fieldName, String attribName) throws DBException(Code) | | Gets an Object attribute from the field's metatdata
Parameters:
fieldName - the name of the field for the attribute
Parameters:
attribName - the name of the attribute java.lang.Object |
| getCacheSize | | public int getCacheSize()(Code) | | Get the current Cache size of this object. or -2 if it hasn't been
defined yet.
current cache size value. |
| getCharset | | public String getCharset()(Code) | | return the current object's character set
java.lang.String |
| getDBField | | public DBField getDBField(String fieldName)(Code) | | Get the DBField object specified by the fieldname
Parameters:
fieldName - the name of the field to retrieve DBField object |
| getDefaultValue | | public String getDefaultValue(String fieldName)(Code) | | default value if found, or null |
| getDescription | | public String getDescription()(Code) | | Return a description of this database object. If no explicit description has
been set, return the class name.
A string describing this database object |
| getDescription | | public String getDescription(Locale l)(Code) | | Retrieve the table description in a localized way. If l == null, the
function uses the system locale to generate the value. If unable to
locate the key in the message bundle, the key becomes the return value.
Parameters:
l - the Locale to use for rendering the table description java.lang.String |
| getDescription | | public String getDescription(String fieldName) throws DBException(Code) | | Return the long description of a field, if available
Parameters:
fieldName - The name of the field String: The long description of the field (user-readable)
throws:
DBException - If there is no such field |
| getDescription | | public String getDescription(java.util.Locale l, String fieldName)(Code) | | Retrieve an i18n'ized description as per the locale defined for the
'client'
Parameters:
l - the Locale to use. If null, will use the System default Locale
Parameters:
fieldName - the name of the field to retrieve the i18n'ized descriptionfor. an i18n'ized string. K |
| getDetailSet | | public Set getDetailSet()(Code) | | Retrieve a set of detail objects.
java.util.Set |
| getFieldList | | public synchronized Enumeration getFieldList()(Code) | | Get a list of all of the fields in this object
A Vector of all of the fieldNames in this object |
| getFieldListArray | | public synchronized ArrayList getFieldListArray()(Code) | | Get a list of all of the fields in this object This is threadsafe in that
it makes a new copy of the fieldNamesInOrder ArrayList
A Vector of all of the fieldNames in this object |
| getFieldListIterator | | public Iterator getFieldListIterator()(Code) | | Get a list of all of the fields in this object This iterator is not thread
safe.
An iterator of the fieldNamesInOrder array list |
| getFieldMetadata | | public DataFieldMetaData getFieldMetadata(String fieldName)(Code) | | Retrieve the metadata for the field.
Parameters:
fieldName - the name of the field to retrieve the metadata for. DataFieldMetaData instance for the specified field name. |
| getFields | | public String[] getFields()(Code) | | This convenience method iterates through all the
fields belonging to this DBObject
returns an array of field names ( String ).
String array of all field names in this object.author Peter Pilgrim
See Also: DBObjectDef.getFieldList() |
| getInParamFieldListIterator | | public Iterator getInParamFieldListIterator()(Code) | | Retrieve an interator of IN param fields
Iterator of IN param fields. [MetaData] |
| getInParamListArray | | public ArrayList getInParamListArray()(Code) | | Get a list of all of the names of the IN param fields in this object
An ArrayList of all of the names of the IN param fields |
| getIndexArray | | public synchronized Object[] getIndexArray()(Code) | | Get an array of DBIndex objects for purpose of
creating them through the schema. Return type
should actually be DBIndex. Please Note This may cause an
exception to be thrown if indexList is null. Call hasIndex() first
before calling getIndexArray
Object[] |
| getKeyFieldList | | public Enumeration getKeyFieldList()(Code) | | Get a list of all of the names of the key fields in this object
A Vector of all of the names of the key fields |
| getKeyFieldListArray | | public ArrayList getKeyFieldListArray()(Code) | | Get a list of all of the names of the key fields in this object
An ArrayList of all of the names of the key fields |
| getKeyFieldListIterator | | public Iterator getKeyFieldListIterator()(Code) | | Retrieve an interator of key fields
Iterator of key fields. [MetaData] |
| getLength | | public String getLength(String fieldName) throws DBException(Code) | | Return the length of a field
Parameters:
fieldName - The name of the field String: The length of the field
throws:
DBException - If there is no such field in this object |
| getLookupField | | public String getLookupField(String fieldName)(Code) | | When you get a lookup object, to perform a complete mapping between the
two, you need to know what field name in the remote object maps to this
field.
Parameters:
fieldName - the name of the field to look up. java.lang.String or null if there is no lookup field
throws:
IllegalArgumentException - if the field name does not exist |
| getLookupObject | | public String getLookupObject(String fieldName) throws DBException(Code) | | Get a field's lookup object - this is the name of another database
object that can be used to look up valid values for this object. The lookup
object for a field is set in the db objects setupFields method, and is used
by the DBMaint servlet to provide automatic lookup links for fields.
Parameters:
fieldName - Field name to check String specifying the className of the lookup object
throws:
DBException - If the specified field does not exist. |
| getName | | public String getName()(Code) | | Get the name of this object
String The database object name, or the table name if nonehas been assigned |
| getOutParamFieldListIterator | | public Iterator getOutParamFieldListIterator()(Code) | | Retrieve an interator of IN param fields
Iterator of IN param fields. [MetaData] |
| getOutParamFieldsCount | | public synchronized int getOutParamFieldsCount() throws DBException(Code) | | This convenience method counts
DBFields belonging to this
DBObject that are set to retrieve.
author Yves Henri Amaizo
int number of retrieve fields. |
| getOutParamListArray | | public ArrayList getOutParamListArray()(Code) | | Get a list of all of the names of the OUT param fields in this object
An ArrayList of all of the names of the OUT param fields |
| getPrecision | | public int getPrecision(String fieldName) throws DBException(Code) | |
Parameters:
fieldName - The name of the field integer for demcimal precision of the field |
| getSchema | | public String getSchema()(Code) | | the className of the schema associated with this DBObject |
| getTargetDbCatalog | | public String getTargetDbCatalog()(Code) | | Return the Schema Name of the current database object.
String: Schema name of the target table of this database objectauthor Yves Henri AMAIZO |
| getTargetDbSchema | | public String getTargetDbSchema()(Code) | | Return the Schema Name of the current database object.
String: Schema name of the target table of this database objectauthor Yves Henri AMAIZO |
| getTargetSQLTable | | public String getTargetSQLTable(String dataContext) throws DataException(Code) | | Return the Table Name of the current database object. Keep in mind
that a database object could update or affect other tables as well.
String: Table name of the target table of this database object
throws:
DataException - upon errorauthor Yves Henri AMAIZO |
| getTargetStoreProcedure | | public String getTargetStoreProcedure() throws DataException(Code) | | Return the Store procedure Name of the current database object. Keep in mind
that a database object could update or affect other tables as well.
String: Store procedure name of the target table of this database object
throws:
DataException - upon errorauthor Yves Henri AMAIZO |
| getTargetTable | | public String getTargetTable() throws DataException(Code) | | Return the Table Name of the current database object. Keep in mind
that a database object could update or affect other tables as well.
String: Table name of the target table of this database object
throws:
DataException - upon error |
| getTransitionsIterator | | public Iterator getTransitionsIterator() throws DBException(Code) | | ????????????
Iterator to the TransitionTabs |
| getType | | public String getType(String fieldName) throws DBException(Code) | | Return the type of a field - this method returns the internal Expresso type
Parameters:
fieldName - The name of the field String: The type of the field
throws:
DBException - If there is no such field in this object |
| hasField | | public boolean hasField(String fieldName)(Code) | | This method will return a boolean true if the field is defined in the DBOBject,
false otherwise.
Creation date: (8/8/00 11:04:32 AM)
Parameters:
fieldName - java.lang.String boolean |
| hasIndex | | public boolean hasIndex()(Code) | | Returns true if an Index exists for this array.
true if it has an index |
| isAllowsNull | | public boolean isAllowsNull(String fieldName) throws DBException(Code) | | Returns whether the field allows null values or not.
Parameters:
fieldName - name of the field true if the field allows null |
| isField | | public boolean isField(String fieldName)(Code) | | Check if a certain name is a field (of any kind) in this DBOBject
Parameters:
fieldName - the name of the field to check true if the field name exists |
| isFieldIgnoreCase | | public String isFieldIgnoreCase(String fieldName)(Code) | | Check if a certain name is a field (of any kind) in this DBOBject
since SQL is case insensitive, ignore case of field name for match,
this method takes longer, so use isField if the field name is known precisely
Parameters:
fieldName - the name of the field to check internal format for field name if matched, or null if no match |
| isInField | | public boolean isInField(String fieldName)(Code) | | Check if a certain name is a OUTPUT field parameter(of any kind) in this DBOBject
Parameters:
fieldName - the name of the field to check true if the field name exists |
| isLoggingEnabled | | public boolean isLoggingEnabled()(Code) | | |
| isMultiValued | | public synchronized boolean isMultiValued(String fieldName) throws DBException(Code) | | Method called to determine if a particular field is multi-valued,
that is does it have a set of specific values and descriptions
Parameters:
fieldName - Name of the field boolean True if the field is multi-valued, false if not
throws:
DBException - If there is no such field |
| isOutField | | public boolean isOutField(String fieldName)(Code) | | Check if a certain name is a INPUT field parameter(of any kind) in this DBOBject
Parameters:
fieldName - the name of the field to check true if the field name exists |
| isReadOnly | | public boolean isReadOnly(String fieldName) throws DBException(Code) | | Is a given field readOnly - these fields are not offered for entry
when a form is produced by the generic database maintenance servlet
Parameters:
fieldName - name of the field to check true of the field is "read only", false if it is not
throws:
DBException - Ff there is no such field |
| isReturningValue | | public boolean isReturningValue()(Code) | | |
| isSecret | | public boolean isSecret(String fieldName) throws DBException(Code) | | Is a given field 'secret' - these fields are not shown
when a list is produced by the generic database maintenance servlet (DBMaint).
This means that only users with update permission to the record can see the
value of the specified field.
Parameters:
fieldName - The name of the field to check True if the field is 'secret', false if it is not
throws:
DBException - If there is no such field.
See Also: DBObjectDef.setSecret(String) |
| removeAttribute | | public void removeAttribute(String fieldName, String attribName)(Code) | | Removes an attribute from the field.
Parameters:
fieldName - the name of the field to remove the attribute
Parameters:
attribName - the attribute name to remove |
| setAttribute | | public synchronized void setAttribute(String fieldName, String attribName, Object attribValue) throws DBException(Code) | |
Parameters:
fieldName - the name of the field to set the attribute for
Parameters:
attribName - the name of the attribute to set
Parameters:
attribValue - the attribute to set |
| setCacheSize | | public void setCacheSize(int newValue)(Code) | | Sets the cache size for this DBObject
Parameters:
newValue - the new value. Must be >= -2
throws:
IllegalArgumentException - if newValue < -2 |
| setCheckZeroUpdate | | public synchronized void setCheckZeroUpdate(boolean newFlag)(Code) | | Turn on or off the facility to verify that when an update is made that at
least one record got updated. If this flag is on, and no records get updated,
the update() method throws an Exception. Note that for some databases, if the
existing record is not changed (e.g. it was already identical to what
was being updated) this counts "no update" (notably, mySQL does this).
Parameters:
newFlag - True to turn on checking, false to turn it off |
| setDefaultValue | | public synchronized void setDefaultValue(String fieldName, String fieldValue) throws DBException(Code) | | Sets the default value for a particular field
Parameters:
fieldName - The name of the field to set
Parameters:
fieldValue - the default value to use
throws:
DBException - upon error |
| setDescription | | public synchronized void setDescription(String newDescription)(Code) | | Set the description of this object
Parameters:
newDescription - A description of this database object |
| setLookupObject | | public synchronized void setLookupObject(String fieldName, String objectName) throws DBException(Code) | | Set a field's lookup object - this is the name of another database
object that can be used to look up valid values for this object. This value
is used by the DBMaint servlet to provide automatic lookup ability for
related fields.
Parameters:
fieldName - The field name that this lookup is associated with
Parameters:
objectName - The db object used to look up valid values for this field. |
| setMask | | public synchronized void setMask(String fieldName, String newMask) throws DBException(Code) | | Sets the field's regular expression validation mask. It also precompiles
the regular expression when it is called.
Parameters:
fieldName - The field name to associate with this regular expression
Parameters:
newMask - The actual regular expression. |
| setMultiValued | | public synchronized void setMultiValued(String fieldName) throws DBException(Code) | | Set this field to be multi-valued - e.g. there is a specific list of
values that are valid for this field. There should be code in the
getValidValues method that returns the valid values for the specified
multi-valued field.
Parameters:
fieldName - The name of the field to specify as multi-valued
throws:
DBException - If the field name given is not valid, or is a virtual field |
| setName | | public synchronized void setName(String theName)(Code) | | Set the name of this object - this name is used to identify the db object
with a more human-readable description
Parameters:
theName - New name for this object |
| setReadOnly | | public synchronized void setReadOnly(String fieldName) throws DBException(Code) | | Set a field as read-only - these fields are not offered for update
when a form is produced by the generic database maintenance servlet
(DBMaint). It does not otherwise affect the use of the field.
Typical uses are for serial-numbered fields and timestamps
Parameters:
fieldName - The name of the field to be reserved as normally read-only.
throws:
DBException - If there is no such field. |
| setReturningValue | | public void setReturningValue(boolean value)(Code) | |
Parameters:
value - returning value to be set |
| setSchema | | public synchronized void setSchema(String schemaName)(Code) | |
Parameters:
schemaName - the name of the schema |
| setSecret | | public synchronized void setSecret(String fieldName) throws DBException(Code) | | Set a field as 'secret' - these fields are not shown
when a list is produced by the generic database maintenance servlet. In
this way, only users with update permission to the object can view the
values of "secret" fields.
Parameters:
fieldName - The name of the field to set as 'secret'
throws:
DBException - if the field does not exist |
| setStringFilter | | public synchronized void setStringFilter(String fieldName, String filterMethod) throws DBException(Code) | | Set a filter for a particular field. Check the documentation at
Parameters:
fieldName - The name of the field to set a particular filter for.
Parameters:
filterMethod - The name of the filter method to use when calling a filter.Can be one of three values:
See @seecom.jcorporate.expresso.core.security.filters.FilterManager.filterString formore information on this parameter.
throws:
DBException - if: fieldName doesn't exist, or filterType Stringisn't a valid value.
See Also: com.jcorporate.expresso.core.security.filters.FilterManager
See Also: for more information on Filters and implementing Filters for your own
See Also: characterset. |
| setTargetDbCatalog | | public synchronized void setTargetDbCatalog(String theCatalog) throws DBException(Code) | | Set the target database schema for this DBObject.
Parameters:
theCatalog - database schema for this object
throws:
DBException - author Yves Henri AMAIZO |
| setTargetDbSchema | | public synchronized void setTargetDbSchema(String theSchema) throws DBException(Code) | | Set the target database schema for this DBObject.
Parameters:
theSchema - database schema for this object
throws:
DBException - author Yves Henri AMAIZO |
| setTargetStoreProcedure | | public synchronized void setTargetStoreProcedure(String theStoreProcedure) throws DBException(Code) | | Set the target store procedure for this DBObject.
Parameters:
theStoreProcedure - Store procedure for this object |
| setTargetTable | | public synchronized void setTargetTable(String theTable) throws DBException(Code) | | Set the target table for this DBObject. Note that an object
can span tables by the use of virtual fields, but that this table
is the default table for the object.
Parameters:
theTable - Table for this object |
|
|