ds.granules.operation

Interface Operation

All Superinterfaces:

FormatMarshaller

All Known Subinterfaces:

Map, MapReduce, Reduce

All Known Implementing Classes:

ECGMonitor, EEGMap, EEGReduce, GIComputation, GzipComputation, MapReduceBase, OperationBase, RespirationMap, UpperCaseMap, WordCountMap, WordCountReduce

public interface Operation
extends FormatMarshaller

This is the interface which encapsulates an application instance that will be deployed. This interface allows access to several fields that play a role in the deployment of application instances such as: domain, operation identifier, instance identifier etc. Applications can also include support for

Author:

Shrideep Pallickara

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Operation.OperationType

Method Summary

Modifier and Type	Method and Description
void	dispose() Reclaim resources if any prior to exiting ...
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
void	initialize(java.util.Properties processingDirectives) Initialize the operation based on the specified processing directives.
boolean	isInitialized() Check if the operation has been initialized
boolean	needsInitialization() Returns an indicator that indicates if the initialization needs to be performed.
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 marshalledBytes) Unmarshall the operation from a set of marshalled bytes.

Methods inherited from interface ds.funnel.data.format.FormatMarshaller

marshall

Method Detail

getOperationIdentifier

java.lang.String getOperationIdentifier()

Retrieve the identifier associated with this operation.

Returns:

The operation identifier

getInstanceIdentifier

java.lang.String getInstanceIdentifier()

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.

Returns:

The instance identifier for this operation.

getDomain

java.lang.String getDomain()

Get information about the domain for this operation

Returns:

The domain for this operation

getVersionInformation

long getVersionInformation()

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.

Returns:

The version number needs to be associated with this operation.

hasProcessingDirectives

boolean hasProcessingDirectives()

Checks to see if the operation has processing directives

Returns:

true if the operation has processing directives; false otherwise.

getProcessingDirectives

java.util.Properties getProcessingDirectives()

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.

Returns:

The processing directives associated with the operation.

hasDatasetCollection

boolean hasDatasetCollection()

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

Returns:

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

getDatasetCollection

DatasetCollection getDatasetCollection()

Retrieve the dataset that is associated with this particular operation.

Returns:

The underlying dataset collection.

initialize

void initialize(java.util.Properties processingDirectives)
         throws ProcessingException

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

Parameters:

processingDirectives - The specified processing directives

Throws:

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

execute

void execute()
      throws ProcessingException

Execute the operation.

Throws:

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

dispose

void dispose()

Reclaim resources if any prior to exiting ...

isInitialized

boolean isInitialized()

Check if the operation has been initialized

Returns:

true if the operation has been initialized; false otherwise.

needsInitialization

boolean needsInitialization()

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

Returns:

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

terminationConditionReached

boolean terminationConditionReached()

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.

Returns:

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

hasExecutionProfile

boolean hasExecutionProfile()

Check to see if this operation has an execution profile

Returns:

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

getExecutionProfile

ExecutionProfile getExecutionProfile()

Retrieve the execution profile associated with this operation

Returns:

The execution profile associated with the operation.

unmarshall

void unmarshall(FormatReader marshalledBytes)
         throws FormatException

Unmarshall the operation from a set of marshalled bytes.

Parameters:

marshalledBytes - The byte[] representation of the operation.

Throws:

java.io.IOException - If there are problems unmarshalling this operation.

FormatException

toString

java.lang.String toString()

A summarized String-based representation of the operation

Overrides:

toString in class java.lang.Object

Returns:

The String representation of the operation.