org.pentaho.platform.engine.services.solution
Class BaseContentGenerator

java.lang.Object
  org.pentaho.platform.engine.core.system.PentahoBase
      org.pentaho.platform.engine.services.solution.BaseContentGenerator

All Implemented Interfaces:

Serializable, IContentGenerator, ILogger

Direct Known Subclasses:

ActionSequenceContentGenerator, BaseXmlContentGenerator, SimpleContentGenerator

public abstract class BaseContentGenerator
extends PentahoBase
implements IContentGenerator

See Also:

Serialized Form

Field Summary

Fields inherited from class org.pentaho.platform.engine.core.system.PentahoBase

EMPTYLOGID, LOGID_MASK1, LOGID_MASK2, LOGID_SEPARATOR

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

Constructor Summary

BaseContentGenerator()

Method Summary

abstract 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
abstract org.apache.commons.logging.Log	getLogger()
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 class org.pentaho.platform.engine.core.system.PentahoBase

debug, debug, error, error, fatal, fatal, genLogIdFromInfo, genLogIdFromInfo, genLogIdFromSession, getLoggingLevel, getLogId, getObjectName, info, info, setLoggingLevel, setLogId, trace, trace, warn, warn

Methods inherited from class java.lang.Object

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

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

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

Constructor Detail

BaseContentGenerator

public BaseContentGenerator()

Method Detail

getLogger

public abstract org.apache.commons.logging.Log getLogger()

Specified by:

getLogger in class PentahoBase

createContent

public abstract void createContent()
                            throws Exception

Description copied from interface: IContentGenerator

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

Specified by:

createContent in interface IContentGenerator

Throws:

Exception

setCallbacks

public void setCallbacks(List<Object> callbacks)

Description copied from interface: IContentGenerator

this method is not used at this time

Specified by:

setCallbacks in interface IContentGenerator

setInstanceId

public void setInstanceId(String instanceId)

Description copied from interface: IContentGenerator

this method is not used at this time

Specified by:

setInstanceId in interface IContentGenerator

setParameterProviders

public void setParameterProviders(Map<String,IParameterProvider> parameterProviders)

Description copied from interface: IContentGenerator

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

Specified by:

setParameterProviders in interface IContentGenerator

setSession

public void setSession(IPentahoSession userSession)

Description copied from interface: IContentGenerator

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

Specified by:

setSession in interface IContentGenerator

setUrlFactory

public void setUrlFactory(IPentahoUrlFactory urlFactory)

Description copied from interface: IContentGenerator

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

Specified by:

setUrlFactory in interface IContentGenerator

setMessagesList

public void setMessagesList(List<String> messages)

Description copied from interface: IContentGenerator

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

Specified by:

setMessagesList in interface IContentGenerator

Parameters:

messages - a list of messages

setOutputHandler

public void setOutputHandler(IOutputHandler outputHandler)

Description copied from interface: IContentGenerator

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

Specified by:

setOutputHandler in interface IContentGenerator

getItemName

public String getItemName()

Description copied from interface: IContentGenerator

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

Specified by:

getItemName in interface IContentGenerator

setItemName

public void setItemName(String itemName)

Description copied from interface: IContentGenerator

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

Specified by:

setItemName in interface IContentGenerator