|
| |
|
| com.jcorporate.expresso.core.dataobjects.DataFieldMetaData
All known Subclasses: com.jcorporate.expresso.core.dbobj.DBField,
| DataFieldMetaData | | public interface DataFieldMetaData (Code) | | This interface will eventually have the same public functionality as
DBField. It is just used as "Interface"e; glue right
now. It will be fleshed out significantly in future versions.
This interface represents the descriptive data for a particular DataField.
author:
Michael Rimov
since:
Expresso 5.0 |
| allowsNull | | public boolean allowsNull()(Code) | | Does this field allow nulls?
boolean True if the field allows null, else false if it does not |
| getAllAttributes | | public java.util.Set getAllAttributes()(Code) | | Retrieve a list of all attribute names in the field
java.util.Set |
| getAttribute | | public Object getAttribute(String attribName)(Code) | | Returns an attribute keyed by name. An attribute is an arbitrary object
you can associate with a particular db field.
Parameters:
attribName - the name of the attribute to get java.lang.Object the object associated with this attribute name |
| getAttributesIterator | | public Iterator getAttributesIterator()(Code) | | Returns a copy of all attributes associated with this field.
a valid Iterator to a HashMap OR null if no attributes exist forthis field |
| getDefaultValue | | public String getDefaultValue()(Code) | | Retrieve the default value of the field.
String java.lang.String |
| getDescription | | public String getDescription()(Code) | | Return the description of this field. This field name is not i18n'ized,
use DataObjectMetaData with Locale parameter to get the i18n'ized escription
String Description of the field |
| getLengthInt | | public int getLengthInt()(Code) | | Return the length of this field as an integer
int The length of this field in characters |
| getLookupDefinition | | public String getLookupDefinition()(Code) | | Future versions of Expresso will rely more on objects that are shown as
unique by a combination of their classname and their definition names. All
instances of Defineable must have a corresponding definition name.
java.lang.String |
| getLookupField | | public String getLookupField()(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.
java.lang.String or null if there is no lookup field
throws:
IllegalArgumentException - if the field name does not exist |
| getLookupObject | | public String getLookupObject()(Code) | | Return the value for the lookupObject for this field
String for the lookup object for this field |
| getMask | | public Pattern getMask()(Code) | | Get the compiled regular expression for this field.
the precompiled regular expression mask |
| getName | | public String getName()(Code) | | Return the name of the field
String The name of this field |
| getPrecision | | public int getPrecision()(Code) | | Return the precision of this field as an integer
int The precision of this field |
| getTypeString | | public String getTypeString()(Code) | | Return the database type of the field as specified with a
string in the DBObject itself
The type of this field |
| isAutoIncremented | | public boolean isAutoIncremented()(Code) | | Is this field an auto-incremented field?
true if this field is autoincremented |
| isBinaryObjectType | | public boolean isBinaryObjectType()(Code) | | Is it a BLOB? This is calculated by if it is a long object
and is NOT a character long object.
boolean True if it is |
| isBooleanType | | public boolean isBooleanType()(Code) | | is the field a boolean?
cache answer for efficiency, since field type is immutable
True if the field is boolean |
| isCharacterLongObjectType | | public boolean isCharacterLongObjectType()(Code) | | Is this field fall into the classification of a long character
object?
boolean true if it does |
| isDateOnlyType | | public boolean isDateOnlyType()(Code) | | is the field a date or time field?
cache answer for efficiency, since field type is immutable
author Yves Henri AMAIZO
true if the field is date field |
| isDateTimeType | | public boolean isDateTimeType()(Code) | | is the field a date or time field?
cache answer for efficiency, since field type is immutable
author Yves Henri AMAIZO
true if the field is dateTime or Timestamp field |
| isDateType | | public boolean isDateType()(Code) | | is the field a date or time field?
cache answer for efficiency, since field type is immutable
true if the field is date or time field |
| isEncrypted | | public boolean isEncrypted()(Code) | | Return the field's hashed status
True if the field is secret, else false if it is not |
| isFloatingPointType | | public boolean isFloatingPointType()(Code) | | |
| isHashed | | public boolean isHashed()(Code) | | Return the field's hashed status
True if the field is secret, else false if it is not |
| isKey | | public boolean isKey()(Code) | | Is this field a key field?
true if this field is a key field |
| isLongBinaryType | | public boolean isLongBinaryType()(Code) | | Is it a BLOB? This is calculated by if it is a long object
and is NOT a character long object.
boolean True if it is |
| isLongCharacterType | | public boolean isLongCharacterType()(Code) | | Is it a BLOB? This is calculated by if it is a long object
and is NOT a character long object.
boolean True if it is |
| isLongObjectType | | public boolean isLongObjectType()(Code) | | Does this field fall into a class of BLOB object data types?
boolean true if it does |
| isMasked | | public boolean isMasked()(Code) | | Return boolean if the field has a mask set
True if the field mask is set, else false if it is not |
| isMultiValued | | public boolean isMultiValued()(Code) | | Is this field multi-valued?
boolean True if the field is multi-valued, else false |
| isNumericType | | public boolean isNumericType()(Code) | | is the field a numeric field?
cache answer for efficiency, since field type is immutable
true if the field is numberic field |
| isQuotedTextType | | public boolean isQuotedTextType()(Code) | | is the field a quoted text field?
cache answer for efficiency, since field type is immutable
True if the field is text field |
| isReadOnly | | public boolean isReadOnly()(Code) | | Return the field's read-only
True if the field is readonly, else false if it is not |
| isSecret | | public boolean isSecret()(Code) | | Return the field's secret status
True if the field is secret, else false if it is not |
| isTimeType | | public boolean isTimeType()(Code) | | is the field a date or time field?
cache answer for efficiency, since field type is immutable
author Yves Henri AMAIZO
true if the field is time field |
| isVirtual | | public boolean isVirtual()(Code) | | Is this field a virtual field? E.g. not stored in the database
boolean True if the field is virtual, else false |
| removeAttribute | | public void removeAttribute(String attribName)(Code) | | Removes an attribute from this Field object.
Parameters:
attribName - The name of the attribute to remove from this field. |
| setAttribute | | public void setAttribute(String attribName, Object attribValue)(Code) | | Sets an attribute for this particular field.
Parameters:
attribName - the name of the attribute
Parameters:
attribValue - the value of the attribute by this name |
| setDefaultValue | | public void setDefaultValue(String newValue)(Code) | | Sets the new default value as a string for the field.
Parameters:
newValue - String |
| setEncrypted | | public void setEncrypted(boolean newValue)(Code) | | Set the field's encrypted status
Parameters:
newValue - new value if you want an encrypted field |
| setHashed | | public void setHashed(boolean newValue)(Code) | | Set the field's hashed status. Only works if the field is a string
data type (in the future CLOB should be ok too) [This is currently not
yet implemented and tested]
Parameters:
newValue - true if you want this field hashed. |
| setKey | | public void setKey(boolean newKey)(Code) | | Set this field as a key field (or not)
Parameters:
newKey - Is this field a key? |
| setLookupObject | | public void setLookupObject(String objectName)(Code) | | Set the value for the "lookup object" for this field. This is
a database object name which can be used to look up valid
values for this field by the user. This is used by the standard
maintenance forms to create a "Lookup" link alongside the
field if this value is set
Parameters:
objectName - the classname of the lookup object |
| setMask | | public void setMask(Pattern newMask)(Code) | | Set a regular expression "mask" for this field that specifies it's
valid values. The mask should already be compiled by the regular
expression compiler
Parameters:
newMask - The compiled regular expression mask |
| setMultiValued | | public void setMultiValued(boolean newMulti)(Code) | | Set this field to be "multi-valued". A multi-valued field has
a specific set of valid values, often from another database
object. Any multi-valued field may be used in a call to the
getValues method, which will return a hashtable of the valid
values for the field and descriptions for those values.
Parameters:
newMulti - True if the field is multi-valued, false if it is not |
| setReadOnly | | public void setReadOnly()(Code) | | Set the field as a read-only field. Read only fields are still used
against the database, but are not offered for updating when the
automatic database maintenance servlet creates a form on the screen. Note
this is different from the setAutoIncremented method below, which
means this field will not participate in any add or update statement
to the database.
|
| setSecret | | public void setSecret()(Code) | | Set the field as a 'secret' field. Secret fields are not shown
in listings of data from this database object, and are only available
to users with update, add or delete permissions
|
| setVirtual | | public void setVirtual(boolean newVirtual)(Code) | | Set this field as a virtual field. A virtual field is part of the object
but not stored in the database table.
Parameters:
newVirtual - True to make this object virtual, false if it is not |
|
|
|