| org.pentaho.core.system.PentahoMessenger
 org.pentaho.plugin.ComponentBase
All known Subclasses: org.pentaho.plugin.core.SimpleComponent, org.pentaho.plugin.misc.InstanceEnd, org.pentaho.plugin.sql.SQLBaseComponent, org.pentaho.plugin.core.ResultSetCrosstabComponent, org.pentaho.plugin.xquery.XQueryBaseComponent, org.pentaho.plugin.xmla.XMLABaseComponent, org.pentaho.plugin.core.ResultSetExportComponent, org.pentaho.plugin.misc.TestComponent, org.pentaho.plugin.core.ResultSetFlattenerComponent, org.pentaho.plugin.jasperreports.JasperReportsComponent, org.pentaho.plugin.versionchecker.PentahoVersionCheckComponent, org.pentaho.plugin.jfreereport.JFreeReportGeneratorComponent, org.pentaho.plugin.core.SubscriptionBurstComponent, org.pentaho.plugin.core.HelloWorldComponent, org.pentaho.plugin.olap.PivotViewComponent, org.pentaho.plugin.kettle.KettleComponent, org.pentaho.plugin.shark.SharkWorkflowComponent, org.pentaho.plugin.eclipsebirt.BIRTReportComponent, org.pentaho.plugin.core.SecureFilterComponent, org.pentaho.plugin.core.ContentRepositoryCleaner, org.pentaho.plugin.jfreereport.AbstractJFreeReportComponent, org.pentaho.plugin.olap.MondrianModelComponent, org.pentaho.plugin.misc.UtilityComponent, org.pentaho.plugin.core.ResultSetCompareComponent, org.pentaho.plugin.mdx.MDXBaseComponent, org.pentaho.plugin.misc.ReceiptAuditComponent, org.pentaho.plugin.hql.HQLBaseComponent, org.pentaho.plugin.quartz.SchedulerAdminComponent, org.pentaho.plugin.quartz.JobSchedulerComponent, org.pentaho.plugin.email.EmailComponent, org.pentaho.plugin.core.SubActionComponent, org.pentaho.plugin.core.ContentOutputComponent, org.pentaho.plugin.core.TemplateComponent, org.pentaho.plugin.print.PrintComponent, org.pentaho.plugin.jfreechart.ChartComponent, org.pentaho.plugin.javascript.JavascriptRule,
| Method Summary | |
| protected void | addTempParameter(String name, IActionParameter param)
| | protected void | addTempParameterObject(String name, Object paramObject)
| | protected String | applyInputsToFormat(String format)
| | protected void | audit(String messageType, String message, String value, int duration)
| | protected void | createFeedbackParameter(IActionParameter actionParam)
| | protected void | createFeedbackParameter(SelectionMapper selMap, String fieldName, Object defaultValues)
| | protected void | createFeedbackParameter(SelectionMapper selMap, String fieldName, Object defaultValues, boolean optional)
| | protected void | createFeedbackParameter(String fieldName, String displayName, String hint, String defaultValue, boolean visible)
| | protected void | createFeedbackParameter(String fieldName, String displayName, String hint, String defaultValue, boolean visible, boolean optional)
| | public void | createFeedbackParameter(String fieldName, String displayName, String hint, Object defaultValues, List values, Map dispNames, String displayStyle)
| | public void | createFeedbackParameter(String fieldName, String displayName, String hint, Object defaultValues, List values, Map dispNames, String displayStyle, boolean optional)
| | public String | createNewInstance(boolean persisted, Map parameters, boolean forceImmediateWrite)
| | abstract public void | done()
| | public int | execute()
| | abstract protected boolean | executeAction()
| | protected boolean | feedbackAllowed()
| | public ActionDefinition | getActionDefinition()
| | public String | getActionName()
| | public String | getActionTitle()
| | public Node | getComponentDefinition()
| | public Node | getComponentDefinition(boolean process)
Return the xml Node containing the component's definition. | | protected String | getContentUrl(IContentItem contentItem)
| | protected DataSource | getDataSource(String parameterName)
| | protected OutputStream | getDefaultOutputStream(String mimeType)
| | protected OutputStream | getFeedbackOutputStream()
| | public String | getId()
| | public String | getInitFailMessage()
| | public boolean | getInitOk()
| | protected boolean | getInputBooleanValue(String inputName, boolean defaultValue)
| | protected long | getInputLongValue(String inputName, long defaultValue)
| | protected Set | getInputNames()
| | protected IActionParameter | getInputParameter(String parameterName)
| | protected InputStream | getInputStream(String inputName)
| | protected String | getInputStringValue(String inputName)
| | protected String | getInputStringValue(String inputName, boolean applyTemplates)
| | protected Object | getInputValue(String inputName)
| | public String | getInstanceId()
| | public String | getLogId()
| | public String | getObjectName()
| | protected IContentItem | getOutputContentItem(String mimeType)
| | protected IContentItem | getOutputContentItem(String outputName, String mimeType)
| | protected IContentItem | getOutputItem(String outputName, String mimeType, String extension)
| | protected IActionParameter | getOutputItem(String outputName)
| | protected Set | getOutputNames()
| | protected int | getOutputPreference()
| | public String | getProcessId()
| | protected IActionResource | getResource(String resourceName)
| | public String | getResourceAsString(IActionResource resource)
| | protected DataSource | getResourceDataSource(IActionResource resource)
| | protected InputStream | getResourceInputStream(IActionResource resource)
| | protected Set | getResourceNames()
| | public IRuntimeContext | getRuntimeContext()
| | public IPentahoSession | getSession()
| | protected Object | getSetting(String name)
| | protected String | getSolutionName()
| | protected String | getSolutionPath()
| | protected String | getStringSetting(String name)
| | abstract public boolean | init()
| | public void | inputMissingError(String paramName)
| | protected boolean | isDefinedInput(String inputName)
| | protected boolean | isDefinedOutput(String outputName)
| | protected boolean | isDefinedResource(String resourceName)
| | protected boolean | isPromptPending()
| | public void | outputMissingError(String paramName)
| | public void | promptNeeded()
| | public void | promptNow()
| | public int | resolveParameter(String template, String parameterName, Matcher parameterMatcher, int copyStart, StringBuffer result)
| | public void | resourceComponentSettingError(String paramName)
| | public void | resourceMissingError(String paramName)
| | protected void | saveSetting(String name, Object value)
| | public void | setActionDefinition(ActionDefinition actionDefinition)
| | public void | setActionName(String actionName)
| | public void | setComponentDefinition(Node componentDefinition)
| | protected void | setFeedbackMimeType(String mimeType)
| | public void | setInstanceId(String instanceId)
| | protected void | setOutputMimeType(String mimeType)
| | protected void | setOutputMimeType(String outputName, String mimeType)
| | protected void | setOutputValue(String outputName, Object value)
| | public void | setProcessId(String processId)
| | public void | setRuntimeContext(IRuntimeContext runtimeContext)
| | public void | setSession(IPentahoSession session)
| | final public int | validate()
| | abstract protected boolean | validateAction()
| | abstract protected boolean | validateSystemSettings()
|
| COMPONENT_EXECUTE_FAIL | | final public static String COMPONENT_EXECUTE_FAIL(Code) | | |
| MISSING_SESSION | | final public static String MISSING_SESSION(Code) | | |
| UNKNOWN_COMPONENT_ID | | final protected static String UNKNOWN_COMPONENT_ID(Code) | | |
| debug | | final protected static boolean debug(Code) | | |
| addTempParameterObject | | protected void addTempParameterObject(String name, Object paramObject)(Code) | | |
| createFeedbackParameter | | protected void createFeedbackParameter(IActionParameter actionParam)(Code) | |
Parameters:
actionParam - |
| createFeedbackParameter | | protected void createFeedbackParameter(String fieldName, String displayName, String hint, String defaultValue, boolean visible)(Code) | | |
| createFeedbackParameter | | protected void createFeedbackParameter(String fieldName, String displayName, String hint, String defaultValue, boolean visible, boolean optional)(Code) | | |
| createNewInstance | | public String createNewInstance(boolean persisted, Map parameters, boolean forceImmediateWrite)(Code) | | |
| done | | abstract public void done()(Code) | | |
| execute | | public int execute()(Code) | | |
| executeAction | | abstract protected boolean executeAction() throws Throwable(Code) | | |
| feedbackAllowed | | protected boolean feedbackAllowed()(Code) | | |
| getActionDefinition | | public ActionDefinition getActionDefinition()(Code) | | |
| getComponentDefinition | | public Node getComponentDefinition()(Code) | | |
| getComponentDefinition | | public Node getComponentDefinition(boolean process)(Code) | | Return the xml Node containing the component's definition. If
process is true, visit every child node in the tree, and
if the child node's text is an action parameter convert it to it's
value. (See doc for applyInputsToFormat())
Parameters:
process - if true, if the node's text represents a parameter, convertthe parameter to it's value, and assign the value to thenode's text. Node containing this component's definition. |
| getInitOk | | public boolean getInitOk()(Code) | | |
| getInputBooleanValue | | protected boolean getInputBooleanValue(String inputName, boolean defaultValue)(Code) | | |
| getInputLongValue | | protected long getInputLongValue(String inputName, long defaultValue)(Code) | | |
| getInputNames | | protected Set getInputNames()(Code) | | |
| getInputStringValue | | protected String getInputStringValue(String inputName, boolean applyTemplates)(Code) | | |
| getOutputNames | | protected Set getOutputNames()(Code) | | |
| getOutputPreference | | protected int getOutputPreference()(Code) | | |
| getResourceNames | | protected Set getResourceNames()(Code) | | |
| init | | abstract public boolean init()(Code) | | |
| inputMissingError | | public void inputMissingError(String paramName)(Code) | | |
| isDefinedInput | | protected boolean isDefinedInput(String inputName)(Code) | | |
| isDefinedOutput | | protected boolean isDefinedOutput(String outputName)(Code) | | |
| isDefinedResource | | protected boolean isDefinedResource(String resourceName)(Code) | | |
| isPromptPending | | protected boolean isPromptPending()(Code) | | |
| outputMissingError | | public void outputMissingError(String paramName)(Code) | | |
| promptNeeded | | public void promptNeeded()(Code) | | |
| promptNow | | public void promptNow()(Code) | | |
| resourceComponentSettingError | | public void resourceComponentSettingError(String paramName)(Code) | | |
| resourceMissingError | | public void resourceMissingError(String paramName)(Code) | | |
| setActionDefinition | | public void setActionDefinition(ActionDefinition actionDefinition)(Code) | | |
| setActionName | | public void setActionName(String actionName)(Code) | | |
| setComponentDefinition | | public void setComponentDefinition(Node componentDefinition)(Code) | | |
| setFeedbackMimeType | | protected void setFeedbackMimeType(String mimeType)(Code) | | |
| setInstanceId | | public void setInstanceId(String instanceId)(Code) | | |
| setOutputMimeType | | protected void setOutputMimeType(String mimeType)(Code) | | |
| setOutputMimeType | | protected void setOutputMimeType(String outputName, String mimeType)(Code) | | |
| setProcessId | | public void setProcessId(String processId)(Code) | | |
| validate | | final public int validate()(Code) | | |
| validateAction | | abstract protected boolean validateAction()(Code) | | |
| validateSystemSettings | | abstract protected boolean validateSystemSettings()(Code) | | |
|
|