org.egothor.store

Class ProximitiesFileIn

java.lang.Object

org.egothor.store.ProximitiesFileIn

All Implemented Interfaces:

Proximities

public class ProximitiesFileIn
extends Object
implements Proximities

The ProximitiesFileIn object reads the term proximities from a file. The proximities are read by BitInputStream coding methods.

Author:

Leo Galambos

Constructor Summary

Constructors

Constructor and Description
ProximitiesFileIn(String filename) Constructor for the ProximitiesFileIn object.

Method Summary

Modifier and Type	Method and Description
void	close() Close this file.
void	closeProx() Close this list and release resources.
int	leftProx() Return the length of the proximities inverted list.
Proximities	open(long offset)
int	readProx() Read the proximities inverted list.
int	readProx(int[] prox, int offset, int len) Read an inverted list of length greater than 1.
void	rewind()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ProximitiesFileIn

public ProximitiesFileIn(String filename)
                  throws IOException

Constructor for the ProximitiesFileIn object.

Parameters:

filename - the file holding the proximities

Throws:

IOException

Method Detail

closeProx

public void closeProx()

Description copied from interface: Proximities

Close this list and release resources.

Specified by:

closeProx in interface Proximities

close

public void close()
           throws IOException

Close this file.

Throws:

IOException

rewind

public void rewind()
            throws IOException

Throws:

IOException

open

public Proximities open(long offset)
                 throws IOException

Throws:

IOException

readProx

public int readProx()
             throws IOException

Read the proximities inverted list. This is used if the invered list is of length 1.

Specified by:

readProx in interface Proximities

Returns:

the position in the list of the value read

Throws:

IOException

leftProx

public int leftProx()

Return the length of the proximities inverted list.

Specified by:

leftProx in interface Proximities

Returns:

the length

readProx

public int readProx(int[] prox,
                    int offset,
                    int len)
             throws IOException

Description copied from interface: Proximities

Read an inverted list of length greater than 1. The list will be read in blocks of the specified size.

Specified by:

readProx in interface Proximities

Parameters:

prox - the buffer

offset - first cell to fill

len - how many cell are read

Returns:

how many cells were read

Throws:

IOException