org.teiid.internal.core.index
Class IndexOutput

java.lang.Object
  org.teiid.internal.core.index.IndexOutput

Direct Known Subclasses:

BlocksIndexOutput

public abstract class IndexOutput
extends java.lang.Object

An indexOutput is used to write an index into a different object (a File, ...).

Constructor Summary

IndexOutput()

Method Summary

abstract void	addFile(IndexedFile file) Adds a File to the destination.
abstract void	addWord(WordEntry word) Adds a word to the destination.
abstract void	close() Closes the output, releasing the resources it was using.
abstract void	flush() Flushes the output.
abstract java.lang.Object	getDestination() Returns the Object the output is writing to.
abstract void	open() Opens the output, before writing any information.

Methods inherited from class java.lang.Object

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

Constructor Detail

IndexOutput

public IndexOutput()

Method Detail

addFile

public abstract void addFile(IndexedFile file)
                      throws java.io.IOException

Adds a File to the destination.

Throws:

java.io.IOException

addWord

public abstract void addWord(WordEntry word)
                      throws java.io.IOException

Adds a word to the destination.

Throws:

java.io.IOException

close

public abstract void close()
                    throws java.io.IOException

Closes the output, releasing the resources it was using.

Throws:

java.io.IOException

flush

public abstract void flush()
                    throws java.io.IOException

Flushes the output.

Throws:

java.io.IOException

getDestination

public abstract java.lang.Object getDestination()

Returns the Object the output is writing to. It can be a file, another type of index, ...

open

public abstract void open()
                   throws java.io.IOException

Opens the output, before writing any information.

Throws:

java.io.IOException