arlut.csd.ganymede
Class FieldTemplate

java.lang.Object
  |
  +--arlut.csd.ganymede.FieldTemplate

All Implemented Interfaces:

FieldType, java.io.Serializable

public class FieldTemplate

extends java.lang.Object

implements java.io.Serializable, FieldType

This class is a serializable object used to return all the static information the client's containerPanel needs to render a specific kind of field. A FieldTemplate is basically a summary of the information that can be retrieved through the BaseField remote interface.

The FieldInfo object is used to return the value information associated with an actual instance of a field.

See Also:

Serialized Form

Field Summary

(package private) short	allowedTarget
(package private) java.lang.String	badChars
(package private) short	baseID
(package private) boolean	builtIn
(package private) java.lang.String	comment
(package private) boolean	crypted
(package private) boolean	editInPlace
(package private) java.lang.String	falseLabel
(package private) short	fieldID
(package private) boolean	labeled
(package private) short	limit
(package private) short	maxLength
(package private) boolean	md5crypted
(package private) short	minLength
(package private) boolean	multiLine
(package private) java.lang.String	name
(package private) java.lang.String	okChars
(package private) java.lang.String	regexpPat
(package private) static long	serialVersionUID
(package private) java.lang.String	trueLabel
(package private) short	type
(package private) boolean	vector

Fields inherited from interface arlut.csd.ganymede.FieldType

BOOLEAN, DATE, FIRSTFIELD, FLOAT, INVID, IP, LASTFIELD, NUMERIC, PASSWORD, PERMISSIONMATRIX, STRING

Constructor Summary

FieldTemplate(arlut.csd.ganymede.DBObjectBaseField fieldDef)

Method Summary

java.lang.String	getBadChars() If this field is a STRING and a limited set of characters are not acceptable in this field, returns those characters.
short	getBaseID() Returns the object type number for the object containing this field.
java.lang.String	getComment() Returns a description of this field suitable for a tooltip.
java.lang.String	getFalseLabel() If this field is a BOOLEAN and isLabeled() is true, returns the text to be associated with the false choice.
short	getID() Returns the field number for this field.
short	getMaxLength() If this field is a STRING, returns the maximum acceptable length for this field.
short	getMinLength() If this field is a STRING, returns the minimum acceptable length for this field.
java.lang.String	getName() Returns the name of this field.
java.lang.String	getOKChars() If this field is a STRING and a limited set of characters are acceptable in this field, returns those characters.
java.lang.String	getRegexpPat() If this field is a STRING and a regular expression has been set to limit acceptable strings in this field, returns the regexp patter string.
short	getTargetBase() If this field is an INVID and is configured to point to an object of a certain type, returns the object type this field points to. This method will return a negative value if this field can point to objects of differing types.
java.lang.String	getTrueLabel() If this field is a BOOLEAN and isLabeled() is true, returns the text to be associated with the true choice.
short	getType() Returns a type identifier for this field.
boolean	isArray() Returns true if this field is a vector.
boolean	isBoolean() Returns true if this field is of boolean type
boolean	isBuiltIn() Returns true if this field is one of the standard fields that are part of all objects held in the Ganymede server.
boolean	isCrypted() If this field is a PASSWORD, returns true if passwords are stored in this field in UNIX Crypt() form.
boolean	isDate() Returns true if this field is of date type
boolean	isEditInPlace() If this field is an INVID, returns true if this field refers to an 'embedded' object.
boolean	isFloat() Returns true if this field is of float type
boolean	isInvid() Returns true if this field is of invid type
boolean	isIP() Returns true if this field is of IP type
boolean	isLabeled() If this field is a BOOLEAN, returns true if this field should be presented as a pair of radio boxes labeled by getTrueLabel() and getFalseLabel().
boolean	isMD5Crypted() If this field is a PASSWORD, returns true if passwords are stored in this field in BSD-style MD5Crypt() form.
boolean	isMultiLine() If this field is a STRING and this field has been configured to be a multiline string field, this method will return true.
boolean	isNumeric() Returns true if this field is of numeric type
boolean	isPassword() Returns true if this field is of password type
boolean	isPermMatrix() Returns true if this field is of permission matrix type
boolean	isString() Returns true if this field is of string type
java.lang.String	toString() debug instrumentation

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

serialVersionUID

static final long serialVersionUID

See Also:

Constant Field Values

name

java.lang.String name

comment

java.lang.String comment

type

short type

fieldID

short fieldID

vector

boolean vector

baseID

short baseID

builtIn

boolean builtIn

limit

short limit

labeled

boolean labeled

trueLabel

java.lang.String trueLabel

falseLabel

java.lang.String falseLabel

minLength

short minLength

maxLength

short maxLength

okChars

java.lang.String okChars

badChars

java.lang.String badChars

multiLine

boolean multiLine

regexpPat

java.lang.String regexpPat

editInPlace

boolean editInPlace

allowedTarget

short allowedTarget

crypted

boolean crypted

md5crypted

boolean md5crypted

Constructor Detail

FieldTemplate

public FieldTemplate(arlut.csd.ganymede.DBObjectBaseField fieldDef)

Method Detail

getType

public short getType()

Returns a type identifier for this field.

See Also:

FieldType

getID

public short getID()

Returns the field number for this field.

getBaseID

public short getBaseID()

Returns the object type number for the object containing this field.

getName

public java.lang.String getName()

Returns the name of this field.

getComment

public java.lang.String getComment()

Returns a description of this field suitable for a tooltip.

isArray

public boolean isArray()

Returns true if this field is a vector.

isBoolean

public boolean isBoolean()

Returns true if this field is of boolean type

See Also:

BaseField

isNumeric

public boolean isNumeric()

Returns true if this field is of numeric type

See Also:

BaseField

isDate

public boolean isDate()

Returns true if this field is of date type

See Also:

BaseField

isString

public boolean isString()

Returns true if this field is of string type

See Also:

BaseField

isInvid

public boolean isInvid()

Returns true if this field is of invid type

See Also:

BaseField

isPermMatrix

public boolean isPermMatrix()

Returns true if this field is of permission matrix type

See Also:

BaseField

isPassword

public boolean isPassword()

Returns true if this field is of password type

See Also:

BaseField

isIP

public boolean isIP()

Returns true if this field is of IP type

See Also:

BaseField

isFloat

public boolean isFloat()

Returns true if this field is of float type

See Also:

BaseField

isBuiltIn

public boolean isBuiltIn()

Returns true if this field is one of the standard fields that are part of all objects held in the Ganymede server.

isLabeled

public boolean isLabeled()

If this field is a BOOLEAN, returns true if this field should be presented as a pair of radio boxes labeled by getTrueLabel() and getFalseLabel().

getTrueLabel

public java.lang.String getTrueLabel()

If this field is a BOOLEAN and isLabeled() is true, returns the text to be associated with the true choice.

getFalseLabel

public java.lang.String getFalseLabel()

If this field is a BOOLEAN and isLabeled() is true, returns the text to be associated with the false choice.

getMinLength

public short getMinLength()

If this field is a STRING, returns the minimum acceptable length for this field.

getMaxLength

public short getMaxLength()

If this field is a STRING, returns the maximum acceptable length for this field.

getOKChars

public java.lang.String getOKChars()

If this field is a STRING and a limited set of characters are acceptable in this field, returns those characters.

getBadChars

public java.lang.String getBadChars()

If this field is a STRING and a limited set of characters are not acceptable in this field, returns those characters.

getRegexpPat

public java.lang.String getRegexpPat()

If this field is a STRING and a regular expression has been set to limit acceptable strings in this field, returns the regexp patter string.

isMultiLine

public boolean isMultiLine()

If this field is a STRING and this field has been configured to be a multiline string field, this method will return true.

isEditInPlace

public boolean isEditInPlace()

If this field is an INVID, returns true if this field refers to an 'embedded' object.

getTargetBase

public short getTargetBase()

If this field is an INVID and is configured to point to an object of a certain type, returns the object type this field points to.

This method will return a negative value if this field can point to objects of differing types.

isCrypted

public boolean isCrypted()

If this field is a PASSWORD, returns true if passwords are stored in this field in UNIX Crypt() form.

isMD5Crypted

public boolean isMD5Crypted()

If this field is a PASSWORD, returns true if passwords are stored in this field in BSD-style MD5Crypt() form.

toString

public java.lang.String toString()

debug instrumentation

Overrides:

toString in class java.lang.Object