|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.apache.fulcrum.intake.model.Group
public class Group
Holds a group of Fields
| Nested Class Summary | |
|---|---|
static class |
Group.GroupFactory
|
| Field Summary | |
|---|---|
static String |
EMPTY
|
protected Map |
fields
A map of the fields in this group mapped by field name. |
protected Field[] |
fieldsArray
An array of fields in this group. |
protected String |
gid
The key used to represent this group in a parameter. |
protected boolean |
isDeclared
A flag to help prevent duplicate hidden fields declaring this group. |
protected Map |
mapToObjectFields
Map of the fields by mapToObject |
protected String |
name
The name used in templates and java code to refer to this group. |
static String |
NEW
|
protected String |
oid
The object id used to associate this group to a bean for one request cycle |
protected org.apache.fulcrum.parser.ValueParser |
pp
The object containing the request data |
| Constructor Summary | |
|---|---|
Group(XmlGroup group)
Constructs a new Group based on the xml specification. |
|
| Method Summary | |
|---|---|
void |
appendHtmlFormInput(StringBuffer sb)
A xhtml valid hidden input field that notifies intake of the group's presence. |
Field |
get(String fieldName)
Get the Field . |
String[] |
getFieldNames()
Gets a list of the names of the fields stored in this object. |
String |
getGID()
Get the part of the key used to specify the group. |
String |
getHtmlFormInput()
A xhtml valid hidden input field that notifies intake of the group's presence. |
String |
getIntakeGroupName()
Return the name given to this group. |
String |
getObjectKey()
Concatenation of gid and oid. |
ArrayList |
getObjects(org.apache.fulcrum.parser.ValueParser pp)
Describe getObjects method here. |
String |
getOID()
Get the part of the key that distinguishes a group from others of the same name. |
int |
getPoolCapacity()
Get the number of Group objects that will be pooled. |
void |
getProperties(Object obj)
Calls getter methods on objects that are known to Intake so that field values in forms can be initialized from the values contained in the intake tool. |
Group |
init(Retrievable obj)
Initializes the group with properties from an object. |
Group |
init(String key,
org.apache.fulcrum.parser.ValueParser pp)
Initializes the Group with parameters from RunData corresponding to key. |
Group |
init(org.apache.fulcrum.parser.ValueParser pp)
Initializes the default Group using parameters. |
boolean |
isAllValid()
Performs an AND between all the fields in this group. |
void |
removeFromRequest()
Removes references to this group and its fields from the query parameters |
void |
resetDeclared()
To be used in the event this group is used within multiple forms within the same template. |
void |
setProperties(Object obj)
Calls a setter methods on obj, for fields which have been set. |
void |
setValidProperties(Object obj)
Calls a setter methods on obj, for fields which pass validity tests. |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
|---|
public static final String EMPTY
public static final String NEW
protected final String gid
protected final String name
protected Map fields
protected Map mapToObjectFields
protected Field[] fieldsArray
protected String oid
protected org.apache.fulcrum.parser.ValueParser pp
protected boolean isDeclared
| Constructor Detail |
|---|
public Group(XmlGroup group)
throws IntakeException
group - a XmlGroup value
IntakeException - if an error occurs in other classes| Method Detail |
|---|
public Group init(org.apache.fulcrum.parser.ValueParser pp)
throws IntakeException
pp - a ValueParser value
IntakeException
public Group init(String key,
org.apache.fulcrum.parser.ValueParser pp)
throws IntakeException
pp - a ValueParser value
IntakeExceptionpublic Group init(Retrievable obj)
obj - a Persistent value
Group valuepublic String[] getFieldNames()
public String getIntakeGroupName()
String valuepublic int getPoolCapacity()
int valuepublic String getGID()
String valuepublic String getOID()
String valuepublic String getObjectKey()
String value
public ArrayList getObjects(org.apache.fulcrum.parser.ValueParser pp)
throws IntakeException
getObjects method here.
pp - a ValueParser value
ArrayList value
IntakeException - if an error occurs
public Field get(String fieldName)
throws IntakeException
IntakeException - indicates the field could not be found.public boolean isAllValid()
boolean value
public void setProperties(Object obj)
throws IntakeException
obj - Object to be set with the values from the group.
IntakeException - indicates that a failure occurred while
executing the setter methods of the mapped object.public void setValidProperties(Object obj)
public void getProperties(Object obj)
throws IntakeException
obj - Object that will be used to as a source of data for
setting the values of the fields within the group.
IntakeException - indicates that a failure occurred while
executing the setter methods of the mapped object.public void removeFromRequest()
public void resetDeclared()
public String getHtmlFormInput()
String valuepublic void appendHtmlFormInput(StringBuffer sb)
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||