net.sf.colle.xml
Class ResultPlugin

java.lang.Object
  net.sf.colle.xml.ResultPlugin

public abstract class ResultPlugin

extends Object

Interface to a result plugin. Result plugins can transform the output of a transformation to another form (e.g.: PDF, PNG ...). The result passed in may be attached to an output stream of an HTTPServletResponse or a local file. In most cases it will be a StreamResult and since most plugins will output a binary format a plugin may through an error if it receives anything but a StreamResult. The result created will wrap the orignal result and when information is passed to it, it reformats the information and passes it on to the original result. Created: 11 Jul 2003

Version:

$Revision: 1.1 $, $Date: 2003/08/01 23:38:31 $

Author:

Dwayne Schultz

Constructor Summary

ResultPlugin()

Method Summary

abstract javax.xml.transform.Result	createResult(javax.xml.transform.Result pxOriginal, String psMediaType) Returns a result that will receive output from a transformation and send a transformed output to the original result.
void	finalizeResult(javax.xml.transform.Result pxOriginal, javax.xml.transform.Result pxOutput, String psMediaType) Allows the plugin to perform any post processing to the result.

Methods inherited from class java.lang.Object

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

Constructor Detail

ResultPlugin

public ResultPlugin()

Method Detail

createResult

public abstract javax.xml.transform.Result createResult(javax.xml.transform.Result pxOriginal,
                                                        String psMediaType)

Returns a result that will receive output from a transformation and send a transformed output to the original result. The media type may provide a hint as to the requested format of the final output.

finalizeResult

public void finalizeResult(javax.xml.transform.Result pxOriginal,
                           javax.xml.transform.Result pxOutput,
                           String psMediaType)

Allows the plugin to perform any post processing to the result.

Parameters:

pxOriginal - original result passed to createResult

pxOutput - result created in a call to createResult above.

psMediaType - requested format of the final output.