Overview  Package   Class  Use  Deprecated  Index
Home >> All >> org >> infohazard >> maverick >> [ flow overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---

org.infohazard.maverick.flow
Class MaverickContext  

java.lang.Object
  org.infohazard.maverick.flow.MaverickContext

All Implemented Interfaces:

ControllerContext, TransformContext, ViewContext

---

public class MaverickContext

extends java.lang.Object

implements ControllerContext, ViewContext, TransformContext

MaverickContext is the concrete class which implements all the other contexts. Having one object minimizes object creation and data copying.

---

Field Summary
protected  java.util.Map	controllerParams            Our Controller's optional parameters, if any.
protected  org.infohazard.maverick.Dispatcher	dispatcher            Our org.infohazard.maverick.Dispatcher instance.
private static org.apache.commons.logging.Log	log            MaverickContext logger.
protected  java.lang.Object	model            Our instance of the "model" object that the Controller exposes to a View, so that dynamic data can be rendered.
protected  int	nextTransform            The index of the next transform to execute.
protected  javax.servlet.http.HttpServletRequest	request            Our javax.servlet.http.HttpServletRequest instance.
protected  javax.servlet.http.HttpServletResponse	response            Our javax.servlet.http.HttpServletResponse instance.
protected  int	transformCount            The count of transforms to execute.
protected  java.util.Map	transformParams            Our pipeline's optional parameters, if any.
protected  Transform[]	transforms            An array of pipeline transformations, which is set before the View is processed.
protected  java.util.Map	viewParams            Our View's optional parameters, if any.

 

Constructor Summary

MaverickContext(org.infohazard.maverick.Dispatcher disp, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res)            Convenience Constructor to pass instances of Dispatcher, HttpServletRequest, and HttpServletResponse.

 

Method Summary
protected  int	determineMaxTransforms()           Convenient method for obtaining the maximum number of transformations to allow in the pipeline.
java.util.Map	getControllerParams()
java.lang.Object	getModel()           Obtain the model which is to be rendered.
TransformStep	getNextStep()           This is where output should be sent.
javax.servlet.http.HttpServletResponse	getRealResponse()            Returns the *real* response object.
javax.servlet.http.HttpServletRequest	getRequest()            Returns our HttpServletRequest.
javax.servlet.http.HttpServletResponse	getResponse()            Returns our HttpServletResponse.
javax.servlet.ServletConfig	getServletConfig()            Returns our ServletConfig.
javax.servlet.ServletContext	getServletContext()           Basic data
java.util.Map	getTransformParams()           Obtain any params that were set.
java.util.Map	getViewParams()           Obtain any params that were set.
boolean	halting()
void	putAllControllerParams(java.util.Map addParams)           Appends to existing parameters.
void	putAllTransformParams(java.util.Map addParams)           Appends to existing parameters.
void	putAllViewParams(java.util.Map addParams)           Appends to existing parameters.
void	setControllerParam(java.lang.String name, java.lang.Object value)           Sets a parameter to the controller (not view or transforms).
void	setModel(java.lang.Object mod)           Set the model to be rendered.
void	setTransformParam(java.lang.String name, java.lang.Object value)           Sets a parameter to the transforms (not controller or view).
void	setTransforms(Transform[] trans)
void	setViewParam(java.lang.String name, java.lang.Object value)           Sets a parameter to the view (not controller or transforms).

 

Methods inherited from class java.lang.Object

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

 

Field Detail

log

private static org.apache.commons.logging.Log log

MaverickContext logger.

---

dispatcher

protected org.infohazard.maverick.Dispatcher dispatcher

Our org.infohazard.maverick.Dispatcher instance.

---

request

protected javax.servlet.http.HttpServletRequest request

Our javax.servlet.http.HttpServletRequest instance.

---

response

protected javax.servlet.http.HttpServletResponse response

Our javax.servlet.http.HttpServletResponse instance.

---

model

protected java.lang.Object model

Our instance of the "model" object that the Controller exposes to a View, so that dynamic data can be rendered. Most Maverick Controller will set the model object during processing.

---

controllerParams

protected java.util.Map controllerParams

Our Controller's optional parameters, if any.

---

viewParams

protected java.util.Map viewParams

Our View's optional parameters, if any.

---

transformParams

protected java.util.Map transformParams

Our pipeline's optional parameters, if any.

---

transforms

protected Transform[] transforms

An array of pipeline transformations, which is set before the View is processed.

---

nextTransform

protected int nextTransform

The index of the next transform to execute.

---

transformCount

protected int transformCount

The count of transforms to execute.

Constructor Detail

MaverickContext

public MaverickContext(org.infohazard.maverick.Dispatcher disp,
                       javax.servlet.http.HttpServletRequest req,
                       javax.servlet.http.HttpServletResponse res)

Convenience Constructor to pass instances of Dispatcher, HttpServletRequest, and HttpServletResponse.

Method Detail

getRequest

public javax.servlet.http.HttpServletRequest getRequest()

Returns our HttpServletRequest.

Specified by:

getRequest in interface ControllerContext

---

getRealResponse

public javax.servlet.http.HttpServletResponse getRealResponse()

Returns the *real* response object. Do not use this unless you know are the tail!

Specified by:

getRealResponse in interface ViewContext

---

getResponse

public javax.servlet.http.HttpServletResponse getResponse()

Returns our HttpServletResponse.

Specified by:

getResponse in interface ControllerContext

---

getServletConfig

public javax.servlet.ServletConfig getServletConfig()

Returns our ServletConfig.

Specified by:

getServletConfig in interface ControllerContext

---

getServletContext

public javax.servlet.ServletContext getServletContext()

Description copied from interface: ControllerContext

Basic data

Specified by:

getServletContext in interface ControllerContext

---

setControllerParam

public void setControllerParam(java.lang.String name,
                               java.lang.Object value)

Description copied from interface: ControllerContext

Sets a parameter to the controller (not view or transforms).

Specified by:

setControllerParam in interface ControllerContext

---

setViewParam

public void setViewParam(java.lang.String name,
                         java.lang.Object value)

Description copied from interface: ControllerContext

Sets a parameter to the view (not controller or transforms).

Specified by:

setViewParam in interface ControllerContext

---

setTransformParam

public void setTransformParam(java.lang.String name,
                              java.lang.Object value)

Description copied from interface: ControllerContext

Sets a parameter to the transforms (not controller or view).

Specified by:

setTransformParam in interface ControllerContext

---

putAllControllerParams

public void putAllControllerParams(java.util.Map addParams)

Appends to existing parameters.

---

putAllViewParams

public void putAllViewParams(java.util.Map addParams)

Appends to existing parameters.

---

putAllTransformParams

public void putAllTransformParams(java.util.Map addParams)

Appends to existing parameters.

---

setModel

public void setModel(java.lang.Object mod)

Description copied from interface: ControllerContext

Set the model to be rendered.

Specified by:

setModel in interface ControllerContext

---

getModel

public java.lang.Object getModel()

Description copied from interface: ViewContext

Obtain the model which is to be rendered.

Specified by:

getModel in interface ControllerContext

---

getControllerParams

public java.util.Map getControllerParams()

Specified by:

getControllerParams in interface ControllerContext

---

getViewParams

public java.util.Map getViewParams()

Description copied from interface: ViewContext

Obtain any params that were set.

Specified by:

getViewParams in interface ViewContext

---

getTransformParams

public java.util.Map getTransformParams()

Description copied from interface: TransformContext

Obtain any params that were set.

Specified by:

getTransformParams in interface TransformContext

---

setTransforms

public void setTransforms(Transform[] trans)

---

getNextStep

public TransformStep getNextStep()
                          throws javax.servlet.ServletException

Description copied from interface: ViewContext

This is where output should be sent. If it returns null, there are no transforms, and you should use the real response.

Specified by:

getNextStep in interface ViewContext

---

halting

public boolean halting()

Specified by:

halting in interface TransformContext

---

determineMaxTransforms

protected int determineMaxTransforms()

Convenient method for obtaining the maximum number of transformations to allow in the pipeline. Uses a request parameter whose name is defined by the limitTransformsParam property on the Dispatcher, and which should have an integer value. If nothing is specified or transform limiting is disabled (because limitTransformsParam is null), this returns Integer.MAX_VALUE.

---

Overview  Package   Class  Use  Deprecated  Index
Home >> All >> org >> infohazard >> maverick >> [ flow overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---