ds.granules.results

Interface Results

All Superinterfaces:

FormatMarshaller

All Known Implementing Classes:

ResultsWidget

public interface Results
extends FormatMarshaller

The results interface allows functions to encapsulate results and other lightweight metadata information that would be associated with them.

Author:

Shrideep Pallickara

Method Summary

Modifier and Type	Method and Description
SequencingInfo	createSequenceInfo() Create the sequencing information to be associated with this result.
byte[]	getBytes() Marshall the result as a set of bytes
java.lang.String	getInstanceIdentifier() Retrieve the instance identifier of the application instance that has generated the result(s).
java.lang.String	getRespondTo() Retrieve the respondTo field for the Results
java.lang.String	getResultIdentifier() Gets the identifier for this slice of the results.
byte[]	getResultPayload() Retrieve the payload associated with this result.
int	getResultType() Get the type of the result encapsulated within the payload.
SequencingInfo	getSequencingInfo() Retrieves the sequencing information associated with this result.
long	getTimestamp() Retrieve the timestamp for this result.
boolean	hasRespondTo() Check to see if a respondTo field has been included as part of this result.
boolean	hasSequencingInfo() Check to see if a Sequencing Info has been associated with this result.
boolean	isCompleteResult() Check to see if this results encapsulates the complete result from processing.
boolean	isMutable() Checks to see if this data structure is mutable.
boolean	isPartialResult() Check to see if this is a partial result, within a stream of results that constitute the final result.
boolean	isProcessingComplete() Check to see if the instance has completed processing of its input dataset.
void	setRespondTo(java.lang.String respondTo) Set the respondTo field for the Results
void	setResultPayload(byte[] resultsPayload) Sets the payload for the Results.
void	setResultType(int resultType) Set the type of the result encapsulated within the payload.

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

marshall

Method Detail

isMutable

boolean isMutable()

Checks to see if this data structure is mutable. Once a result is ready to be written onto an output stream, it will no loner be mutable. This is to prevent inadvertent corruption on packets as they are being readied for transmission.

Returns:

true if the result is mutable; false otherwise.

getTimestamp

long getTimestamp()

Retrieve the timestamp for this result.

Returns:

The time (in milliseconds) when this result was generated

isPartialResult

boolean isPartialResult()

Check to see if this is a partial result, within a stream of results that constitute the final result.

Returns:

true if the result is a partial one; false otherwise.

isCompleteResult

boolean isCompleteResult()

Check to see if this results encapsulates the complete result from processing.

Returns:

true if the result is a complete result; false otherwise.

isProcessingComplete

boolean isProcessingComplete()

Check to see if the instance has completed processing of its input dataset. In most cases, no further results will be expected from the instance in question.

Returns:

true if the processing is complete; false otherwise.

getResultIdentifier

java.lang.String getResultIdentifier()

Gets the identifier for this slice of the results.

Returns:

The identifier for the results-slice.

getInstanceIdentifier

java.lang.String getInstanceIdentifier()

Retrieve the instance identifier of the application instance that has generated the result(s).

Returns:

The instance identifier of the generating application instance.

hasRespondTo

boolean hasRespondTo()

Check to see if a respondTo field has been included as part of this result.

Returns:

true if the result has a respondTo field; false otherwise.

getRespondTo

java.lang.String getRespondTo()

Retrieve the respondTo field for the Results

Returns:

The respondTo field for the Results

setRespondTo

void setRespondTo(java.lang.String respondTo)

Set the respondTo field for the Results

Parameters:

respondTo - The respondTo field

Throws:

IllegalModificationException - If the SequencingInfo object has been closed for modifications. Once a result is submitted to be written to the output streams, the Results and its constituent objects are closed for modifications.

hasSequencingInfo

boolean hasSequencingInfo()

Check to see if a Sequencing Info has been associated with this result.

Returns:

true if the result has a sequencing info associated with it; false otherwise.

createSequenceInfo

SequencingInfo createSequenceInfo()

Create the sequencing information to be associated with this result. Once a result has been deemed immutable, invoking this method will result in a Runtime Exception.

Returns:

The newly created sequencing information.

Throws:

IllegalModificationException - If the SequencingInfo object has been closed for modifications. Once a result is submitted to be written to the output streams, the Results and its constituent objects are closed for modifications.

getSequencingInfo

SequencingInfo getSequencingInfo()

Retrieves the sequencing information associated with this result.

Returns:

The SequencingInfo associated with the result.

getResultType

int getResultType()

Get the type of the result encapsulated within the payload. In some cases it would be long[], int[] or some other compound type.

Returns:

The type of the result.

setResultType

void setResultType(int resultType)

Set the type of the result encapsulated within the payload. In some cases this payload would be long[], int[] or some other compound type.

Throws:

IllegalModificationException - If the SequencingInfo object has been closed for modifications. Once a result is submitted to be written to the output streams, the Results and its constituent objects are closed for modifications.

getResultPayload

byte[] getResultPayload()

Retrieve the payload associated with this result. The ResultPayload contains utility methods to marshall and un-marshall different types of payloads such as int[], long[], float[] etc. The ResultPayload class also contains constants for different payload types, which can be used as the argument to setResultType() method of this interface.

Returns:

the byte[] result payload.

setResultPayload

void setResultPayload(byte[] resultsPayload)

Sets the payload for the Results. In some cases this payload would be long[], int[] or some other compound type. The package includes several utility classes for converting data types into byte[].

Parameters:

resultsPayload - The payload

Throws:

java.lang.NullPointerException - if the payload is NULL.

IllegalModificationException - If the SequencingInfo object has been closed for modifications. Once a result is submitted to be written to the output streams, the Results and its constituent objects are closed for modifications.

getBytes

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

Marshall the result as a set of bytes

Returns:

The byte[] representation of the Result.

Throws:

java.io.IOException - If there are problems in the marshalling process.