distributed.core

Class DistributedJob

java.lang.Object

distributed.core.DistributedJob

All Implemented Interfaces:

java.io.Serializable, weka.core.CommandlineRunnable, weka.core.EnvironmentHandler

public abstract class DistributedJob
extends java.lang.Object
implements weka.core.EnvironmentHandler, java.io.Serializable, weka.core.CommandlineRunnable

Abstract base class for all distributed jobs.

Version:

$Revision: 12440 $

Author:

Mark Hall (mhall{[at]}pentaho{[dot]}com)

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DistributedJob.JobStatus Enum of job status states

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	WEKA_ADDITIONAL_PACKAGES_KEY Property key for specifying weka packages to use in the job

Method Summary

Modifier and Type	Method and Description
java.lang.String	environmentSubstitute(java.lang.String orig) Substitute environment variables in the supplied string.
java.util.List<java.lang.String>	getAdditionalWekaPackageNames(DistributedJobConfig config) Get a list of weka packages to use from the supplied config
java.lang.String	getJobName() Get the job name
DistributedJob.JobStatus	getJobStatus() Get the status of the current job
weka.gui.Logger	getLog() Get the log in use
void	logMessage(java.lang.String message) Log a message
void	logMessage(java.lang.String message, java.lang.Throwable ex) Log a message with a stack trace from an exception
void	logMessage(java.lang.Throwable ex) Log a stack trace from an exception
static java.lang.String	makeOptionsStr(java.lang.Object obj) Utility method to make a "help" options string for the supplied object (if it is an OptionHandler)
static weka.core.Instance	objectRowToInstance(java.lang.Object[] row, CSVToARFFHeaderMapTask rowHelper, weka.core.Instances headerNoSummary, boolean setStringVals, boolean sparse) Utility method to convert a row of values into an Instance
static weka.core.Instance	parseInstance(java.lang.String row, CSVToARFFHeaderMapTask rowHelper, weka.core.Instances headerNoSummary, boolean setStringVals) Utility method to parse an Instance out of a row of CSV data.
void	postExecution() Perform any teardown stuff that might need to happen after execution.
void	preExecution() Perform any setup stuff that might need to happen before commandline execution.
void	run(java.lang.Object toRun, java.lang.String[] options) Execute the supplied object.
abstract boolean	runJob() Run the job.
void	setEnvironment(weka.core.Environment env)
void	setJobDescription(java.lang.String jobDescription) Set the job description
void	setJobName(java.lang.String jobName) Set the job name
void	setJobStatus(DistributedJob.JobStatus status) Set the status of the current job
void	setLog(weka.gui.Logger log) Set the log to use
void	setStatusMessagePrefix(java.lang.String prefix) Set the prefix to use for log status messages (primarily for use in the Knowledge Flow's status area)
static java.lang.String	stackTraceToString(java.lang.Throwable throwable) Convert a stack trace from a Throwable to a string
void	statusMessage(java.lang.String message) Send a message to the status
void	stopJob() Signal that the job should abort (if it is currently running)

Methods inherited from class java.lang.Object

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

Field Detail

WEKA_ADDITIONAL_PACKAGES_KEY

public static final java.lang.String WEKA_ADDITIONAL_PACKAGES_KEY

Property key for specifying weka packages to use in the job

See Also:

Constant Field Values

Method Detail

makeOptionsStr

public static java.lang.String makeOptionsStr(java.lang.Object obj)

Utility method to make a "help" options string for the supplied object (if it is an OptionHandler)

Parameters:

obj - the object to create an options description for

Returns:

the options description for the supplied object

parseInstance

public static weka.core.Instance parseInstance(java.lang.String row,
                                               CSVToARFFHeaderMapTask rowHelper,
                                               weka.core.Instances headerNoSummary,
                                               boolean setStringVals)
                                        throws java.io.IOException

Utility method to parse an Instance out of a row of CSV data.

Parameters:

row - the row of data to convert to an Instance

rowHelper - the CSVToARFFHeaderMap task to use for parsing purposes

headerNoSummary - the header of the data (sans summary attributes) that contains attribute information for the instance

setStringVals - true if the values of string attributes are to be set on the header (rather than accumulate in the header).

Returns:

an Instance

Throws:

java.io.IOException - if a problem occurs

objectRowToInstance

public static weka.core.Instance objectRowToInstance(java.lang.Object[] row,
                                                     CSVToARFFHeaderMapTask rowHelper,
                                                     weka.core.Instances headerNoSummary,
                                                     boolean setStringVals,
                                                     boolean sparse)
                                              throws java.io.IOException

Utility method to convert a row of values into an Instance

Parameters:

row - the row of data to convert to an Instance

rowHelper - the configured CSVToARFFHeaderMap task to use for getting default nominal values from

headerNoSummary - the header of the data (sans summary attributes) that contains attribute information for the instance

setStringVals - true if the values of string attributes are to be set on the header (rather than accumulate in the header).

sparse - true if a sparse instance should be created instead of a dense one

Returns:

an Instance

Throws:

java.io.IOException - if a problem occurs

stackTraceToString

public static java.lang.String stackTraceToString(java.lang.Throwable throwable)

Convert a stack trace from a Throwable to a string

Parameters:

throwable - the Throwable to get the stack trace from

Returns:

the stack trace as a string

getAdditionalWekaPackageNames

public java.util.List<java.lang.String> getAdditionalWekaPackageNames(DistributedJobConfig config)

Get a list of weka packages to use from the supplied config

Parameters:

config - the job config to extract weka package names from

Returns:

a list of weka packages configured to be used

environmentSubstitute

public java.lang.String environmentSubstitute(java.lang.String orig)

Substitute environment variables in the supplied string.

Parameters:

orig - the string to modify

Returns:

the string with environment variables resolved

getJobName

public java.lang.String getJobName()

Get the job name

Returns:

the job name

setJobName

@ProgrammaticProperty
public void setJobName(java.lang.String jobName)

Set the job name

Parameters:

jobName - the name to use

setJobDescription

public void setJobDescription(java.lang.String jobDescription)

Set the job description

Parameters:

jobDescription - the description to use

setStatusMessagePrefix

public void setStatusMessagePrefix(java.lang.String prefix)

Set the prefix to use for log status messages (primarily for use in the Knowledge Flow's status area)

Parameters:

prefix - the prefix to use

getJobStatus

public DistributedJob.JobStatus getJobStatus()

Get the status of the current job

Returns:

the status of the job

setJobStatus

@ProgrammaticProperty
public void setJobStatus(DistributedJob.JobStatus status)

Set the status of the current job

Parameters:

status - the status of the job

getLog

public weka.gui.Logger getLog()

Get the log in use

Returns:

the log in use

setLog

public void setLog(weka.gui.Logger log)

Set the log to use

Parameters:

log - the log to use

setEnvironment

public void setEnvironment(weka.core.Environment env)

Specified by:

setEnvironment in interface weka.core.EnvironmentHandler

logMessage

public void logMessage(java.lang.String message)

Log a message

Parameters:

message - the message to log

statusMessage

public void statusMessage(java.lang.String message)

Send a message to the status

Parameters:

message - the message to status

logMessage

public void logMessage(java.lang.Throwable ex)

Log a stack trace from an exception

Parameters:

ex - the exception to extract the stack trace from

logMessage

public void logMessage(java.lang.String message,
                       java.lang.Throwable ex)

Log a message with a stack trace from an exception

Parameters:

message - the message to log

ex - the Exception to extract the stack trace from

runJob

public abstract boolean runJob()
                        throws DistributedWekaException

Run the job. Subclasses to implement

Returns:

true if the job completed successfully

Throws:

DistributedWekaException - if a problem occurs

stopJob

public void stopJob()

Signal that the job should abort (if it is currently running)

preExecution

public void preExecution()
                  throws java.lang.Exception

Perform any setup stuff that might need to happen before commandline execution. Subclasses should override if they need to do something here

Specified by:

preExecution in interface weka.core.CommandlineRunnable

Throws:

java.lang.Exception - if a problem occurs during setup

run

public void run(java.lang.Object toRun,
                java.lang.String[] options)

Execute the supplied object. Subclasses need to override this method.

Specified by:

run in interface weka.core.CommandlineRunnable

Parameters:

toRun - the object to execute

options - any options to pass to the object

Throws:

java.lang.IllegalArgumentException - if the object is not of the expected type.

postExecution

public void postExecution()
                   throws java.lang.Exception

Perform any teardown stuff that might need to happen after execution. Subclasses should override if they need to do something here

Specified by:

postExecution in interface weka.core.CommandlineRunnable

Throws:

java.lang.Exception - if a problem occurs during teardown