|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.avalon.framework.logger.AbstractLogEnabled
org.outerj.xreporter.report.instance.Step
A Step object represents a step in the user-interaction where parameters
and conditions are gathered. A Step has a reference to a
StepDefinition
, and
contains values for the parameters and conditions of this step. It also
keeps track of which temporary tables are created.
Nested Class Summary | |
class |
Step.StepExecutionContext
|
class |
Step.StepExpressionContext
|
Field Summary | |
protected boolean |
completed
|
protected ExpressionContext |
expressionContext
|
protected InputFields |
inputFields
|
static java.lang.String |
NAME_ATTR
|
protected Step |
nextStep
reference to the next step, null is the sentinel |
protected Step |
previousStep
|
protected ReportImpl |
reportImpl
The ReportImpl to which this step belongs |
static java.lang.String |
STEP_EL
|
protected StepDefinition |
stepDefinition
|
protected Step.StepExecutionContext |
stepExecutionContext
|
protected boolean |
storedFieldsRead
Indicates wether entry field value stored on user-basis have already been retrieved. |
protected java.util.HashSet |
tempTableNames
|
Constructor Summary | |
Step(StepDefinition stepDefinition,
ReportImpl report)
Important: any Avalon interfaces implemented by this object should be respected. |
Method Summary | |
boolean |
areAllInputFieldsValid()
|
void |
dispose()
Cleans up resources used by this step, currently these are the temporary tables. |
protected void |
execute()
|
void |
generateInfoSaxFragment(org.xml.sax.ContentHandler contentHandler,
ResourceHandle resourceHandle)
|
void |
generateSaxFragment(org.xml.sax.ContentHandler contentHandler,
ResourceHandle resourceHandle)
|
InputField |
getInputField(java.lang.String name)
|
InputFields |
getInputFields()
|
java.lang.String |
getName()
|
boolean |
hasInteraction()
|
boolean |
isComplete()
|
boolean |
isPreviousStepCompleted()
|
void |
process()
Performs post-processing after the input of a step has been completed: executes the execution-steps, and stores the user entries. |
protected void |
readStoredEntries()
|
void |
resetAllStepsFromHere()
|
InputField |
searchInputFieldBackward(java.lang.String name)
|
InputField |
searchInputFieldForward(java.lang.String name)
|
void |
setNextStep(Step nextStep)
|
void |
setPreviousStep(Step prevStep)
|
protected void |
storeEntries()
|
void |
storeState(ReportState reportState)
|
void |
submit(java.util.Map values)
|
void |
submit(java.util.Map values,
boolean rawLocale)
|
Methods inherited from class org.apache.avalon.framework.logger.AbstractLogEnabled |
enableLogging, getLogger, setupLogger, setupLogger, setupLogger |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
protected ReportImpl reportImpl
protected InputFields inputFields
protected java.util.HashSet tempTableNames
protected Step nextStep
protected Step previousStep
protected StepDefinition stepDefinition
protected boolean completed
protected Step.StepExecutionContext stepExecutionContext
protected ExpressionContext expressionContext
protected boolean storedFieldsRead
public static final java.lang.String STEP_EL
public static final java.lang.String NAME_ATTR
Constructor Detail |
public Step(StepDefinition stepDefinition, ReportImpl report)
Method Detail |
public void setNextStep(Step nextStep)
public void setPreviousStep(Step prevStep)
public InputFields getInputFields()
public InputField getInputField(java.lang.String name)
public boolean hasInteraction()
public InputField searchInputFieldForward(java.lang.String name)
public InputField searchInputFieldBackward(java.lang.String name)
public boolean isComplete()
public java.lang.String getName()
public void generateSaxFragment(org.xml.sax.ContentHandler contentHandler, ResourceHandle resourceHandle) throws java.lang.Exception
java.lang.Exception
public void generateInfoSaxFragment(org.xml.sax.ContentHandler contentHandler, ResourceHandle resourceHandle) throws org.xml.sax.SAXException
org.xml.sax.SAXException
public boolean areAllInputFieldsValid()
protected void execute() throws ExecuteException
ExecuteException
public void process() throws ExecuteException, UserEntryStoreException
ExecuteException
UserEntryStoreException
public boolean isPreviousStepCompleted()
public void resetAllStepsFromHere()
public void submit(java.util.Map values, boolean rawLocale)
public void submit(java.util.Map values)
public void dispose()
protected void readStoredEntries() throws UserEntryStoreException
UserEntryStoreException
protected void storeEntries() throws UserEntryStoreException
UserEntryStoreException
public void storeState(ReportState reportState)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |