ds.granules.operation

Class ExecutionProfileSetup

java.lang.Object

ds.granules.operation.ExecutionProfileSetup

All Implemented Interfaces:

ExecutionProfile

public class ExecutionProfileSetup
extends java.lang.Object
implements ExecutionProfile

Implements the ExecutionProfile. Includes support for configuring the various fields in the execution profile.

Author:

Shrideep Pallickara

Constructor Summary

Constructors

Constructor and Description
ExecutionProfileSetup(byte[] marshalledBytes)
ExecutionProfileSetup(java.lang.String operationBinding)

Method Summary

Modifier and Type	Method and Description
void	changeToExecuteFixedNumberOfTimes(int numOfTimes)
void	changeToExecuteOnce()
void	changeToExecutePeriodically(long execInterval)
void	changeToExecuteWhenDataAvailable()
void	changeToStayAlive()
byte[]	getBytes()
long	getExecutionInterval() Retrieve the execution interval.
int	getNumberOfTimesToExecute() Retrieves the number of times the operation needs to be executed.
boolean	isExcuteAFixedNumberOfTimes() Indicates whether the operation needs to be executed a fixed number of times
boolean	isExecuteOnce() This indicates if the operation needs to be executed exactly once
boolean	isExecutePeriodically() Indicates whether the operation needs to be executed periodically.
boolean	isExecuteWhenDataAvailable() This indicates that the operation should be run when new data is made available on its input datasets.
boolean	isStayAlive() This indicates that the operation should be allowed to continually run until the operation deems necessary.
void	setAsExecuteFixedNumberOfTimes(java.lang.String binding, int numOfTimes)
void	setAsExecuteOnce(java.lang.String binding)
void	setAsExecutePeriodically(java.lang.String binding, long execInterval)
void	setAsExecuteWhenDataAvailable(java.lang.String binding)
void	setAsStayAlive(java.lang.String binding)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ExecutionProfileSetup

public ExecutionProfileSetup(java.lang.String operationBinding)

ExecutionProfileSetup

public ExecutionProfileSetup(byte[] marshalledBytes)
                      throws java.io.IOException

Throws:

java.io.IOException

Method Detail

getBytes

public byte[] getBytes()
                throws java.io.IOException

Throws:

java.io.IOException

setAsExecuteOnce

public void setAsExecuteOnce(java.lang.String binding)

changeToExecuteOnce

public void changeToExecuteOnce()

setAsExecutePeriodically

public void setAsExecutePeriodically(java.lang.String binding,
                                     long execInterval)

changeToExecutePeriodically

public void changeToExecutePeriodically(long execInterval)

setAsExecuteFixedNumberOfTimes

public void setAsExecuteFixedNumberOfTimes(java.lang.String binding,
                                           int numOfTimes)

changeToExecuteFixedNumberOfTimes

public void changeToExecuteFixedNumberOfTimes(int numOfTimes)

setAsStayAlive

public void setAsStayAlive(java.lang.String binding)

changeToStayAlive

public void changeToStayAlive()

setAsExecuteWhenDataAvailable

public void setAsExecuteWhenDataAvailable(java.lang.String binding)

changeToExecuteWhenDataAvailable

public void changeToExecuteWhenDataAvailable()

getExecutionInterval

public long getExecutionInterval()

Description copied from interface: ExecutionProfile

Retrieve the execution interval. A value of 0 indicates that the operation needs not be executed periodically. The upper-bound for this value depends on the policies at individual nodes

Specified by:

getExecutionInterval in interface ExecutionProfile

Returns:

The execution interval.

getNumberOfTimesToExecute

public int getNumberOfTimesToExecute()

Description copied from interface: ExecutionProfile

Retrieves the number of times the operation needs to be executed.

Specified by:

getNumberOfTimesToExecute in interface ExecutionProfile

Returns:

The number of times, which the operation needs to be executed.

isExcuteAFixedNumberOfTimes

public boolean isExcuteAFixedNumberOfTimes()

Description copied from interface: ExecutionProfile

Indicates whether the operation needs to be executed a fixed number of times

Specified by:

isExcuteAFixedNumberOfTimes in interface ExecutionProfile

Returns:

true if the operation needs to be executed a fixed number of times;false otherwise.

isExecuteOnce

public boolean isExecuteOnce()

Description copied from interface: ExecutionProfile

This indicates if the operation needs to be executed exactly once

Specified by:

isExecuteOnce in interface ExecutionProfile

Returns:

true if this is to be executed once; false otherwise.

isExecutePeriodically

public boolean isExecutePeriodically()

Description copied from interface: ExecutionProfile

Indicates whether the operation needs to be executed periodically.

Specified by:

isExecutePeriodically in interface ExecutionProfile

Returns:

true if this is to be executed periodically; false otherwise.

isExecuteWhenDataAvailable

public boolean isExecuteWhenDataAvailable()

Description copied from interface: ExecutionProfile

This indicates that the operation should be run when new data is made available on its input datasets. This is especially useful for streaming datasets where data is continually arriving, each of which needs to be processed.

Specified by:

isExecuteWhenDataAvailable in interface ExecutionProfile

Returns:

true if this is execute when data is available; false otherwise.

isStayAlive

public boolean isStayAlive()

Description copied from interface: ExecutionProfile

This indicates that the operation should be allowed to continually run until the operation deems necessary. When the operation is ready to terminate, the operation needs to assert the terminationConditionReached flag. This is particularly useful for operations that need to run until a certain condition has been satisfied.

Specified by:

isStayAlive in interface ExecutionProfile

Returns:

true if this is stay alive; false otherwise.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object