uk.ac.sanger.npg.illumina.file.reader
Class CLocsFileReader

java.lang.Object
  extended by uk.ac.sanger.npg.illumina.file.reader.IlluminaFileReader
      extended by uk.ac.sanger.npg.illumina.file.reader.PositionFileReader
          extended by uk.ac.sanger.npg.illumina.file.reader.CLocsFileReader
All Implemented Interfaces:
java.io.Closeable, java.util.Iterator<java.lang.Object>

public class CLocsFileReader
extends PositionFileReader

This class is a reader of a clocs file


Nested Class Summary
 
Nested classes/interfaces inherited from class uk.ac.sanger.npg.illumina.file.reader.PositionFileReader
PositionFileReader.Position
 
Field Summary
 
Fields inherited from class uk.ac.sanger.npg.illumina.file.reader.PositionFileReader
currentTotalClusters
 
Fields inherited from class uk.ac.sanger.npg.illumina.file.reader.IlluminaFileReader
fileName, inputStream
 
Constructor Summary
CLocsFileReader(java.lang.String cLocsFileName)
          Constructor
 
Method Summary
 int getCurrentBlock()
           
 int getTotalBlocks()
           
 boolean hasNext()
          this method should mean hasNextBlock Maybe no any cluster available in the rest of blocks
static void main(java.lang.String[] args)
           
 PositionFileReader.Position next()
           
 
Methods inherited from class uk.ac.sanger.npg.illumina.file.reader.PositionFileReader
getCurrentTotalClusters
 
Methods inherited from class uk.ac.sanger.npg.illumina.file.reader.IlluminaFileReader
close, getFileName, readFourBytes, readFourBytes, remove
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

CLocsFileReader

public CLocsFileReader(java.lang.String cLocsFileName)
                throws java.lang.Exception
Constructor

Parameters:
cLocsFileName - clocs file name
Throws:
java.lang.Exception
Method Detail

hasNext

public boolean hasNext()
this method should mean hasNextBlock Maybe no any cluster available in the rest of blocks

Specified by:
hasNext in interface java.util.Iterator<java.lang.Object>
Overrides:
hasNext in class IlluminaFileReader
Returns:
true if there is next cluster but the next() method will return null even if this method return true when the rest of blocks have no cluster there

next

public PositionFileReader.Position next()
Specified by:
next in interface java.util.Iterator<java.lang.Object>
Specified by:
next in class PositionFileReader
Returns:
[x, y]

getTotalBlocks

public int getTotalBlocks()
Returns:
the totalBlocks

getCurrentBlock

public int getCurrentBlock()
Returns:
the currentBlock

main

public static void main(java.lang.String[] args)
                 throws java.lang.Exception
Parameters:
args -
Throws:
java.lang.Exception