eu.stratosphere.client

Class LocalExecutor

java.lang.Object

eu.stratosphere.api.common.PlanExecutor

eu.stratosphere.client.LocalExecutor

public class LocalExecutor
extends PlanExecutor

A class for executing a Plan on a local embedded Stratosphere instance.

Constructor Summary

Constructors

Constructor and Description
LocalExecutor()

Method Summary

Methods

Modifier and Type	Method and Description
static JobExecutionResult	execute(Plan plan) Executes the program represented by the given Pact plan.
static JobExecutionResult	execute(Program pa, String... args) Executes the program described by the given plan assembler.
JobExecutionResult	executePlan(Plan plan) Execute the given plan on the local Nephele instance, wait for the job to finish and return the runtime in milliseconds.
String	getConfigDir()
String	getHdfsConfig()
int	getJobManagerRpcPort()
String	getOptimizerPlanAsJSON(Plan plan) Returns a JSON dump of the optimized plan.
static String	getPlanAsJSON(Plan plan) Return unoptimized plan as JSON.
int	getTaskManagerDataPort()
int	getTaskManagerRpcPort()
boolean	isDefaultAlwaysCreateDirectory()
boolean	isDefaultOverwriteFiles()
static String	optimizerPlanAsJSON(Plan plan) Returns a JSON dump of the optimized plan.
void	setConfigDir(String configDir)
void	setDefaultAlwaysCreateDirectory(boolean defaultAlwaysCreateDirectory)
void	setDefaultOverwriteFiles(boolean defaultOverwriteFiles)
void	setHdfsConfig(String hdfsConfig)
void	setJobManagerRpcPort(int jobManagerRpcPort)
static void	setLoggingLevel(org.apache.log4j.Level lvl) Utility method for logging
static void	setOverwriteFilesByDefault(boolean overwriteByDefault) By default, local environments do not overwrite existing files.
void	setTaskManagerDataPort(int taskManagerDataPort)
void	setTaskManagerRpcPort(int taskManagerRpcPort)
void	start()
void	stop() Stop the local executor instance.

Methods inherited from class eu.stratosphere.api.common.PlanExecutor

createLocalExecutor, createRemoteExecutor

Methods inherited from class java.lang.Object

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

Constructor Detail

LocalExecutor

public LocalExecutor()

Method Detail

getJobManagerRpcPort

public int getJobManagerRpcPort()

setJobManagerRpcPort

public void setJobManagerRpcPort(int jobManagerRpcPort)

getTaskManagerRpcPort

public int getTaskManagerRpcPort()

setTaskManagerRpcPort

public void setTaskManagerRpcPort(int taskManagerRpcPort)

getTaskManagerDataPort

public int getTaskManagerDataPort()

setTaskManagerDataPort

public void setTaskManagerDataPort(int taskManagerDataPort)

getConfigDir

public String getConfigDir()

setConfigDir

public void setConfigDir(String configDir)

getHdfsConfig

public String getHdfsConfig()

setHdfsConfig

public void setHdfsConfig(String hdfsConfig)

isDefaultOverwriteFiles

public boolean isDefaultOverwriteFiles()

setDefaultOverwriteFiles

public void setDefaultOverwriteFiles(boolean defaultOverwriteFiles)

isDefaultAlwaysCreateDirectory

public boolean isDefaultAlwaysCreateDirectory()

setDefaultAlwaysCreateDirectory

public void setDefaultAlwaysCreateDirectory(boolean defaultAlwaysCreateDirectory)

start

public void start()
           throws Exception

Throws:

Exception

stop

public void stop()
          throws Exception

Stop the local executor instance. You should not call executePlan after this.

Throws:

Exception

executePlan

public JobExecutionResult executePlan(Plan plan)
                               throws Exception

Execute the given plan on the local Nephele instance, wait for the job to finish and return the runtime in milliseconds.

Specified by:

executePlan in class PlanExecutor

Parameters:

plan - The plan of the program to execute.

Returns:

The net runtime of the program, in milliseconds.

Throws:

Exception - Thrown, if either the startup of the local execution context, or the execution caused an exception.

getOptimizerPlanAsJSON

public String getOptimizerPlanAsJSON(Plan plan)
                              throws Exception

Returns a JSON dump of the optimized plan.

Specified by:

getOptimizerPlanAsJSON in class PlanExecutor

Parameters:

plan - The program's plan.

Returns:

JSON dump of the optimized plan.

Throws:

Exception

execute

public static JobExecutionResult execute(Program pa,
                         String... args)
                                  throws Exception

Executes the program described by the given plan assembler.

Parameters:

pa - The program's plan assembler.

args - The parameters.

Returns:

The net runtime of the program, in milliseconds.

Throws:

Exception - Thrown, if either the startup of the local execution context, or the execution caused an exception.

execute

public static JobExecutionResult execute(Plan plan)
                                  throws Exception

Executes the program represented by the given Pact plan.

Parameters:

pa - The program's plan.

Returns:

The net runtime of the program, in milliseconds.

Throws:

Exception - Thrown, if either the startup of the local execution context, or the execution caused an exception.

optimizerPlanAsJSON

public static String optimizerPlanAsJSON(Plan plan)
                                  throws Exception

Returns a JSON dump of the optimized plan.

Parameters:

plan - The program's plan.

Returns:

JSON dump of the optimized plan.

Throws:

Exception

getPlanAsJSON

public static String getPlanAsJSON(Plan plan)

Return unoptimized plan as JSON.

Returns:

setLoggingLevel

public static void setLoggingLevel(org.apache.log4j.Level lvl)

Utility method for logging

setOverwriteFilesByDefault

public static void setOverwriteFilesByDefault(boolean overwriteByDefault)

By default, local environments do not overwrite existing files. NOTE: This method must be called prior to initializing the LocalExecutor or a LocalEnvironment.

Parameters:

overwriteByDefault - True to overwrite by default, false to not overwrite by default.