ds.granules.results

Class SequencingWidget

java.lang.Object

ds.granules.results.SequencingWidget

All Implemented Interfaces:

ds.funnel.data.format.FormatMarshaller, SequencingInfo

public class SequencingWidget
extends Object
implements SequencingInfo

This class is an implementation of the SequencingInfo interface.

Author:

Shrideep Pallickara

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SequencingWidget()
protected	SequencingWidget(ds.funnel.data.format.FormatReader mFormat)

Method Summary

Methods

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	marshall(ds.funnel.data.format.FormatWriter mFormat)
protected void	setImmutable()
void	setMaxSequence(long maxSequence) 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 class java.lang.Object

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

Constructor Detail

SequencingWidget

protected SequencingWidget()

SequencingWidget

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

Throws:

ds.funnel.data.format.FormatException

Method Detail

hasMaxSequence

public boolean hasMaxSequence()

Description copied from interface: SequencingInfo

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.

Specified by:

hasMaxSequence in interface SequencingInfo

Returns:

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

setMaxSequence

public void setMaxSequence(long maxSequence)

Description copied from interface: SequencingInfo

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

Specified by:

setMaxSequence in interface SequencingInfo

Parameters:

maxSequence - The max sequence information.

getMaxSequence

public long getMaxSequence()

Description copied from interface: SequencingInfo

Retrieve the value of the max-sequence info.

Specified by:

getMaxSequence in interface SequencingInfo

Returns:

The max sequence.

hasSingleSequence

public boolean hasSingleSequence()

Description copied from interface: SequencingInfo

Checks to see if this contains information about a single sequence

Specified by:

hasSingleSequence in interface SequencingInfo

Returns:

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

setSingleSequence

public void setSingleSequence(long singleSequence)

Description copied from interface: SequencingInfo

Set the single sequence Information.

Specified by:

setSingleSequence in interface SequencingInfo

Parameters:

singleSequence - The single sequence Information.

getSingleSequence

public long getSingleSequence()

Description copied from interface: SequencingInfo

Retrieve the single-sequence information.

Specified by:

getSingleSequence in interface SequencingInfo

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.

hasSequenceRange

public boolean hasSequenceRange()

Description copied from interface: SequencingInfo

Check to see if a sequence range has been specified.

Specified by:

hasSequenceRange in interface SequencingInfo

Returns:

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

setSequenceRange

public void setSequenceRange(long lower,
                    long upper)

Description copied from interface: SequencingInfo

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

Specified by:

setSequenceRange in interface SequencingInfo

Parameters:

lower - The lower-bound of the sequence range.

upper - The upper-bound of the sequence range.

getLower

public long getLower()

Description copied from interface: SequencingInfo

Retrieve the lower-bound of the specified range.

Specified by:

getLower in interface SequencingInfo

Returns:

The lower-bound of the range.

getUpper

public long getUpper()

Description copied from interface: SequencingInfo

Retrieve the upper-bound of the specified range.

Specified by:

getUpper in interface SequencingInfo

Returns:

The upper bound of the range.

isMutable

public boolean isMutable()

Description copied from interface: SequencingInfo

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.

Specified by:

isMutable in interface SequencingInfo

Returns:

true, if the sequence is mutable; false otherwise.

setImmutable

protected void setImmutable()

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