public interface Results
extends ds.funnel.data.format.FormatMarshaller
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
|
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 |
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.
|
boolean isMutable()
true
if the result is mutable;
false
otherwise.long getTimestamp()
boolean isPartialResult()
true
if the result is a partial one;
false
otherwise.boolean isCompleteResult()
true
if the result is a complete result;
false
otherwise.boolean isProcessingComplete()
true
if the processing is complete;
false
otherwise.String getResultIdentifier()
String getInstanceIdentifier()
boolean hasRespondTo()
true
if the result has a respondTo field;
false
otherwise.String getRespondTo()
void setRespondTo(String respondTo)
respondTo
- The respondTo fieldIllegalModificationException
- 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.boolean hasSequencingInfo()
true
if the result has a sequencing info associated
with it; false
otherwise.SequencingInfo createSequenceInfo()
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.SequencingInfo getSequencingInfo()
int getResultType()
void setResultType(int resultType)
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.byte[] getResultPayload()
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.void setResultPayload(byte[] resultsPayload)
resultsPayload
- The payloadNullPointerException
- 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.byte[] getBytes() throws IOException
IOException
- If there are problems in the marshalling process.Copyright © 2015. All rights reserved.