CompressingMetaIndex.InputStream (Terrier 4.0 API)

java.lang.Object
- org.terrier.structures.CompressingMetaIndex.InputStream

All Implemented Interfaces:

Closeable, AutoCloseable, Iterator<String[]>

Enclosing class:

CompressingMetaIndex
```
public static class CompressingMetaIndex.InputStream
extends Object
implements Iterator<String[]>, Closeable
```
An iterator for reading a MetaIndex as a stream

Field Summary

Fields
Modifier and Type	Field and Description
`protected int`	`compressionLevel`
`protected long`	`fileLength`
`protected Inflater`	`inflater`
`protected int[]`	`keyByteOffset`
`protected int`	`keyCount`
`protected long`	`lastOffset`
`protected int`	`recordLength`
`protected int[]`	`valueByteLengths`

Constructor Summary

Constructors
Constructor and Description
`CompressingMetaIndex.InputStream(IndexOnDisk _index, String structureName)` Constructs an instance of the class with
`CompressingMetaIndex.InputStream(IndexOnDisk _index, String _structureName, int _startingId, int _endId)` Constructs an instance of the class with

Method Summary

Methods
Modifier and Type Method and Description

void close()

int getIndex()
Return the position that we are at (entry number)

boolean hasNext()

String[] next()

void remove()
- Methods inherited from class java.lang.Object
  clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods
Modifier and Type	Method and Description
`void`	`close()`
`int`	`getIndex()` Return the position that we are at (entry number)
`boolean`	`hasNext()`
`String[]`	`next()`
`void`	`remove()`

Field Detail

compressionLevel
```
protected final int compressionLevel
```

recordLength
```
protected final int recordLength
```

inflater
```
protected Inflater inflater
```

keyCount
```
protected int keyCount
```

keyByteOffset
```
protected int[] keyByteOffset
```

valueByteLengths
```
protected int[] valueByteLengths
```

lastOffset
```
protected long lastOffset
```

fileLength
```
protected long fileLength
```

Constructor Detail

CompressingMetaIndex.InputStream

public CompressingMetaIndex.InputStream(IndexOnDisk _index,
                                String _structureName,
                                int _startingId,
                                int _endId)
                                 throws IOException

Constructs an instance of the class with

Parameters:: _index -; _structureName -; _startingId -; _endId -
Throws:: IOException

CompressingMetaIndex.InputStream

public CompressingMetaIndex.InputStream(IndexOnDisk _index,
                                String structureName)
                                 throws IOException

Constructs an instance of the class with

Parameters:: _index -; structureName -
Throws:: IOException

Method Detail
- hasNext
```
public boolean hasNext()
```
  Specified by:
  
  hasNext in interface Iterator<String[]>
- getIndex
```
public int getIndex()
```
  Return the position that we are at (entry number)
- next
```
public String[] next()
```
  Specified by:
  
  next in interface Iterator<String[]>
- remove
```
public void remove()
```
  Specified by:
  
  remove in interface Iterator<String[]>
- close
```
public void close()
           throws IOException
```
  Specified by:
  
  close in interface Closeable
  
  Specified by:
  
  close in interface AutoCloseable
  
  Throws:
  
  IOException

Class CompressingMetaIndex.InputStream

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

compressionLevel

recordLength

inflater

keyCount

keyByteOffset

valueByteLengths

lastOffset

fileLength

Constructor Detail

CompressingMetaIndex.InputStream

CompressingMetaIndex.InputStream

Method Detail

hasNext

getIndex

next

remove

close