org.apache.pig.scripting

Class ScriptEngine

java.lang.Object

org.apache.pig.scripting.ScriptEngine

Direct Known Subclasses:

GroovyScriptEngine, JrubyScriptEngine, JsScriptEngine, JythonScriptEngine, PythonScriptEngine

public abstract class ScriptEngine
extends java.lang.Object

Base class for various scripting implementations

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ScriptEngine.SupportedScriptLang

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NAMESPACE_SEPARATOR

Constructor Summary

Constructors

Constructor and Description
ScriptEngine()

Method Summary

Modifier and Type	Method and Description
static ScriptEngine	getInstance(java.lang.String scriptingLang) Gets instance of the scriptEngine for the given scripting language
static java.lang.String	getJarPath(java.lang.Class<?> clazz) Figures out the jar location from the class
protected abstract java.util.Map<java.lang.String,java.lang.Object>	getParamsFromVariables() Returns a map from local variable names to their values
protected java.util.Map<java.lang.String,java.util.List<PigStats>>	getPigStatsMap() Gets the collection of PigStats after the script is run.
static java.io.InputStream	getScriptAsStream(java.lang.String scriptPath) open a stream load a script locally or in the classpath
protected abstract java.lang.String	getScriptingLang() Gets ScriptEngine classname or keyword for the scripting language
static ScriptEngine.SupportedScriptLang	getSupportedScriptLang(java.lang.String file)
protected abstract java.util.Map<java.lang.String,java.util.List<PigStats>>	main(PigContext context, java.lang.String scriptFile) Actually runs the script file.
abstract void	registerFunctions(java.lang.String path, java.lang.String namespace, PigContext pigContext) Registers scripting language functions as Pig functions with given namespace
java.util.Map<java.lang.String,java.util.List<PigStats>>	run(PigContext pigContext, java.lang.String scriptFile) Runs a script file.

Methods inherited from class java.lang.Object

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

Field Detail

NAMESPACE_SEPARATOR

public static final java.lang.String NAMESPACE_SEPARATOR

See Also:

Constant Field Values

Constructor Detail

ScriptEngine

public ScriptEngine()

Method Detail

getScriptAsStream

public static java.io.InputStream getScriptAsStream(java.lang.String scriptPath)

open a stream load a script locally or in the classpath

Parameters:

scriptPath - the path of the script

Returns:

a stream (it is the responsibility of the caller to close it)

Throws:

java.lang.IllegalStateException - if we could not open a stream

getSupportedScriptLang

public static ScriptEngine.SupportedScriptLang getSupportedScriptLang(java.lang.String file)
                                                               throws java.io.IOException

Parameters:

file - the file to inspect

Returns:

the Supported Script Lang if this is a supported script language

Throws:

java.io.IOException - if there was an error reading the file or if the file defines explicitly an unknown #!

registerFunctions

public abstract void registerFunctions(java.lang.String path,
                                       java.lang.String namespace,
                                       PigContext pigContext)
                                throws java.io.IOException

Registers scripting language functions as Pig functions with given namespace

Parameters:

path - path of the script

namespace - namespace for the functions

pigContext - pigcontext to register functions to pig in the given namespace

Throws:

java.io.IOException

main

protected abstract java.util.Map<java.lang.String,java.util.List<PigStats>> main(PigContext context,
                                                                                 java.lang.String scriptFile)
                                                                          throws java.io.IOException

Actually runs the script file. This method will be implemented by individual script engines.

Parameters:

context - ScriptPigContext to run the script file

scriptFile - the file

Throws:

java.io.IOException

getScriptingLang

protected abstract java.lang.String getScriptingLang()

Gets ScriptEngine classname or keyword for the scripting language

getParamsFromVariables

protected abstract java.util.Map<java.lang.String,java.lang.Object> getParamsFromVariables()
                                                                                    throws java.io.IOException

Returns a map from local variable names to their values

Throws:

java.io.IOException

getJarPath

public static java.lang.String getJarPath(java.lang.Class<?> clazz)
                                   throws java.io.FileNotFoundException

Figures out the jar location from the class

Parameters:

clazz - class in the jar file

Returns:

the jar file location, null if the class was not loaded from a jar

Throws:

java.io.FileNotFoundException

getInstance

public static ScriptEngine getInstance(java.lang.String scriptingLang)
                                throws java.io.IOException

Gets instance of the scriptEngine for the given scripting language

Parameters:

scriptingLang - ScriptEngine classname or keyword for the scriptingLang

Returns:

scriptengine for the given scripting language

Throws:

java.io.IOException

run

public java.util.Map<java.lang.String,java.util.List<PigStats>> run(PigContext pigContext,
                                                                    java.lang.String scriptFile)
                                                             throws ExecException,
                                                                    java.io.IOException

Runs a script file.

Parameters:

pigContext - PigContext to run the script file

scriptFile - the file

Returns:

a collection of PigStats objects. One for each runtime instance of Pig in the script. For named pipelines, the map key is the name of the pipeline. For unnamed pipeline, the map key is the script id associated with the instance.

Throws:

ExecException

java.io.IOException

getPigStatsMap

protected java.util.Map<java.lang.String,java.util.List<PigStats>> getPigStatsMap()

Gets the collection of PigStats after the script is run.