org.egothor.store

Class ProximitiesFileOut

java.lang.Object

org.egothor.store.ProximitiesFileOut

public class ProximitiesFileOut
extends Object

The ProximitiesFileOut object defines a writer of proximities of terms.

Author:

Leo Galambos

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	close() Close the output stream and mark for garbage collection.
long	save(Proximities p) Write the given Proximities to this object's output stream.

Methods inherited from class java.lang.Object

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

Constructor Detail

ProximitiesFileOut

public ProximitiesFileOut(String filename)
                   throws IOException

Constructor for the ProximitiesFileOut object. A file will be created with the given name. If the file exists it is overwritten.

Parameters:

filename - the name of the file

Throws:

IOException

Method Detail

save

public long save(Proximities p)
          throws IOException

Write the given Proximities to this object's output stream. It returns a handle - an offset where the p Proximities starts.

Parameters:

p - the Proximities to write

Returns:

an offset where the written Proximities begin

Throws:

IOException

close

public void close()
           throws IOException

Close the output stream and mark for garbage collection.

Throws:

IOException