com.mizar.forms
Class FieldInfo

java.lang.Object
  extended by com.mizar.forms.FieldInfo

public class FieldInfo
extends java.lang.Object

See Also:
FormField

Field Summary
static int ANY
           
static int EQUAL
           
static int GREATER_THAN
           
static int LESS_THAN
           
static int NOT
           
 
Constructor Summary
FieldInfo()
           
FieldInfo(FormField fieldAnnotation)
           
FieldInfo(FormField fieldAnnotation, java.lang.String value)
           
FieldInfo(java.lang.String label)
           
 
Method Summary
 int getCompareType()
           
 java.lang.String getDesc()
           
 java.lang.String getGroup()
           
 java.lang.String getLabel()
           
 int getOrder()
           
 java.lang.String getSelectProperty()
          Sometimes we create Transient methods for display but want to use a normal property to select For example we might display fullAddress which combines street number, direction, name, and suffix but want to just search on street name.
 java.lang.String getValue()
           
 boolean isDisplay()
           
 boolean isEditable()
           
 boolean isIgnoreNulls()
           
 boolean isSkipRemaining()
           
 boolean isTraverse()
          We normally skip over any property that is not a sub class of Number or CharSequence but we might want to label our own properties if they are entities.
 void setCompareType(int compareType)
           
 void setDesc(java.lang.String desc)
           
 void setDisplay(boolean display)
           
 void setEditable(boolean editable)
           
 void setGroup(java.lang.String group)
           
 void setIgnoreNulls(boolean ignoreNulls)
           
 void setLabel(java.lang.String label)
           
 void setOrder(int order)
           
 void setSelectProperty(java.lang.String selectProperty)
          Sometimes we create Transient methods for display but want to use a normal property to select For example we might display fullAddress which combines street number, direction, name, and suffix but want to just search on street name.
 void setSkipRemaining(boolean skipRemaining)
           
 void setTraverse(boolean traverse)
           
 void setValue(java.lang.String value)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

EQUAL

public static final int EQUAL
See Also:
Constant Field Values

NOT

public static final int NOT
See Also:
Constant Field Values

GREATER_THAN

public static final int GREATER_THAN
See Also:
Constant Field Values

LESS_THAN

public static final int LESS_THAN
See Also:
Constant Field Values

ANY

public static final int ANY
See Also:
Constant Field Values
Constructor Detail

FieldInfo

public FieldInfo()

FieldInfo

public FieldInfo(java.lang.String label)
Parameters:
label -

FieldInfo

public FieldInfo(FormField fieldAnnotation)
Parameters:
fieldAnnotation -

FieldInfo

public FieldInfo(FormField fieldAnnotation,
                 java.lang.String value)
Parameters:
fieldAnnotation -
value -
Method Detail

setGroup

public void setGroup(java.lang.String group)
Parameters:
group - the group (or section) the field should appear in
See Also:
FormSections, FormField.group()

getGroup

public java.lang.String getGroup()
Returns:
the group (or section) the field should appear in
See Also:
FormSections, FormField.group()

setLabel

public void setLabel(java.lang.String label)
Parameters:
label -
See Also:
FormField.label()

getLabel

public java.lang.String getLabel()
Returns:
the label for the field
See Also:
FormField.label()

setDesc

public void setDesc(java.lang.String desc)

getDesc

public java.lang.String getDesc()

setSelectProperty

public void setSelectProperty(java.lang.String selectProperty)
Sometimes we create Transient methods for display but want to use a normal property to select For example we might display fullAddress which combines street number, direction, name, and suffix but want to just search on street name.

Parameters:
selectProperty -
See Also:
FormField.selectProperty()

getSelectProperty

public java.lang.String getSelectProperty()
Sometimes we create Transient methods for display but want to use a normal property to select For example we might display fullAddress which combines street number, direction, name, and suffix but want to just search on street name.

Returns:
the property name to select if it is not this property.
See Also:
FormField.selectProperty()

setValue

public void setValue(java.lang.String value)
Parameters:
value -

getValue

public java.lang.String getValue()
Returns:
the value of the field as a String

setDisplay

public void setDisplay(boolean display)
Parameters:
display -
See Also:
FormField.display()

isDisplay

public boolean isDisplay()
Returns:
true if field should be displayed
See Also:
FormField.display()

setEditable

public void setEditable(boolean editable)
Parameters:
editable -
See Also:
FormField.editable()

isEditable

public boolean isEditable()
Returns:
true if field is editable
See Also:
FormField.editable()

setIgnoreNulls

public void setIgnoreNulls(boolean ignoreNulls)
Parameters:
ignoreNulls -
See Also:
FormField.ignoreNulls()

isIgnoreNulls

public boolean isIgnoreNulls()
Returns:
if true do not display null values
See Also:
FormField.ignoreNulls()

setCompareType

public void setCompareType(int compareType)
Parameters:
compareType - may be one of the following:
  • FormField.EQUAL
  • FormField.NOT
  • FormField.GREATER_THAN
  • FormField.LESS_THAN
  • FormField.ANY
See Also:
FormField.compareType()

getCompareType

public int getCompareType()
Returns:
May be one of the following:
  • FormField.EQUAL
  • FormField.NOT
  • FormField.GREATER_THAN
  • FormField.LESS_THAN
  • FormField.ANY
See Also:
FormField.compareType()

setOrder

public void setOrder(int order)
Parameters:
order -
See Also:
FormField.order()

getOrder

public int getOrder()
Returns:
See Also:
FormField.order()

setTraverse

public void setTraverse(boolean traverse)
Parameters:
traverse -
See Also:
FormField.traverse()

isTraverse

public boolean isTraverse()
We normally skip over any property that is not a sub class of Number or CharSequence but we might want to label our own properties if they are entities.

Returns:
true if property is another entity class with labeled properties
See Also:
FormField.traverse()

setSkipRemaining

public void setSkipRemaining(boolean skipRemaining)
Parameters:
skipRemaining -
See Also:
FormField.skipRemaining()

isSkipRemaining

public boolean isSkipRemaining()
Returns:
if true stop processing any more fields
See Also:
FormField.skipRemaining()