|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.turbine.services.intake.IntakeTool
public class IntakeTool
The main class through which Intake is accessed. Provides easy access to the Fulcrum Intake component.
Nested Class Summary | |
---|---|
class |
IntakeTool.PullHelper
Inner class to present a nice interface to the template designer |
Field Summary | |
---|---|
static String |
DEFAULT_KEY
Constant for default key |
protected HashMap<String,org.apache.fulcrum.intake.model.Group> |
groups
Groups from intake.xml |
static String |
INTAKE_GRP
Constant for the hidden fieldname |
protected static org.apache.commons.logging.Log |
log
Used for logging |
protected org.apache.fulcrum.parser.ValueParser |
pp
ValueParser instance |
Constructor Summary | |
---|---|
IntakeTool()
Constructor |
Method Summary | |
---|---|
void |
addGroupsToParameters(org.apache.fulcrum.parser.ValueParser vp)
|
String |
declareGroup(org.apache.fulcrum.intake.model.Group group)
A convenience method to write out the hidden form fields that notify intake of the group. |
void |
declareGroup(org.apache.fulcrum.intake.model.Group group,
StringBuffer sb)
xhtml valid hidden input field(s) that notifies intake of the group's presence. |
String |
declareGroups()
A convenience method to write out the hidden form fields that notify intake of the relevant groups. |
void |
dispose()
Disposes the object after use. |
IntakeTool.PullHelper |
get(String groupName)
get a specific group |
IntakeTool.PullHelper |
get(String groupName,
boolean throwExceptions)
Get a specific group |
org.apache.fulcrum.intake.model.Group |
get(String groupName,
String key)
Get a specific group by name and key. |
org.apache.fulcrum.intake.model.Group |
get(String groupName,
String key,
boolean create)
Get a specific group by name and key. |
Map |
getGroups()
Get a Map containing all the groups. |
void |
init(Object runData)
Prepares intake for a single request |
boolean |
isAllValid()
Loops through all of the Groups and checks to see if the data within the Group is valid. |
boolean |
isDisposed()
Checks whether the recyclable has been disposed. |
void |
newForm()
|
void |
recycle()
Recycles the object for a new client. |
void |
refresh()
Implementation of ApplicationTool interface is not needed for this tool as it is request scoped |
void |
remove(org.apache.fulcrum.intake.model.Group group)
Removes group. |
void |
removeAll()
Removes all groups. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected static org.apache.commons.logging.Log log
public static final String DEFAULT_KEY
public static final String INTAKE_GRP
protected HashMap<String,org.apache.fulcrum.intake.model.Group> groups
protected org.apache.fulcrum.parser.ValueParser pp
Constructor Detail |
---|
public IntakeTool()
Method Detail |
---|
public void init(Object runData)
init
in interface ApplicationTool
runData
- initialization datapublic void addGroupsToParameters(org.apache.fulcrum.parser.ValueParser vp)
public String declareGroups()
public String declareGroup(org.apache.fulcrum.intake.model.Group group)
public void declareGroup(org.apache.fulcrum.intake.model.Group group, StringBuffer sb)
public void newForm()
public void refresh()
refresh
in interface ApplicationTool
public IntakeTool.PullHelper get(String groupName)
public IntakeTool.PullHelper get(String groupName, boolean throwExceptions) throws org.apache.fulcrum.intake.IntakeException
throwExceptions
- if false, exceptions will be supressed.
org.apache.fulcrum.intake.IntakeException
- could not retrieve grouppublic boolean isAllValid()
public org.apache.fulcrum.intake.model.Group get(String groupName, String key) throws org.apache.fulcrum.intake.IntakeException
org.apache.fulcrum.intake.IntakeException
public org.apache.fulcrum.intake.model.Group get(String groupName, String key, boolean create) throws org.apache.fulcrum.intake.IntakeException
org.apache.fulcrum.intake.IntakeException
public void remove(org.apache.fulcrum.intake.model.Group group)
public void removeAll()
public Map getGroups()
public void recycle()
recycle
in interface org.apache.fulcrum.pool.Recyclable
public void dispose()
dispose
in interface org.apache.fulcrum.pool.Recyclable
public boolean isDisposed()
isDisposed
in interface org.apache.fulcrum.pool.Recyclable
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |