public abstract class ComponentBase extends PentahoMessenger implements org.pentaho.platform.api.engine.IComponent, org.pentaho.platform.api.engine.IParameterResolver
Modifier and Type | Field and Description |
---|---|
static String |
COMPONENT_EXECUTE_FAIL |
protected static boolean |
debug |
static String |
MISSING_SESSION |
protected static String |
UNKNOWN_COMPONENT_ID |
EMPTYLOGID, loggingLevel, LOGID_MASK1, LOGID_MASK2, LOGID_SEPARATOR
Constructor and Description |
---|
ComponentBase() |
Modifier and Type | Method and Description |
---|---|
protected void |
addTempParameter(String name,
org.pentaho.platform.api.engine.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(org.pentaho.platform.api.engine.IActionParameter actionParam)
Deprecated.
|
protected void |
createFeedbackParameter(org.pentaho.platform.api.engine.ISelectionMapper selMap,
String fieldName,
Object defaultValues) |
protected void |
createFeedbackParameter(org.pentaho.platform.api.engine.ISelectionMapper selMap,
String fieldName,
Object defaultValues,
boolean optional) |
void |
createFeedbackParameter(String fieldName,
String displayName,
String hint,
Object defaultValues,
List values,
Map dispNames,
String displayStyle) |
void |
createFeedbackParameter(String fieldName,
String displayName,
String hint,
Object defaultValues,
List values,
Map dispNames,
String displayStyle,
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) |
String |
createNewInstance(boolean persisted,
Map parameters,
boolean forceImmediateWrite) |
abstract void |
done() |
int |
execute() |
protected abstract boolean |
executeAction() |
protected boolean |
feedbackAllowed() |
org.pentaho.actionsequence.dom.IActionDefinition |
getActionDefinition() |
String |
getActionName() |
String |
getActionTitle() |
org.dom4j.Node |
getComponentDefinition() |
org.dom4j.Node |
getComponentDefinition(boolean process)
Return the xml Node containing the component's definition.
|
protected org.pentaho.platform.api.repository.IContentItem |
getContentOutputItem(String outputName,
String mimeType) |
protected OutputStream |
getDefaultOutputStream(String mimeType)
Deprecated.
|
protected OutputStream |
getFeedbackOutputStream() |
String |
getId() |
String |
getInitFailMessage() |
boolean |
getInitOk() |
protected boolean |
getInputBooleanValue(String inputName,
boolean defaultValue) |
protected long |
getInputLongValue(String inputName,
long defaultValue) |
protected Set |
getInputNames() |
protected org.pentaho.platform.api.engine.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) |
String |
getInstanceId() |
String |
getLogId() |
String |
getObjectName() |
protected org.pentaho.platform.api.repository.IContentItem |
getOutputContentItem(String mimeType)
Deprecated.
|
protected org.pentaho.platform.api.repository.IContentItem |
getOutputContentItem(String outputName,
String mimeType) |
protected org.pentaho.platform.api.engine.IActionParameter |
getOutputItem(String outputName) |
protected org.pentaho.platform.api.repository.IContentItem |
getOutputItem(String outputName,
String mimeType,
String extension) |
protected Set |
getOutputNames() |
protected int |
getOutputPreference() |
String |
getProcessId() |
protected org.pentaho.platform.api.engine.IActionSequenceResource |
getResource(String resourceName) |
String |
getResourceAsString(org.pentaho.platform.api.engine.IActionSequenceResource resource) |
protected org.pentaho.commons.connection.IPentahoStreamSource |
getResourceDataSource(org.pentaho.platform.api.engine.IActionSequenceResource resource) |
protected InputStream |
getResourceInputStream(org.pentaho.platform.api.engine.IActionSequenceResource resource) |
protected Set |
getResourceNames() |
org.pentaho.platform.api.engine.IRuntimeContext |
getRuntimeContext() |
org.pentaho.platform.api.engine.IPentahoSession |
getSession() |
protected Object |
getSetting(String name) |
protected String |
getSolutionName() |
protected String |
getSolutionPath() |
protected String |
getStringSetting(String name) |
abstract boolean |
init() |
void |
inputMissingError(String paramName) |
protected boolean |
isDefinedInput(String inputName) |
protected boolean |
isDefinedOutput(String outputName) |
protected boolean |
isDefinedResource(String resourceName) |
protected boolean |
isPromptPending() |
void |
outputMissingError(String paramName) |
void |
promptNeeded() |
void |
promptNow() |
int |
resolveParameter(String template,
String parameterName,
Matcher parameterMatcher,
int copyStart,
StringBuffer result) |
void |
resourceComponentSettingError(String paramName) |
void |
resourceMissingError(String paramName) |
protected void |
saveSetting(String name,
Object value) |
void |
setActionDefinition(org.pentaho.actionsequence.dom.IActionDefinition actionDefinition) |
void |
setActionName(String actionName) |
void |
setComponentDefinition(org.dom4j.Node componentDefinition) |
void |
setComponentDefinitionMap(Map<String,String> componentDefinitionMap) |
protected void |
setFeedbackMimeType(String mimeType) |
void |
setInstanceId(String instanceId) |
protected void |
setOutputMimeType(String mimeType)
Deprecated.
|
protected void |
setOutputMimeType(String outputName,
String mimeType) |
protected void |
setOutputValue(String outputName,
Object value) |
void |
setProcessId(String processId) |
void |
setRuntimeContext(org.pentaho.platform.api.engine.IRuntimeContext runtimeContext) |
void |
setSession(org.pentaho.platform.api.engine.IPentahoSession session) |
int |
validate() |
protected abstract boolean |
validateAction() |
protected abstract boolean |
validateSystemSettings() |
debug, debug, error, error, error, fatal, fatal, getMessages, getUserString, info, info, setMessages, trace, trace, warn, warn
genLogIdFromInfo, genLogIdFromInfo, genLogIdFromSession, getLogger, getLoggingLevel, setLoggingLevel, setLogId
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
protected static final String UNKNOWN_COMPONENT_ID
public static final String MISSING_SESSION
public static final String COMPONENT_EXECUTE_FAIL
protected static final boolean debug
public void setInstanceId(String instanceId)
setInstanceId
in interface org.pentaho.platform.api.engine.IComponent
public String getInstanceId()
getInstanceId
in interface org.pentaho.platform.api.engine.IComponent
public void setActionName(String actionName)
setActionName
in interface org.pentaho.platform.api.engine.IComponent
public String getActionName()
getActionName
in interface org.pentaho.platform.api.engine.IAuditable
getActionName
in interface org.pentaho.platform.api.engine.IComponent
public void setProcessId(String processId)
setProcessId
in interface org.pentaho.platform.api.engine.IComponent
public String getProcessId()
getProcessId
in interface org.pentaho.platform.api.engine.IAuditable
getProcessId
in interface org.pentaho.platform.api.engine.IComponent
public void setComponentDefinition(org.dom4j.Node componentDefinition)
setComponentDefinition
in interface org.pentaho.platform.api.engine.IComponent
public void setComponentDefinitionMap(Map<String,String> componentDefinitionMap)
setComponentDefinitionMap
in interface org.pentaho.platform.api.engine.IComponent
public org.dom4j.Node getComponentDefinition()
getComponentDefinition
in interface org.pentaho.platform.api.engine.IComponent
public org.dom4j.Node getComponentDefinition(boolean process)
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())process
- if true, if the node's text represents a parameter, convert the parameter to it's value, and assign
the value to the node's text.public void setRuntimeContext(org.pentaho.platform.api.engine.IRuntimeContext runtimeContext)
setRuntimeContext
in interface org.pentaho.platform.api.engine.IComponent
public org.pentaho.platform.api.engine.IRuntimeContext getRuntimeContext()
getRuntimeContext
in interface org.pentaho.platform.api.engine.IComponent
public void setSession(org.pentaho.platform.api.engine.IPentahoSession session)
setSession
in interface org.pentaho.platform.api.engine.IComponent
public org.pentaho.platform.api.engine.IPentahoSession getSession()
getSession
in interface org.pentaho.platform.api.engine.IComponent
protected abstract boolean validateAction()
protected abstract boolean validateSystemSettings()
public abstract void done()
done
in interface org.pentaho.platform.api.engine.IComponent
public abstract boolean init()
init
in interface org.pentaho.platform.api.engine.IComponent
public String getLogId()
getLogId
in class PentahoBase
protected boolean isDefinedInput(String inputName)
protected boolean isDefinedOutput(String outputName)
protected boolean isDefinedResource(String resourceName)
public final int validate()
validate
in interface org.pentaho.platform.api.engine.IComponent
public int resolveParameter(String template, String parameterName, Matcher parameterMatcher, int copyStart, StringBuffer result)
resolveParameter
in interface org.pentaho.platform.api.engine.IParameterResolver
public boolean getInitOk()
protected Set getOutputNames()
protected Set getInputNames()
protected Set getResourceNames()
protected boolean feedbackAllowed()
protected org.pentaho.platform.api.engine.IActionSequenceResource getResource(String resourceName)
protected InputStream getResourceInputStream(org.pentaho.platform.api.engine.IActionSequenceResource resource) throws FileNotFoundException
FileNotFoundException
protected InputStream getInputStream(String inputName)
protected int getOutputPreference()
protected boolean getInputBooleanValue(String inputName, boolean defaultValue)
protected long getInputLongValue(String inputName, long defaultValue)
public void promptNeeded()
public void promptNow()
public String getResourceAsString(org.pentaho.platform.api.engine.IActionSequenceResource resource)
public String getInitFailMessage()
public String createNewInstance(boolean persisted, Map parameters, boolean forceImmediateWrite)
public void inputMissingError(String paramName)
public void outputMissingError(String paramName)
public void resourceMissingError(String paramName)
public void resourceComponentSettingError(String paramName)
public int execute()
execute
in interface org.pentaho.platform.api.engine.IComponent
public String getObjectName()
getObjectName
in interface org.pentaho.platform.api.engine.IAuditable
getObjectName
in class PentahoBase
public String getId()
getId
in interface org.pentaho.platform.api.engine.IAuditable
public String getActionTitle()
@Deprecated protected org.pentaho.platform.api.repository.IContentItem getOutputContentItem(String mimeType)
protected org.pentaho.platform.api.repository.IContentItem getOutputContentItem(String outputName, String mimeType)
protected org.pentaho.platform.api.repository.IContentItem getContentOutputItem(String outputName, String mimeType)
protected org.pentaho.platform.api.repository.IContentItem getOutputItem(String outputName, String mimeType, String extension)
protected void addTempParameter(String name, org.pentaho.platform.api.engine.IActionParameter param)
@Deprecated protected OutputStream getDefaultOutputStream(String mimeType)
protected org.pentaho.platform.api.engine.IActionParameter getOutputItem(String outputName)
protected String getSolutionName()
protected String getSolutionPath()
protected org.pentaho.platform.api.engine.IActionParameter getInputParameter(String parameterName)
protected boolean isPromptPending()
protected void setFeedbackMimeType(String mimeType)
@Deprecated protected void setOutputMimeType(String mimeType)
protected OutputStream getFeedbackOutputStream()
@Deprecated protected void createFeedbackParameter(org.pentaho.platform.api.engine.IActionParameter actionParam)
actionParam
- protected void createFeedbackParameter(org.pentaho.platform.api.engine.ISelectionMapper selMap, String fieldName, Object defaultValues)
protected void createFeedbackParameter(org.pentaho.platform.api.engine.ISelectionMapper 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)
protected org.pentaho.commons.connection.IPentahoStreamSource getResourceDataSource(org.pentaho.platform.api.engine.IActionSequenceResource resource) throws FileNotFoundException
FileNotFoundException
public void setActionDefinition(org.pentaho.actionsequence.dom.IActionDefinition actionDefinition)
setActionDefinition
in interface org.pentaho.platform.api.engine.IComponent
public org.pentaho.actionsequence.dom.IActionDefinition getActionDefinition()
getActionDefinition
in interface org.pentaho.platform.api.engine.IComponent
Copyright © 2019 Hitachi Vantara. All rights reserved.