org.apache.turbine.services.intake
Class IntakeTool.PullHelper

java.lang.Object
  org.apache.turbine.services.intake.IntakeTool.PullHelper

Enclosing class:

IntakeTool

public class IntakeTool.PullHelper

extends java.lang.Object

Inner class to present a nice interface to the template designer

Method Summary

Group	getDefault() Populates the object with the default values from the XML File
Group	mapTo(Retrievable obj) maps an Intake Group to the values from a Retrievable object.
Group	setKey(java.lang.String key) Calls setKey(key,true)
Group	setKey(java.lang.String key, boolean create)

Methods inherited from class java.lang.Object

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

Method Detail

getDefault

public Group getDefault()
                 throws IntakeException

Populates the object with the default values from the XML File

Returns:

a Group object with the default values

Throws:

IntakeException

setKey

public Group setKey(java.lang.String key)
             throws IntakeException

Calls setKey(key,true)

Parameters:

key -

Returns:

an Intake Group

Throws:

IntakeException

setKey

public Group setKey(java.lang.String key,
                    boolean create)
             throws IntakeException

Parameters:

key -

create -

Returns:

an Intake Group

Throws:

IntakeException

mapTo

public Group mapTo(Retrievable obj)
            throws IntakeException

maps an Intake Group to the values from a Retrievable object.

Parameters:

obj - A retrievable object

Returns:

an Intake Group

Throws:

IntakeException