ds.granules.results

Class ResultsWidget

java.lang.Object

ds.granules.results.ResultsWidget

All Implemented Interfaces:

ds.funnel.data.format.FormatMarshaller, Results

public class ResultsWidget
extends Object
implements Results

This class is an implementation of the Results interface.

Author:

Shrideep Pallickara

Field Summary

Fields

Modifier and Type	Field and Description
static String	MODULE

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ResultsWidget(ds.funnel.data.format.FormatReader mFormat) Reconstructs the ResultsWidget from a set of bytes
protected	ResultsWidget(String instanceIdentifier, String resultIdentifier, boolean completeResult, boolean processingComplete)

Method Summary

Methods

Modifier and Type	Method and Description
SequencingInfo	createSequenceInfo() Create the sequencing information to be associated with this result.
byte[]	getBytes() Deprecated.
String	getInstanceIdentifier() Retrieve the instance identifier of the application instance that has generated the result(s).
String	getRespondTo() Retrieve the respondTo field for the Results
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	marshall(ds.funnel.data.format.FormatWriter mFormat)
protected void	setImmutable()
void	setRespondTo(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 class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

MODULE

public static final String MODULE

See Also:

Constant Field Values

Constructor Detail

ResultsWidget

protected ResultsWidget(String instanceIdentifier,
             String resultIdentifier,
             boolean completeResult,
             boolean processingComplete)

ResultsWidget

protected ResultsWidget(ds.funnel.data.format.FormatReader mFormat)
                 throws ds.funnel.data.format.FormatException

Reconstructs the ResultsWidget from a set of bytes

Parameters:

marshalledBytes -

Throws:

IOException

MarshallingException

ds.funnel.data.format.FormatException

Method Detail

createSequenceInfo

public SequencingInfo createSequenceInfo()

Description copied from interface: Results

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.

Specified by:

createSequenceInfo in interface Results

Returns:

The newly created sequencing information.

getRespondTo

public String getRespondTo()

Description copied from interface: Results

Retrieve the respondTo field for the Results

Specified by:

getRespondTo in interface Results

Returns:

The respondTo field for the Results

setRespondTo

public void setRespondTo(String respondTo)

Description copied from interface: Results

Set the respondTo field for the Results

Specified by:

setRespondTo in interface Results

Parameters:

respondTo - The respondTo field

getResultIdentifier

public String getResultIdentifier()

Description copied from interface: Results

Gets the identifier for this slice of the results.

Specified by:

getResultIdentifier in interface Results

Returns:

The identifier for the results-slice.

getResultType

public int getResultType()

Description copied from interface: Results

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

Specified by:

getResultType in interface Results

Returns:

The type of the result.

setResultType

public void setResultType(int resultType)

Description copied from interface: Results

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

Specified by:

setResultType in interface Results

getSequencingInfo

public SequencingInfo getSequencingInfo()

Description copied from interface: Results

Retrieves the sequencing information associated with this result.

Specified by:

getSequencingInfo in interface Results

Returns:

The SequencingInfo associated with the result.

getTimestamp

public long getTimestamp()

Description copied from interface: Results

Retrieve the timestamp for this result.

Specified by:

getTimestamp in interface Results

Returns:

The time (in milliseconds) when this result was generated

hasRespondTo

public boolean hasRespondTo()

Description copied from interface: Results

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

Specified by:

hasRespondTo in interface Results

Returns:

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

hasSequencingInfo

public boolean hasSequencingInfo()

Description copied from interface: Results

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

Specified by:

hasSequencingInfo in interface Results

Returns:

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

getInstanceIdentifier

public String getInstanceIdentifier()

Description copied from interface: Results

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

Specified by:

getInstanceIdentifier in interface Results

Returns:

The instance identifier of the generating application instance.

isCompleteResult

public boolean isCompleteResult()

Description copied from interface: Results

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

Specified by:

isCompleteResult in interface Results

Returns:

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

isMutable

public boolean isMutable()

Description copied from interface: Results

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.

Specified by:

isMutable in interface Results

Returns:

true if the result is mutable; false otherwise.

setImmutable

protected void setImmutable()

isPartialResult

public boolean isPartialResult()

Description copied from interface: Results

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

Specified by:

isPartialResult in interface Results

Returns:

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

isProcessingComplete

public boolean isProcessingComplete()

Description copied from interface: Results

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.

Specified by:

isProcessingComplete in interface Results

Returns:

true if the processing is complete; false otherwise.

getResultPayload

public byte[] getResultPayload()

Description copied from interface: Results

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.

Specified by:

getResultPayload in interface Results

Returns:

the byte[] result payload.

setResultPayload

public void setResultPayload(byte[] resultsPayload)

Description copied from interface: Results

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[].

Specified by:

setResultPayload in interface Results

Parameters:

resultsPayload - The payload

getBytes

@Deprecated
public byte[] getBytes()
                throws IOException

Deprecated.

Description copied from interface: Results

Marshall the result as a set of bytes

Specified by:

getBytes in interface Results

Returns:

The byte[] representation of the Result.

Throws:

IOException - If there are problems in the marshalling process.

marshall

public void marshall(ds.funnel.data.format.FormatWriter mFormat)
              throws ds.funnel.data.format.FormatException

Specified by:

marshall in interface ds.funnel.data.format.FormatMarshaller

Throws:

ds.funnel.data.format.FormatException