Package weka.knowledgeflow
Class BaseExecutionEnvironment
java.lang.Object
weka.knowledgeflow.BaseExecutionEnvironment
- All Implemented Interfaces:
ExecutionEnvironment
Base class for execution environments
- Author:
- Mark Hall (mhall{[at]}pentaho{[dot]}com)
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classDefaults for the base execution environment -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringDescription of the default execution environment -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionGets a new instance of the default flow executor suitable for use with this execution environmentGet default settings for the base execution environmentGet a description of this execution environmentGet environment variables for this execution environmentGet the executor that will actually be responsible for running the flow.Get the environment for performing commands at the application-level in a graphical environment.getLog()Get the log in useGet the logging level in useGet knowledge flow settings for this execution environmentbooleanGet whether this execution environment is headlessvoidSet environment variables for this execution environmentvoidsetFlowExecutor(FlowExecutor executor) Set the executor that will actually be responsible for running the flow.voidSet the environment for performing commands at the application-level in a graphical environment.voidsetHeadless(boolean headless) Set whether this execution environment is headlessvoidSet the log to usevoidsetLoggingLevel(LoggingLevel level) Set the logging level to usevoidsetSettings(Settings settings) Set knowledge flow settings for this execution environmentvoidThe main point at which to request stop processing of a flow.<T> Future<ExecutionResult<T>>submitTask(StepTask<T> stepTask) Submit a task to be run by the execution environment.
-
Field Details
-
DESCRIPTION
Description of the default execution environment- See Also:
-
-
Constructor Details
-
BaseExecutionEnvironment
public BaseExecutionEnvironment()
-
-
Method Details
-
getDescription
Get a description of this execution environment- Specified by:
getDescriptionin interfaceExecutionEnvironment- Returns:
- a description of this execution environemtn
-
isHeadless
public boolean isHeadless()Get whether this execution environment is headless- Specified by:
isHeadlessin interfaceExecutionEnvironment- Returns:
- true if this execution environment is headless
-
setHeadless
public void setHeadless(boolean headless) Set whether this execution environment is headless- Specified by:
setHeadlessin interfaceExecutionEnvironment- Parameters:
headless- true if the execution environment is headless
-
getGraphicalEnvironmentCommandHandler
Get the environment for performing commands at the application-level in a graphical environment.- Specified by:
getGraphicalEnvironmentCommandHandlerin interfaceExecutionEnvironment- Returns:
- the graphical environment command handler, or null if running headless
-
setGraphicalEnvironmentCommandHandler
Set the environment for performing commands at the application-level in a graphical environment.- Specified by:
setGraphicalEnvironmentCommandHandlerin interfaceExecutionEnvironment
-
getEnvironmentVariables
Get environment variables for this execution environment- Specified by:
getEnvironmentVariablesin interfaceExecutionEnvironment- Returns:
- the environment variables for this execution environment
-
setEnvironmentVariables
Set environment variables for this execution environment- Specified by:
setEnvironmentVariablesin interfaceExecutionEnvironment- Parameters:
env- the environment variables to use
-
setSettings
Description copied from interface:ExecutionEnvironmentSet knowledge flow settings for this execution environment- Specified by:
setSettingsin interfaceExecutionEnvironment- Parameters:
settings- the settings to use
-
getSettings
Description copied from interface:ExecutionEnvironmentGet knowledge flow settings for this execution environment- Specified by:
getSettingsin interfaceExecutionEnvironment- Returns:
- the settings to use
-
getLog
Get the log in use- Specified by:
getLogin interfaceExecutionEnvironment- Returns:
- the log in use
-
setLog
Set the log to use- Specified by:
setLogin interfaceExecutionEnvironment- Parameters:
log- the log to use
-
getLoggingLevel
Get the logging level in use- Specified by:
getLoggingLevelin interfaceExecutionEnvironment- Returns:
- the logging level in use
-
setLoggingLevel
Set the logging level to use- Specified by:
setLoggingLevelin interfaceExecutionEnvironment- Parameters:
level- the logging level to use
-
submitTask
Submit a task to be run by the execution environment. The default execution environment uses an ExecutorService to run tasks in parallel. Client steps are free to use this service or to just do their processing locally within their own code.- Specified by:
submitTaskin interfaceExecutionEnvironment- Parameters:
stepTask- the StepTask encapsulating the code to be run- Returns:
- the Future holding the status and result when complete
- Throws:
WekaException- if processing fails in the case of
-
stopProcessing
public void stopProcessing()The main point at which to request stop processing of a flow. This will request the FlowExecutor to stop and then shutdown the executor service- Specified by:
stopProcessingin interfaceExecutionEnvironment
-
getDefaultFlowExecutor
Gets a new instance of the default flow executor suitable for use with this execution environment- Returns:
- a new instance of the default flow executor suitable for use with this execution environment
-
getFlowExecutor
Get the executor that will actually be responsible for running the flow. This is not guaranteed to be available from this execution environment until the flow is actually running (or at least initialized)- Returns:
- the executor that will be running the flow
-
setFlowExecutor
Set the executor that will actually be responsible for running the flow. This is not guaranteed to be available from this execution environment until the flow is actually running (or at least initialized)- Parameters:
executor- the executor that will be running the flow
-
getDefaultSettings
Get default settings for the base execution environment- Specified by:
getDefaultSettingsin interfaceExecutionEnvironment- Returns:
- the default settings
-