ds.granules.operation

Class OperationBase

java.lang.Object

ds.granules.operation.OperationBase

All Implemented Interfaces:

FormatMarshaller, Operation, OperationConfiguration

Direct Known Subclasses:

MapReduceBase

public abstract class OperationBase
extends java.lang.Object
implements Operation, OperationConfiguration

This is an implementation of the Operation and OperationConfiguration interfaces. This is an abstract class, and the only method that classes extending this class need to implement is the execute() method.

Author:

Shrideep Pallickara

Nested Class Summary

Nested classes/interfaces inherited from interface ds.granules.operation.Operation

Operation.OperationType

Constructor Summary

Constructors

Constructor and Description
OperationBase()

Method Summary

Modifier and Type	Method and Description
void	dispose() Reclaim resources if any prior to exiting ...
abstract void	execute() Execute the operation.
DatasetCollection	getDatasetCollection() Retrieve the dataset that is associated with this particular operation.
java.lang.String	getDomain() Get information about the domain for this operation
ExecutionProfile	getExecutionProfile() Retrieve the execution profile associated with this operation
java.lang.String	getInstanceIdentifier() Retrieve the instance identifier for this operation.
java.lang.String	getOperationIdentifier() Retrieve the identifier associated with this operation.
java.util.Properties	getProcessingDirectives() These properties encapsulate the set of processing directives that are needed to initialize the operation in question.
long	getVersionInformation() A monotonically increasing version number needs to be associated with the operations.
boolean	hasDatasetCollection() Returns true if this operation operates on an underlying dataset collection.
boolean	hasExecutionProfile() Check to see if this operation has an execution profile
boolean	hasProcessingDirectives() Checks to see if the operation has processing directives
abstract void	initialize(java.util.Properties providedDirectives) Initialize the operation based on the specified processing directives.
boolean	isInitialized() Check if the operation has been initialized
void	markInitializationAsComplete()
void	marshall(FormatWriter mFormat)
boolean	needsInitialization() Returns an indicator that indicates if the initialization needs to be performed.
void	setAsExecuteFixedNumberOfTimes(int numOfTimes) Sets the operation as being executable a fixed number of times.
void	setAsExecuteOnce() Sets the operation as being executable exactly once.
void	setAsExecutePeriodically(long executionInterval) Sets the operation as being executable periodically at the specified intervals.
void	setAsExecuteWhenDataAvailable() Sets the operation as being executable when data is available
void	setAsStayAlive() Sets the operation as being stayAlive.
void	setDatasetCollection(DatasetCollection datasetCollection) Establish the dataset needed by the application in question
void	setDomain(java.lang.String domain) Sets the domain for this operation
void	setInitializationComplete() Mark the initialization of the application as having completed
void	setInitializationNeeded(boolean needsInitialization) Set/Unset whether this operation needs initialization.
void	setInstanceIdentifier(java.lang.String instanceIdentifier) Sets the instance identifier associated with a given operation.
void	setOperationIdentifier(java.lang.String operationIdentifier) This method sets the operation identifier for a given operation
void	setProcessingDirectives(java.util.Properties processingDirectives) Set the processing directives for the operation
void	setTeminationConditionReached() Mark the termination condition of this operation as having reached.
void	setVersionInformation(long versionInformation) Sets the version information for this operation.
boolean	terminationConditionReached() This indicates if the operation has completed or not.
java.lang.String	toString() A summarized String-based representation of the operation
void	unmarshall(FormatReader mFormat) Unmarshall the operation from a set of marshalled bytes.

Methods inherited from class java.lang.Object

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

Constructor Detail

OperationBase

public OperationBase()

Method Detail

unmarshall

public void unmarshall(FormatReader mFormat)
                throws FormatException

Description copied from interface: Operation

Unmarshall the operation from a set of marshalled bytes.

Specified by:

unmarshall in interface Operation

Parameters:

mFormat - The byte[] representation of the operation.

Throws:

FormatException

marshall

public void marshall(FormatWriter mFormat)
              throws FormatException

Specified by:

marshall in interface FormatMarshaller

Parameters:

mFormat - - The format writer to write to

Throws:

FormatException - If there was a problem while writing

getDomain

public java.lang.String getDomain()

Description copied from interface: Operation

Get information about the domain for this operation

Specified by:

getDomain in interface Operation

Returns:

The domain for this operation

getExecutionProfile

public ExecutionProfile getExecutionProfile()

Description copied from interface: Operation

Retrieve the execution profile associated with this operation

Specified by:

getExecutionProfile in interface Operation

Returns:

The execution profile associated with the operation.

getOperationIdentifier

public java.lang.String getOperationIdentifier()

Description copied from interface: Operation

Retrieve the identifier associated with this operation.

Specified by:

getOperationIdentifier in interface Operation

Returns:

The operation identifier

setOperationIdentifier

public void setOperationIdentifier(java.lang.String operationIdentifier)

Description copied from interface: OperationConfiguration

This method sets the operation identifier for a given operation

Specified by:

setOperationIdentifier in interface OperationConfiguration

setInstanceIdentifier

public void setInstanceIdentifier(java.lang.String instanceIdentifier)

Description copied from interface: OperationConfiguration

Sets the instance identifier associated with a given operation.

Specified by:

setInstanceIdentifier in interface OperationConfiguration

getInstanceIdentifier

public java.lang.String getInstanceIdentifier()

Description copied from interface: Operation

Retrieve the instance identifier for this operation. Every time an instance is created, this identifier is automatically created. The value of the instance identifier can also be set.

Specified by:

getInstanceIdentifier in interface Operation

Returns:

The instance identifier for this operation.

getProcessingDirectives

public java.util.Properties getProcessingDirectives()

Description copied from interface: Operation

These properties encapsulate the set of processing directives that are needed to initialize the operation in question. Specifically, these directives are utilized by the operation to initialize the datasets that are needed by the operation.

Specified by:

getProcessingDirectives in interface Operation

Returns:

The processing directives associated with the operation.

setProcessingDirectives

public void setProcessingDirectives(java.util.Properties processingDirectives)

Description copied from interface: OperationConfiguration

Set the processing directives for the operation

Specified by:

setProcessingDirectives in interface OperationConfiguration

getVersionInformation

public long getVersionInformation()

Description copied from interface: Operation

A monotonically increasing version number needs to be associated with the operations. This allows the container to determine if the classes need to be reloaded.

Specified by:

getVersionInformation in interface Operation

Returns:

The version number needs to be associated with this operation.

initialize

public abstract void initialize(java.util.Properties providedDirectives)
                         throws ProcessingException

Description copied from interface: Operation

Initialize the operation based on the specified processing directives. The initialization will throw a ProcessingException is there are problems.

Specified by:

initialize in interface Operation

Parameters:

providedDirectives - The specified processing directives

Throws:

ProcessingException - If there are problems initializing based on the specified processing directives.

execute

public abstract void execute()
                      throws ProcessingException

Description copied from interface: Operation

Execute the operation.

Specified by:

execute in interface Operation

Throws:

ProcessingException - If there are problems executing the operation in question.

dispose

public void dispose()

Description copied from interface: Operation

Reclaim resources if any prior to exiting ...

Specified by:

dispose in interface Operation

hasExecutionProfile

public boolean hasExecutionProfile()

Description copied from interface: Operation

Check to see if this operation has an execution profile

Specified by:

hasExecutionProfile in interface Operation

Returns:

true if the operation has an execution profile; false otherwise.

hasProcessingDirectives

public boolean hasProcessingDirectives()

Description copied from interface: Operation

Checks to see if the operation has processing directives

Specified by:

hasProcessingDirectives in interface Operation

Returns:

true if the operation has processing directives; false otherwise.

terminationConditionReached

public boolean terminationConditionReached()

Description copied from interface: Operation

This indicates if the operation has completed or not. For an operation whose execution profile indicates that the operation isStayAlive() the operation will be resident till such time that this flag has been set signifying that the operation is ready for teardown.

Specified by:

terminationConditionReached in interface Operation

Returns:

true if the operation has reached its termination condition; false otherwise.

isInitialized

public boolean isInitialized()

Description copied from interface: Operation

Check if the operation has been initialized

Specified by:

isInitialized in interface Operation

Returns:

true if the operation has been initialized; false otherwise.

markInitializationAsComplete

public void markInitializationAsComplete()

needsInitialization

public boolean needsInitialization()

Description copied from interface: Operation

Returns an indicator that indicates if the initialization needs to be performed. Some operations do not need any initializations prior to execution

Specified by:

needsInitialization in interface Operation

Returns:

true if the operation has needs to be initialized; false otherwise.

toString

public java.lang.String toString()

Description copied from interface: Operation

A summarized String-based representation of the operation

Specified by:

toString in interface Operation

Overrides:

toString in class java.lang.Object

Returns:

The String representation of the operation.

getDatasetCollection

public DatasetCollection getDatasetCollection()

Description copied from interface: Operation

Retrieve the dataset that is associated with this particular operation.

Specified by:

getDatasetCollection in interface Operation

Returns:

The underlying dataset collection.

hasDatasetCollection

public boolean hasDatasetCollection()

Description copied from interface: Operation

Returns true if this operation operates on an underlying dataset collection.

Specified by:

hasDatasetCollection in interface Operation

Returns:

true if the operation has an underlying dataset collection; false otherwise.

setDatasetCollection

public void setDatasetCollection(DatasetCollection datasetCollection)

Description copied from interface: OperationConfiguration

Establish the dataset needed by the application in question

Specified by:

setDatasetCollection in interface OperationConfiguration

setDomain

public void setDomain(java.lang.String domain)

Description copied from interface: OperationConfiguration

Sets the domain for this operation

Specified by:

setDomain in interface OperationConfiguration

setInitializationComplete

public void setInitializationComplete()

Description copied from interface: OperationConfiguration

Mark the initialization of the application as having completed

Specified by:

setInitializationComplete in interface OperationConfiguration

setInitializationNeeded

public void setInitializationNeeded(boolean needsInitialization)

Description copied from interface: OperationConfiguration

Set/Unset whether this operation needs initialization.

Specified by:

setInitializationNeeded in interface OperationConfiguration

setTeminationConditionReached

public void setTeminationConditionReached()

Description copied from interface: OperationConfiguration

Mark the termination condition of this operation as having reached. If the execution profile of the operation is isStayAlive() the operation cannot be garbage collected till such time that this flag has been set.

Specified by:

setTeminationConditionReached in interface OperationConfiguration

setVersionInformation

public void setVersionInformation(long versionInformation)

Description copied from interface: OperationConfiguration

Sets the version information for this operation.

Specified by:

setVersionInformation in interface OperationConfiguration

setAsExecuteFixedNumberOfTimes

public void setAsExecuteFixedNumberOfTimes(int numOfTimes)

Description copied from interface: OperationConfiguration

Sets the operation as being executable a fixed number of times. If the value that is specified is either 0 or 1, this method simply returns without performing any actions. It would be as if this method was never invoked.

Specified by:

setAsExecuteFixedNumberOfTimes in interface OperationConfiguration

setAsExecuteOnce

public void setAsExecuteOnce()

Description copied from interface: OperationConfiguration

Sets the operation as being executable exactly once.

Specified by:

setAsExecuteOnce in interface OperationConfiguration

setAsExecutePeriodically

public void setAsExecutePeriodically(long executionInterval)

Description copied from interface: OperationConfiguration

Sets the operation as being executable periodically at the specified intervals. If the specified execution interval is 0, the method simply returns without performing any actions. It would be as if this method was never invoked. This method will introduce additional upper and lower bounds subsequently.

Specified by:

setAsExecutePeriodically in interface OperationConfiguration

setAsStayAlive

public void setAsStayAlive()

Description copied from interface: OperationConfiguration

Sets the operation as being stayAlive. The operation will not be dismounted till such time that the termination condition associated with the operation has been set.

Specified by:

setAsStayAlive in interface OperationConfiguration

setAsExecuteWhenDataAvailable

public void setAsExecuteWhenDataAvailable()

Description copied from interface: OperationConfiguration

Sets the operation as being executable when data is available

Specified by:

setAsExecuteWhenDataAvailable in interface OperationConfiguration