com.googlecode.javaewah
Interface IteratingRLW

All Known Implementing Classes:
BufferedIterator, IteratingBufferedRunningLengthWord

public interface IteratingRLW

High-level iterator over a compressed bitmap.


Method Summary
 IteratingRLW clone()
           
 void discardFirstWords(long x)
           
 long getLiteralWordAt(int index)
           
 int getNumberOfLiteralWords()
           
 boolean getRunningBit()
           
 long getRunningLength()
           
 boolean next()
           
 long size()
           
 

Method Detail

next

boolean next()
Returns:
whether there is more

getLiteralWordAt

long getLiteralWordAt(int index)
Parameters:
index - where the literal word is
Returns:
the literal word at the given index.

getNumberOfLiteralWords

int getNumberOfLiteralWords()
Returns:
the number of literal (non-fill) words

getRunningBit

boolean getRunningBit()
Returns:
the bit used for the fill bits

size

long size()
Returns:
sum of getRunningLength() and getNumberOfLiteralWords()

getRunningLength

long getRunningLength()
Returns:
length of the run of fill words

discardFirstWords

void discardFirstWords(long x)
Parameters:
x - the number of words to discard

clone

IteratingRLW clone()
                   throws CloneNotSupportedException
Returns:
a copy of the iterator
Throws:
CloneNotSupportedException - this should not be thrown in theory


Copyright © 2013. All Rights Reserved.