|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--org.apache.turbine.services.intake.model.Group
Holds a group of Fields
Field Summary | |
protected RunData |
data
The object containing the request data |
private boolean |
disposed
|
static java.lang.String |
EMPTY
|
protected java.util.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 java.lang.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 java.util.Map |
mapToObjectFields
Map of the fields by mapToObject |
protected java.lang.String |
name
The name used in templates and java code to refer to this group. |
static java.lang.String |
NEW
|
protected java.lang.String |
oid
The object id used to associate this group to a bean for one request cycle |
private int |
poolCapacity
The number of Groups with the same name that will be pooled. |
Constructor Summary | |
Group(XmlGroup group)
Constructs a new Group based on the xml specification. |
Method Summary | |
void |
appendHtmlFormInput(java.lang.StringBuffer sb)
A xhtml valid hidden input field that notifies intake of the group's presence. |
void |
dispose()
Disposes the object after use. |
Field |
get(java.lang.String fieldName)
Get the Field . |
java.lang.String |
getGID()
Get the part of the key used to specify the group. |
java.lang.String |
getHtmlFormInput()
A xhtml valid hidden input field that notifies intake of the group's presence. |
java.lang.String |
getIntakeGroupName()
Return the name given to this group. |
java.lang.String |
getObjectKey()
Concatenation of gid and oid. |
java.util.ArrayList |
getObjects(RunData data)
Describe getObjects method here. |
java.lang.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. |
Group |
init(Retrievable obj)
Initializes the group with properties from an object. |
Group |
init(RunData data)
Initializes the default Group with parameters from RunData. |
Group |
init(java.lang.String key,
RunData data)
Initializes the Group with parameters from RunData corresponding to key. |
boolean |
isAllValid()
Performs an AND between all the fields in this group. |
boolean |
isDisposed()
Checks whether the recyclable has been disposed. |
void |
recycle()
Recycles the object for a new client. |
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(java.lang.Object obj)
Calls a setter methods on obj, for fields which have been set. |
Methods inherited from class java.lang.Object |
|
Field Detail |
public static final java.lang.String EMPTY
public static final java.lang.String NEW
protected final java.lang.String gid
protected final java.lang.String name
private final int poolCapacity
protected java.util.Map fields
protected java.util.Map mapToObjectFields
protected Field[] fieldsArray
protected java.lang.String oid
protected RunData data
protected boolean isDeclared
private boolean disposed
Constructor Detail |
public Group(XmlGroup group) throws java.lang.Exception
group
- a XmlGroup
valuejava.lang.Exception
- if an error occurs in other classesMethod Detail |
public Group init(RunData data) throws TurbineException
data
- a RunData
valuepublic Group init(java.lang.String key, RunData data) throws TurbineException
data
- a RunData
valuepublic Group init(Retrievable obj)
obj
- a Persistent
valueGroup
valuepublic java.lang.String getIntakeGroupName()
String
valuepublic int getPoolCapacity()
int
valuepublic java.lang.String getGID()
String
valuepublic java.lang.String getOID()
String
valuepublic java.lang.String getObjectKey()
String
valuepublic java.util.ArrayList getObjects(RunData data) throws TurbineException
getObjects
method here.pp
- a ParameterParser
valueArrayList
valueTurbineException
- if an error occurspublic Field get(java.lang.String fieldName) throws TurbineException
public boolean isAllValid()
boolean
valuepublic void setProperties(java.lang.Object obj) throws TurbineException
throws
- up any exceptions resulting from failure to
check input validity.public void removeFromRequest()
public void resetDeclared()
public java.lang.String getHtmlFormInput()
String
valuepublic void appendHtmlFormInput(java.lang.StringBuffer sb)
public void recycle()
recycle
in interface Recyclable
public void dispose()
dispose
in interface Recyclable
public boolean isDisposed()
isDisposed
in interface Recyclable
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |