ExecutionProfileSetup (Granules-3.0.0-SNAPSHOT API)

java.lang.Object
- ds.granules.operation.ExecutionProfileSetup

All Implemented Interfaces:

ExecutionProfile
```
public class ExecutionProfileSetup
extends 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(String operationBinding)

Constructors
Constructor and Description
`ExecutionProfileSetup(byte[] marshalledBytes)`
`ExecutionProfileSetup(String operationBinding)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`changeToExecuteContinuously()`
`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`	`isExecuteContinuously()` This computation task will run continuously as and when it is scheduled.
`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`	`setAsExecuteContinuously(String binding)`
`void`	`setAsExecuteFixedNumberOfTimes(String binding, int numOfTimes)`
`void`	`setAsExecuteOnce(String binding)`
`void`	`setAsExecutePeriodically(String binding, long execInterval)`
`void`	`setAsExecuteWhenDataAvailable(String binding)`
`void`	`setAsStayAlive(String binding)`
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - ExecutionProfileSetup
```
public ExecutionProfileSetup(String operationBinding)
```
  - ExecutionProfileSetup
```
public ExecutionProfileSetup(byte[] marshalledBytes)
                      throws IOException
```
    Throws:
    
    IOException
- Method Detail
  - getBytes
```
public byte[] getBytes()
                throws IOException
```
    Throws:
    
    IOException
  - setAsExecuteOnce
```
public void setAsExecuteOnce(String binding)
```
  - changeToExecuteOnce
```
public void changeToExecuteOnce()
```
  - setAsExecutePeriodically
```
public void setAsExecutePeriodically(String binding,
                            long execInterval)
```
  - changeToExecutePeriodically
```
public void changeToExecutePeriodically(long execInterval)
```
  - setAsExecuteFixedNumberOfTimes
```
public void setAsExecuteFixedNumberOfTimes(String binding,
                                  int numOfTimes)
```
  - changeToExecuteFixedNumberOfTimes
```
public void changeToExecuteFixedNumberOfTimes(int numOfTimes)
```
  - setAsStayAlive
```
public void setAsStayAlive(String binding)
```
  - changeToStayAlive
```
public void changeToStayAlive()
```
  - setAsExecuteWhenDataAvailable
```
public void setAsExecuteWhenDataAvailable(String binding)
```
  - changeToExecuteWhenDataAvailable
```
public void changeToExecuteWhenDataAvailable()
```
  - setAsExecuteContinuously
```
public void setAsExecuteContinuously(String binding)
```
  - changeToExecuteContinuously
```
public void changeToExecuteContinuously()
```
  - 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.
  - isExecuteContinuously
```
public boolean isExecuteContinuously()
```
    Description copied from interface: ExecutionProfile
    
    This computation task will run continuously as and when it is scheduled.
    
    Specified by:
    
    isExecuteContinuously in interface ExecutionProfile
    
    Returns:
    true if this is execute continuously; 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 String toString()
```
    Overrides:
    
    toString in class Object

Class ExecutionProfileSetup

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ExecutionProfileSetup

ExecutionProfileSetup

Method Detail

getBytes

setAsExecuteOnce

changeToExecuteOnce

setAsExecutePeriodically

changeToExecutePeriodically

setAsExecuteFixedNumberOfTimes

changeToExecuteFixedNumberOfTimes

setAsStayAlive

changeToStayAlive

setAsExecuteWhenDataAvailable

changeToExecuteWhenDataAvailable

setAsExecuteContinuously

changeToExecuteContinuously

getExecutionInterval

getNumberOfTimesToExecute

isExcuteAFixedNumberOfTimes

isExecuteOnce

isExecutePeriodically

isExecuteWhenDataAvailable

isExecuteContinuously

isStayAlive

toString