Class BaseUIComponent
- java.lang.Object
-
- org.pentaho.platform.engine.core.system.PentahoBase
-
- org.pentaho.platform.engine.services.PentahoMessenger
-
- org.pentaho.platform.uifoundation.component.BaseUIComponent
-
- All Implemented Interfaces:
Serializable
,org.pentaho.platform.api.engine.ILogger
,org.pentaho.platform.api.ui.IUIComponent
- Direct Known Subclasses:
ActionComponent
,HtmlComponent
,XmlComponent
public abstract class BaseUIComponent extends PentahoMessenger implements org.pentaho.platform.api.ui.IUIComponent
- Author:
- James Dixon TODO To change the template for this generated type comment go to Window - Preferences - Java - Code Style - Code Templates
- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description protected HashMap
contentTypes
static boolean
debug
protected org.pentaho.platform.api.engine.IPentahoUrlFactory
urlFactory
protected HashMap
xslProperties
-
Fields inherited from class org.pentaho.platform.engine.core.system.PentahoBase
EMPTYLOGID, loggingLevel, LOGID_MASK1, LOGID_MASK2, LOGID_SEPARATOR
-
-
Constructor Summary
Constructors Constructor Description BaseUIComponent(org.pentaho.platform.api.engine.IPentahoUrlFactory urlFactory, List messages, String sourcePath)
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description void
done()
abstract String
getContent(String mimeType)
abstract org.apache.commons.logging.Log
getLogger()
Object
getObjectParameter(String name, Object defaultValue)
String
getParameter(String name, String defaultValue)
String[]
getParameterAsArray(String name)
HashMap
getParameterProviders()
protected org.pentaho.platform.api.engine.IActionRequestHandler
getRequestHandler()
protected org.pentaho.platform.api.engine.IPentahoSession
getSession()
protected String
getSourcePath()
protected org.pentaho.platform.api.engine.IPentahoUrlFactory
getUrlFactory()
String
getXsl(String mimeType)
HashMap
getXslProperties()
void
handleRequest(OutputStream outputStream, org.pentaho.platform.api.engine.IActionRequestHandler actionRequestHandler, String contentType, HashMap requestParameterProviders)
void
setParameterProvider(String name, org.pentaho.platform.api.engine.IParameterProvider parameterProvider)
void
setParameterProviders(HashMap parameterProviders)
void
setRequestHandler(org.pentaho.platform.api.engine.IActionRequestHandler actionRequestHandler)
protected void
setSourcePath(String sourcePath)
void
setUrlFactory(org.pentaho.platform.api.engine.IPentahoUrlFactory urlFactory)
void
setXsl(String mimeType, String xslName)
void
setXslProperty(String name, String value)
abstract boolean
validate()
boolean
validate(org.pentaho.platform.api.engine.IPentahoSession session, org.pentaho.platform.api.engine.IActionRequestHandler actionRequestHandler)
Set the userSession member, generate a Log Id, set the requestHandler, and validate the component's configuration.-
Methods inherited from class org.pentaho.platform.engine.services.PentahoMessenger
debug, debug, error, error, error, fatal, fatal, getMessages, getUserString, info, info, setMessages, trace, trace, warn, warn
-
Methods inherited from class org.pentaho.platform.engine.core.system.PentahoBase
genLogIdFromInfo, genLogIdFromInfo, genLogIdFromSession, getLoggingLevel, getLogId, getObjectName, setLoggingLevel, setLogId
-
-
-
-
Field Detail
-
debug
public static final boolean debug
- See Also:
- Constant Field Values
-
xslProperties
protected HashMap xslProperties
-
contentTypes
protected HashMap contentTypes
-
urlFactory
protected org.pentaho.platform.api.engine.IPentahoUrlFactory urlFactory
-
-
Method Detail
-
getLogger
public abstract org.apache.commons.logging.Log getLogger()
- Specified by:
getLogger
in classPentahoBase
-
handleRequest
public void handleRequest(OutputStream outputStream, org.pentaho.platform.api.engine.IActionRequestHandler actionRequestHandler, String contentType, HashMap requestParameterProviders) throws IOException
- Specified by:
handleRequest
in interfaceorg.pentaho.platform.api.ui.IUIComponent
- Throws:
IOException
-
setSourcePath
protected void setSourcePath(String sourcePath)
-
getSourcePath
protected String getSourcePath()
-
setUrlFactory
public void setUrlFactory(org.pentaho.platform.api.engine.IPentahoUrlFactory urlFactory)
-
setRequestHandler
public void setRequestHandler(org.pentaho.platform.api.engine.IActionRequestHandler actionRequestHandler)
-
setParameterProvider
public void setParameterProvider(String name, org.pentaho.platform.api.engine.IParameterProvider parameterProvider)
-
setParameterProviders
public void setParameterProviders(HashMap parameterProviders)
-
getUrlFactory
protected org.pentaho.platform.api.engine.IPentahoUrlFactory getUrlFactory()
-
getRequestHandler
protected org.pentaho.platform.api.engine.IActionRequestHandler getRequestHandler()
-
getParameterProviders
public HashMap getParameterProviders()
-
getSession
protected org.pentaho.platform.api.engine.IPentahoSession getSession()
-
validate
public abstract boolean validate()
- Specified by:
validate
in interfaceorg.pentaho.platform.api.ui.IUIComponent
-
validate
public boolean validate(org.pentaho.platform.api.engine.IPentahoSession session, org.pentaho.platform.api.engine.IActionRequestHandler actionRequestHandler)
Set the userSession member, generate a Log Id, set the requestHandler, and validate the component's configuration. NOTE: this method has several side effects not related to validation. could probably use some refactoring- Specified by:
validate
in interfaceorg.pentaho.platform.api.ui.IUIComponent
- Parameters:
session
-actionRequestHandler
-- Returns:
- boolean true if component configuration is valid, else false
-
getXslProperties
public HashMap getXslProperties()
-
done
public void done()
-
-