org.apache.pig.tools.pigstats

Class ScriptState

java.lang.Object

org.apache.pig.tools.pigstats.ScriptState

Direct Known Subclasses:

MRScriptState, SparkScriptState, TezScriptState

public abstract class ScriptState
extends java.lang.Object

ScriptStates encapsulates settings for a Pig script that runs on a hadoop cluster. These settings are added to all MR jobs spawned by the script and in turn are persisted in the hadoop job xml. With the properties already in the job xml, users who want to know the relations between the script and MR jobs can derive them from the job xmls.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	ScriptState.AliasVisitor
protected static class	ScriptState.FeatureVisitor
static class	ScriptState.PIG_FEATURE Features used in a Pig script
protected static class	ScriptState.PIG_PROPERTY Keys of Pig settings added to Jobs

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	commandLine
protected java.lang.String	fileName
protected java.lang.String	hadoopVersion
protected java.lang.String	id
protected java.util.List<PigProgressNotificationListener>	listeners
protected PigContext	pigContext
protected java.lang.String	pigVersion
protected long	scriptFeatures
protected java.lang.String	serializedScript
protected java.lang.String	truncatedScript

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ScriptState(java.lang.String id)

Method Summary

Modifier and Type	Method and Description
protected long	bitSetToLong(java.util.BitSet bs)
void	emitInitialPlanNotification(OperatorPlan<?> plan)
void	emitJobFailedNotification(JobStats jobStats)
void	emitjobFinishedNotification(JobStats jobStats)
void	emitJobsSubmittedNotification(int numJobsSubmitted)
void	emitJobStartedNotification(java.lang.String assignedJobId)
void	emitLaunchCompletedNotification(int numJobsSucceeded)
void	emitLaunchStartedNotification(int numJobsToLaunch)
void	emitOutputCompletedNotification(OutputStats outputStats)
void	emitProgressUpdatedNotification(int progress)
protected java.lang.String	featureLongToString(long l)
static ScriptState	get()
java.util.List<PigProgressNotificationListener>	getAllListeners()
java.lang.String	getCommandLine()
java.lang.String	getFileName()
java.lang.String	getHadoopVersion()
java.lang.String	getId()
PigContext	getPigContext()
java.lang.String	getPigVersion()
java.lang.String	getScript()
java.lang.String	getScriptFeatures()
java.lang.String	getSerializedScript()
void	registerListener(PigProgressNotificationListener listener)
void	setCommandLine(java.lang.String commandLine)
void	setFileName(java.lang.String fileName)
void	setPigContext(PigContext pigContext)
protected void	setScript(java.io.BufferedReader reader)
void	setScript(java.io.File file)
void	setScript(java.lang.String script)
void	setScriptFeatures(LogicalPlan plan)
static ScriptState	start(ScriptState state)
static ScriptState	start(java.lang.String commandLine, PigContext pigContext) Deprecated. use start(ScriptState) instead.

Methods inherited from class java.lang.Object

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

Field Detail

id

protected java.lang.String id

serializedScript

protected java.lang.String serializedScript

truncatedScript

protected java.lang.String truncatedScript

commandLine

protected java.lang.String commandLine

fileName

protected java.lang.String fileName

pigVersion

protected java.lang.String pigVersion

hadoopVersion

protected java.lang.String hadoopVersion

scriptFeatures

protected long scriptFeatures

pigContext

protected PigContext pigContext

listeners

protected java.util.List<PigProgressNotificationListener> listeners

Constructor Detail

ScriptState

protected ScriptState(java.lang.String id)

Method Detail

get

public static ScriptState get()

start

public static ScriptState start(ScriptState state)

start

@Deprecated
public static ScriptState start(java.lang.String commandLine,
                                            PigContext pigContext)

Deprecated. use start(ScriptState) instead.

registerListener

public void registerListener(PigProgressNotificationListener listener)

getAllListeners

public java.util.List<PigProgressNotificationListener> getAllListeners()

emitInitialPlanNotification

public void emitInitialPlanNotification(OperatorPlan<?> plan)

emitLaunchStartedNotification

public void emitLaunchStartedNotification(int numJobsToLaunch)

emitJobsSubmittedNotification

public void emitJobsSubmittedNotification(int numJobsSubmitted)

emitJobStartedNotification

public void emitJobStartedNotification(java.lang.String assignedJobId)

emitjobFinishedNotification

public void emitjobFinishedNotification(JobStats jobStats)

emitJobFailedNotification

public void emitJobFailedNotification(JobStats jobStats)

emitOutputCompletedNotification

public void emitOutputCompletedNotification(OutputStats outputStats)

emitProgressUpdatedNotification

public void emitProgressUpdatedNotification(int progress)

emitLaunchCompletedNotification

public void emitLaunchCompletedNotification(int numJobsSucceeded)

setScript

public void setScript(java.io.File file)
               throws java.io.IOException

Throws:

java.io.IOException

setScript

public void setScript(java.lang.String script)
               throws java.io.IOException

Throws:

java.io.IOException

setScriptFeatures

public void setScriptFeatures(LogicalPlan plan)

getHadoopVersion

public java.lang.String getHadoopVersion()

getPigVersion

public java.lang.String getPigVersion()

getFileName

public java.lang.String getFileName()

setFileName

public void setFileName(java.lang.String fileName)

getId

public java.lang.String getId()

setCommandLine

public void setCommandLine(java.lang.String commandLine)

getCommandLine

public java.lang.String getCommandLine()

getSerializedScript

public java.lang.String getSerializedScript()

getScript

public java.lang.String getScript()

setScript

protected void setScript(java.io.BufferedReader reader)
                  throws java.io.IOException

Throws:

java.io.IOException

bitSetToLong

protected long bitSetToLong(java.util.BitSet bs)

featureLongToString

protected java.lang.String featureLongToString(long l)

setPigContext

public void setPigContext(PigContext pigContext)

getPigContext

public PigContext getPigContext()

getScriptFeatures

public java.lang.String getScriptFeatures()