io.github.bigbio.pgatk.io.clustering

Interface IClusterSourceReader

All Superinterfaces:

Iterator<Spectrum>, MzIterableReader, Serializable

All Known Implementing Classes:

ClusteringFileReader

public interface IClusterSourceReader
extends MzIterableReader

Created by jg on 10.07.14.

Method Summary

Modifier and Type	Method and Description
List<ICluster>	readAllClusters() This function reads all clusters from the clustering source.
ICluster	readCluster(String id) Read a specific cluster.
void	readClustersIteratively(Collection<IClusterSourceListener> listeners) This function includes spectra if they are available.
boolean	supportsReadAllClusters()

Methods inherited from interface io.github.bigbio.pgatk.io.common.MzIterableReader

close, hasNext, next

Methods inherited from interface java.util.Iterator

forEachRemaining, remove

Method Detail

readAllClusters

List<ICluster> readAllClusters()
                        throws Exception

This function reads all clusters from the clustering source. Spectra are never included in this output.

Returns:

Throws:

Exception

supportsReadAllClusters

boolean supportsReadAllClusters()

readClustersIteratively

void readClustersIteratively(Collection<IClusterSourceListener> listeners)
                      throws Exception

This function includes spectra if they are available.

Parameters:

listeners -

Throws:

Exception

readCluster

ICluster readCluster(String id)
              throws Exception

Read a specific cluster.

Parameters:

id - The cluster's id

Returns:

The cluster.

Throws:

Exception