org.pentaho.platform.api.engine

Interface IContentGenerator

All Superinterfaces:

ILogger

public interface IContentGenerator
extends ILogger

This interface is implemented by bi-platform plugins, and is instantiated for each content request made to the plugin system via the IPluginManager API. Once instantiated, the setter methods are first called and then createContent() is called to generate the expected content.

Field Summary

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

ACTIVITY_LOG, DEBUG, ERROR, FATAL, INFO, INSTANCE_LOG, SESSION_LOG, SOLUTION_LOG, TRACE, UNKNOWN, WARN

Method Summary

Methods

Modifier and Type	Method and Description
void	createContent() the createContent() method is called after the content generator has been initialized appropriately, and is responsible for populating the output handler.
String	getItemName() Get the name of the output content item for this content generator
void	setCallbacks(List<Object> callbacks) this method is not used at this time
void	setInstanceId(String instanceId) this method is not used at this time
void	setItemName(String itemName) Set the name of the output content item for the content generator
void	setMessagesList(List<String> messages) called before createContent(), this method is not used by the content generator system at this time.
void	setOutputHandler(IOutputHandler outputHandler) called before createContent(), the IOutputHandler is the API that defines how to write content back to the client.
void	setParameterProviders(Map<String,IParameterProvider> parameterProviders) called before createContent(), the parameterProviders list contain the available parameters.
void	setSession(IPentahoSession userSession) called before createContent(), this is the users session object.
void	setUrlFactory(IPentahoUrlFactory urlFactory) called before createContent(), this is used to build URLs

Methods inherited from interface org.pentaho.platform.api.engine.ILogger

debug, debug, error, error, fatal, fatal, getLoggingLevel, info, info, setLoggingLevel, trace, trace, warn, warn

Method Detail

createContent

void createContent()
                   throws Exception

the createContent() method is called after the content generator has been initialized appropriately, and is responsible for populating the output handler.

Throws:

Exception

setOutputHandler

void setOutputHandler(IOutputHandler outputHandler)

called before createContent(), the IOutputHandler is the API that defines how to write content back to the client.

Parameters:

outputHandler -

setMessagesList

void setMessagesList(List<String> messages)

called before createContent(), this method is not used by the content generator system at this time.

Parameters:

messages - a list of messages

setParameterProviders

void setParameterProviders(Map<String,IParameterProvider> parameterProviders)

called before createContent(), the parameterProviders list contain the available parameters.

Parameters:

parameterProviders -

setSession

void setSession(IPentahoSession userSession)

called before createContent(), this is the users session object.

Parameters:

userSession -

setUrlFactory

void setUrlFactory(IPentahoUrlFactory urlFactory)

called before createContent(), this is used to build URLs

Parameters:

urlFactory -

setCallbacks

void setCallbacks(List<Object> callbacks)

this method is not used at this time

Parameters:

callbacks -

setInstanceId

void setInstanceId(String instanceId)

this method is not used at this time

Parameters:

instanceId -

getItemName

String getItemName()

Get the name of the output content item for this content generator

setItemName

void setItemName(String itemName)

Set the name of the output content item for the content generator

Parameters:

itemName -