ds.granules.results

Interface SequencingInfo

All Superinterfaces:

FormatMarshaller

All Known Implementing Classes:

SequencingWidget

public interface SequencingInfo
extends FormatMarshaller

Some applications often need to include sequencing descriptors along with their results. This interface snapshots some of the most commonly utilized features by application developers.

Author:

Shrideep Pallickara

Method Summary

Modifier and Type	Method and Description
long	getLower() Retrieve the lower-bound of the specified range.
long	getMaxSequence() Retrieve the value of the max-sequence info.
long	getSingleSequence() Retrieve the single-sequence information.
long	getUpper() Retrieve the upper-bound of the specified range.
boolean	hasMaxSequence() Check to see if the max sequence Info has been set.
boolean	hasSequenceRange() Check to see if a sequence range has been specified.
boolean	hasSingleSequence() Checks to see if this contains information about a single sequence
boolean	isMutable() Check to see if the sequencing information is mutable.
void	setMaxSequence(long maxSequenceInfo) Sets the max-sequence information.
void	setSequenceRange(long lower, long upper) Sets the sequence range based on the specified upper and lower-bounds.
void	setSingleSequence(long singleSequence) Set the single sequence Information.

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

marshall

Method Detail

hasSingleSequence

boolean hasSingleSequence()

Checks to see if this contains information about a single sequence

Returns:

true, if it contains single-sequence information; false otherwise.

getSingleSequence

long getSingleSequence()

Retrieve the single-sequence information.

Returns:

This method returns 0 if the value has not been set. Besides, the boolean check to see if this has been set; the value could be used by developers to determine if its a valid one.

hasMaxSequence

boolean hasMaxSequence()

Check to see if the max sequence Info has been set. In most cases this would not be set. However, applications that require progress information this value would be useful in gauging the completion status. Typically, this value should be a constant.

Returns:

true, if it contains the max sequence information; false otherwise.

getMaxSequence

long getMaxSequence()

Retrieve the value of the max-sequence info.

Returns:

The max sequence.

hasSequenceRange

boolean hasSequenceRange()

Check to see if a sequence range has been specified.

Returns:

true, if it contains a sequence range information; false otherwise.

getUpper

long getUpper()

Retrieve the upper-bound of the specified range.

Returns:

The upper bound of the range.

getLower

long getLower()

Retrieve the lower-bound of the specified range.

Returns:

The lower-bound of the range.

setSequenceRange

void setSequenceRange(long lower,
                      long upper)

Sets the sequence range based on the specified upper and lower-bounds.

Parameters:

lower - The lower-bound of the sequence range.

upper - The upper-bound of the sequence range.

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.

setMaxSequence

void setMaxSequence(long maxSequenceInfo)

Sets the max-sequence information. This should be a constant for a given computation.

Parameters:

maxSequenceInfo - The max sequence 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.

setSingleSequence

void setSingleSequence(long singleSequence)

Set the single sequence Information.

Parameters:

singleSequence - The single sequence 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.

isMutable

boolean isMutable()

Check to see if the sequencing information is mutable. Once the sequencing information has been tagged as immutable, invoking the setter methods will result in a Runtime Exception.

Returns:

true, if the sequence is mutable; false otherwise.