Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep

org.infohazard.maverick.transform
Class AbstractTransformStep  view AbstractTransformStep download AbstractTransformStep.java

java.lang.Object
  extended byorg.infohazard.maverick.transform.AbstractTransformStep
All Implemented Interfaces:
org.infohazard.maverick.flow.TransformStep
Direct Known Subclasses:
StringTransformStep, XMLTransformStep

public abstract class AbstractTransformStep
extends java.lang.Object
implements org.infohazard.maverick.flow.TransformStep

Helper class for all transform steps. When extending this class, remember that you are providing the TransformStep interface, so the getResponse(), etc methods are for a *client* to call. You should be sending your output to the methods on getNext(), which is safe to call multiple times. Remember, the goal is to take data written to you and send it on to the next step!


Field Summary
protected  org.infohazard.maverick.util.FakeHttpServletResponse fakeResponse
           
private static org.apache.commons.logging.Log log
          Logger
private  org.infohazard.maverick.flow.TransformStep next
           
private  org.infohazard.maverick.flow.TransformContext transformCtx
           
 
Constructor Summary
AbstractTransformStep(org.infohazard.maverick.flow.TransformContext tctx)
           
 
Method Summary
protected  org.infohazard.maverick.flow.TransformStep getNext()
          Allow us to lazily create the next step, much more convenient.
 javax.servlet.http.HttpServletResponse getResponse()
          Must call done() when finished.
protected  org.infohazard.maverick.flow.TransformContext getTransformCtx()
           
 java.io.Writer getWriter()
          Must call done() when finished.
 boolean isLast()
          Always return false from pluggable transform steps.
 void setContentType(java.lang.String contentType)
          By default do nothing.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.infohazard.maverick.flow.TransformStep
done, getSAXHandler, go, go, go
 

Field Detail

log

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


transformCtx

private org.infohazard.maverick.flow.TransformContext transformCtx

next

private org.infohazard.maverick.flow.TransformStep next

fakeResponse

protected org.infohazard.maverick.util.FakeHttpServletResponse fakeResponse
Constructor Detail

AbstractTransformStep

public AbstractTransformStep(org.infohazard.maverick.flow.TransformContext tctx)
                      throws javax.servlet.ServletException
Method Detail

isLast

public boolean isLast()
Always return false from pluggable transform steps.

Specified by:
isLast in interface org.infohazard.maverick.flow.TransformStep

setContentType

public void setContentType(java.lang.String contentType)
By default do nothing.

Specified by:
setContentType in interface org.infohazard.maverick.flow.TransformStep

getTransformCtx

protected org.infohazard.maverick.flow.TransformContext getTransformCtx()

getNext

protected org.infohazard.maverick.flow.TransformStep getNext()
                                                      throws javax.servlet.ServletException
Allow us to lazily create the next step, much more convenient.


getResponse

public javax.servlet.http.HttpServletResponse getResponse()
                                                   throws java.io.IOException,
                                                          javax.servlet.ServletException
Description copied from interface: org.infohazard.maverick.flow.TransformStep
Must call done() when finished.

Specified by:
getResponse in interface org.infohazard.maverick.flow.TransformStep

getWriter

public java.io.Writer getWriter()
                         throws java.io.IOException,
                                javax.servlet.ServletException
Description copied from interface: org.infohazard.maverick.flow.TransformStep
Must call done() when finished.

Specified by:
getWriter in interface org.infohazard.maverick.flow.TransformStep