htsjdk.tribble.index

Interface ChrIndex

All Known Implementing Classes:

IntervalTreeIndex.ChrIndex, LinearIndex.ChrIndex

public interface ChrIndex

Represents an index on a specific chromosome

Method Summary

Modifier and Type	Method and Description
java.util.List<Block>	getBlocks()
java.util.List<Block>	getBlocks(int start, int end)
java.lang.String	getName()
void	read(LittleEndianInputStream dis)
void	write(LittleEndianOutputStream dos)

Method Detail

getName

java.lang.String getName()

getBlocks

java.util.List<Block> getBlocks()

Returns:

all blocks in ChrIndex

getBlocks

java.util.List<Block> getBlocks(int start,
                                int end)

Parameters:

start - the start position, one based

end - the end position, one based

Returns:

a list of blocks that include the region defined from start to stop. Can never return null

write

void write(LittleEndianOutputStream dos)
    throws java.io.IOException

Throws:

java.io.IOException

read

void read(LittleEndianInputStream dis)
   throws java.io.IOException

Throws:

java.io.IOException