com.asakusafw.yaess.core

Class HadoopScript

java.lang.Object

com.asakusafw.yaess.core.HadoopScript

All Implemented Interfaces:

ExecutionScript

public class HadoopScript
extends Object
implements ExecutionScript

A script that describes process execution using Hadoop.

Since:

0.2.3

Version:

0.8.0

Nested Class Summary

Nested classes/interfaces inherited from interface com.asakusafw.yaess.core.ExecutionScript

ExecutionScript.Kind, ExecutionScript.PlaceholderResolver

Field Summary

Fields inherited from interface com.asakusafw.yaess.core.ExecutionScript

ENV_ASAKUSA_HOME, PLACEHOLDER_ARGUMENTS, PLACEHOLDER_EXECUTION_ID, PLACEHOLDER_HOME

Constructor Summary

Constructors

Constructor and Description
HadoopScript(String id, Set<String> blockerIds, String className, Map<String,String> hadoopProperties, Map<String,String> environmentVariables) Creates a new instance.
HadoopScript(String id, Set<String> blockerIds, String className, Map<String,String> hadoopProperties, Map<String,String> environmentVariables, Collection<String> supportedExtensions) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
Set<String>	getBlockerIds() Returns the IDs representing blockers of this script execution.
String	getClassName() Returns the target class name.
Map<String,String>	getEnvironmentVariables() Returns desired environment variables used in this execution.
Map<String,String>	getHadoopProperties() Returns the extra hadoop properties.
String	getId() Returns the ID of this script execution.
ExecutionScript.Kind	getKind() Returns the kind of this script.
Set<String>	getSupportedExtensions() Returns the supported extension names.
int	hashCode()
boolean	isResolved() Returns whether this script is resolved.
HadoopScript	resolve(ExecutionContext context, ExecutionScriptHandler<?> handler) Resolves placeholders defined in this script.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

HadoopScript

public HadoopScript(String id,
                    Set<String> blockerIds,
                    String className,
                    Map<String,String> hadoopProperties,
                    Map<String,String> environmentVariables)

Creates a new instance. Note that this creates an UNRESOLVED instance. To create a resolved instance, please use resolve(ExecutionContext, ExecutionScriptHandler).

Parameters:

id - the script ID

blockerIds - other script IDs blocking this script execution

className - fully qualified execution target class name

hadoopProperties - the extra Hadoop properties

environmentVariables - the extra environment variables

Throws:

IllegalArgumentException - if some parameters were null

HadoopScript

public HadoopScript(String id,
                    Set<String> blockerIds,
                    String className,
                    Map<String,String> hadoopProperties,
                    Map<String,String> environmentVariables,
                    Collection<String> supportedExtensions)

Creates a new instance. Note that this creates an UNRESOLVED instance. To create a resolved instance, please use resolve(ExecutionContext, ExecutionScriptHandler).

Parameters:

id - the script ID

blockerIds - other script IDs blocking this script execution

className - fully qualified execution target class name

hadoopProperties - the extra Hadoop properties

environmentVariables - the extra environment variables

supportedExtensions - the supported extension names

Throws:

IllegalArgumentException - if some parameters were null

Since:

0.8.0

Method Detail

getKind

public ExecutionScript.Kind getKind()

Description copied from interface: ExecutionScript

Returns the kind of this script.

Specified by:

getKind in interface ExecutionScript

Returns:

the kind of this script

getId

public String getId()

Description copied from interface: ExecutionScript

Returns the ID of this script execution.

Specified by:

getId in interface ExecutionScript

Returns:

the ID of this script execution

getBlockerIds

public Set<String> getBlockerIds()

Description copied from interface: ExecutionScript

Returns the IDs representing blockers of this script execution.

Specified by:

getBlockerIds in interface ExecutionScript

Returns:

blockers' ID

getClassName

public String getClassName()

Returns the target class name.

Returns:

the target class name

getHadoopProperties

public Map<String,String> getHadoopProperties()

Returns the extra hadoop properties.

Returns:

the extra hadoop properties

getEnvironmentVariables

public Map<String,String> getEnvironmentVariables()

Description copied from interface: ExecutionScript

Returns desired environment variables used in this execution.

Specified by:

getEnvironmentVariables in interface ExecutionScript

Returns:

desired environment variables

getSupportedExtensions

public Set<String> getSupportedExtensions()

Description copied from interface: ExecutionScript

Returns the supported extension names.

Specified by:

getSupportedExtensions in interface ExecutionScript

Returns:

the supported extension names

isResolved

public boolean isResolved()

Description copied from interface: ExecutionScript

Returns whether this script is resolved.

Specified by:

isResolved in interface ExecutionScript

Returns:

true for resolved instance, otherwise false

See Also:

ExecutionScript.resolve(ExecutionContext, ExecutionScriptHandler)

resolve

public HadoopScript resolve(ExecutionContext context,
                            ExecutionScriptHandler<?> handler)
                     throws InterruptedException,
                            IOException

Description copied from interface: ExecutionScript

Resolves placeholders defined in this script. This method does not change this object, but returns a resolved object.

Specified by:

resolve in interface ExecutionScript

Parameters:

context - current context

handler - target handler

Returns:

resolved object

Throws:

InterruptedException - if interrupted while resolving this object

IOException - if failed to resolve some entry

See Also:

ExecutionScript.isResolved()

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object