Package org.pentaho.platform.engine.core.output

Class SimpleOutputHandler

java.lang.Object

org.pentaho.platform.engine.core.output.SimpleOutputHandler

All Implemented Interfaces:

org.pentaho.platform.api.engine.IOutputHandler

public class SimpleOutputHandler
extends Object
implements org.pentaho.platform.api.engine.IOutputHandler

Author:

aaron

Field Summary

Fields inherited from interface org.pentaho.platform.api.engine.IOutputHandler

CONTENT, FILE, OUTPUT_TYPE_CONTENT, OUTPUT_TYPE_DEFAULT, OUTPUT_TYPE_PARAMETERS, RESPONSE

Constructor Summary

Constructors

Constructor	Description
SimpleOutputHandler(OutputStream outputStream, boolean allowFeedback)	Creates a SimpleContentItem from an OutputStream.
SimpleOutputHandler(org.pentaho.platform.api.repository.IContentItem contentItem, boolean allowFeedback)	Creates a SimpleContentItem copy of an IContentItem

Method Summary

Modifier and Type	Method	Description
boolean	allowFeedback()
boolean	contentDone()
org.pentaho.platform.api.repository.IContentItem	getFeedbackContentItem()
String	getMimeType()
org.pentaho.platform.api.engine.IMimeTypeListener	getMimeTypeListener()
org.pentaho.platform.api.repository.IContentItem	getOutputContentItem(String outputName, String contentName, String instanceId, String localMimeType)
int	getOutputPreference()
org.pentaho.platform.api.engine.IPentahoSession	getSession()
boolean	isResponseExpected()
void	setContentItem(org.pentaho.platform.api.repository.IContentItem content, String objectName, String contentName)
void	setMimeType(String mimeType)
void	setMimeTypeListener(org.pentaho.platform.api.engine.IMimeTypeListener mimeTypeListener)
void	setOutput(String name, Object value)
void	setOutputPreference(int outputType)
void	setOutputStream(OutputStream outputStream, String outputName, String contentName)
void	setSession(org.pentaho.platform.api.engine.IPentahoSession session)

Methods inherited from class java.lang.Object

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

Constructor Detail

SimpleOutputHandler

public SimpleOutputHandler(org.pentaho.platform.api.repository.IContentItem contentItem,
                           boolean allowFeedback)

Creates a SimpleContentItem copy of an IContentItem

Parameters:

contentItem - provides the underlying outputStream this outputhandler manages. Feedback will also be written to this contentItem's output stream if allowFeedback is true

allowFeedback -

SimpleOutputHandler

public SimpleOutputHandler(OutputStream outputStream,
                           boolean allowFeedback)

Creates a SimpleContentItem from an OutputStream.

Parameters:

outputStream - the underlying outputStream this outputhandler manages. Feedback will be written to this output stream if allowFeedback is true

allowFeedback -

Method Detail

setSession

public void setSession(org.pentaho.platform.api.engine.IPentahoSession session)

Specified by:

setSession in interface org.pentaho.platform.api.engine.IOutputHandler

getSession

public org.pentaho.platform.api.engine.IPentahoSession getSession()

Specified by:

getSession in interface org.pentaho.platform.api.engine.IOutputHandler

setOutputStream

public void setOutputStream(OutputStream outputStream,
                            String outputName,
                            String contentName)

setOutputPreference

public void setOutputPreference(int outputType)

Specified by:

setOutputPreference in interface org.pentaho.platform.api.engine.IOutputHandler

contentDone

public boolean contentDone()

Specified by:

contentDone in interface org.pentaho.platform.api.engine.IOutputHandler

getOutputPreference

public int getOutputPreference()

Specified by:

getOutputPreference in interface org.pentaho.platform.api.engine.IOutputHandler

setMimeType

public void setMimeType(String mimeType)

getMimeType

public String getMimeType()

allowFeedback

public boolean allowFeedback()

Specified by:

allowFeedback in interface org.pentaho.platform.api.engine.IOutputHandler

getFeedbackContentItem

public org.pentaho.platform.api.repository.IContentItem getFeedbackContentItem()

Specified by:

getFeedbackContentItem in interface org.pentaho.platform.api.engine.IOutputHandler

getOutputContentItem

public org.pentaho.platform.api.repository.IContentItem getOutputContentItem(String outputName,
                                                                             String contentName,
                                                                             String instanceId,
                                                                             String localMimeType)

Specified by:

getOutputContentItem in interface org.pentaho.platform.api.engine.IOutputHandler

setContentItem

public void setContentItem(org.pentaho.platform.api.repository.IContentItem content,
                           String objectName,
                           String contentName)

setOutput

public void setOutput(String name,
                      Object value)
               throws IOException

Specified by:

setOutput in interface org.pentaho.platform.api.engine.IOutputHandler

Throws:

IOException

getMimeTypeListener

public org.pentaho.platform.api.engine.IMimeTypeListener getMimeTypeListener()

Specified by:

getMimeTypeListener in interface org.pentaho.platform.api.engine.IOutputHandler

setMimeTypeListener

public void setMimeTypeListener(org.pentaho.platform.api.engine.IMimeTypeListener mimeTypeListener)

Specified by:

setMimeTypeListener in interface org.pentaho.platform.api.engine.IOutputHandler

isResponseExpected

public boolean isResponseExpected()

Specified by:

isResponseExpected in interface org.pentaho.platform.api.engine.IOutputHandler