com.timeindexing.io
Interface IndexHeaderWriter

All Known Subinterfaces:
HeaderFileInteractor
All Known Implementing Classes:
IndexHeaderIO

public interface IndexHeaderWriter

An index header writer This is the generic interface to an index writer.


Method Summary
 long close()
          Close an index header reader.
 boolean create(java.lang.String filename)
          Create an index header, given a filename.
 boolean create(java.lang.String filename, java.util.Properties options)
          Create an index header, given a filename and some create time options.
 long flush()
          Flush the current values to the header file.
 boolean isOpen()
          Is the index header open
 boolean open(java.lang.String filename)
          Open an index header, given a filename.
 long write()
          Write the contents of the header file out It assumes the header file is alreayd open for writing.
 

Method Detail

flush

public long flush()
           throws java.io.IOException
Flush the current values to the header file.

Throws:
java.io.IOException

write

public long write()
           throws java.io.IOException
Write the contents of the header file out It assumes the header file is alreayd open for writing.

Throws:
java.io.IOException

open

public boolean open(java.lang.String filename)
             throws java.io.IOException
Open an index header, given a filename.

Throws:
java.io.IOException

create

public boolean create(java.lang.String filename)
               throws java.io.IOException
Create an index header, given a filename.

Throws:
java.io.IOException

create

public boolean create(java.lang.String filename,
                      java.util.Properties options)
               throws java.io.IOException
Create an index header, given a filename and some create time options.

Throws:
java.io.IOException

isOpen

public boolean isOpen()
Is the index header open


close

public long close()
           throws java.io.IOException
Close an index header reader.

Throws:
java.io.IOException