gov.nist.nlpir.irf.handle
Class Handle

java.lang.Object
  |
  +--gov.nist.nlpir.irf.handle.Handle

Direct Known Subclasses:

gov.nist.nlpir.irf.handle.braf.BufferedRandomAccessFileHandle

public abstract class Handle

extends java.lang.Object

Parent class of all handles - objects which provide information of various sorts defined and needed by a broker to access a stored object.

Only brokers need know the form and content of the handles they use.

Version:

$Revision: 1.1 $

Author:

This software was produced by NIST, an agency of the U.S. government, and by statute is not subject to copyright in the United States. Recipients of this software assume all responsibilities associated with its operation, modification and maintenance.

Constructor Summary

Handle()

Method Summary

abstract void	readExt(BufferedRandomAccessFile in)
abstract boolean	replaceExt(BufferedRandomAccessFile out) Replaces the existing handle in the given file if it is possible at this place.
abstract void	writeExt(BufferedRandomAccessFile out) Writes an external representation of this object to a file

Methods inherited from class java.lang.Object

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

Constructor Detail

Handle

public Handle()

Method Detail

writeExt

public abstract void writeExt(BufferedRandomAccessFile out)

Writes an external representation of this object to a file

Parameters:

out - buffered random access file handle

Returns:

The size of the handle in the storage file.

replaceExt

public abstract boolean replaceExt(BufferedRandomAccessFile out)

Replaces the existing handle in the given file if it is possible at this place.

readExt

public abstract void readExt(BufferedRandomAccessFile in)