gov.nist.nlpir.irf.irfman
Class IrfManager

java.lang.Object
  |
  +--gov.nist.nlpir.irf.irfman.IrfManager

public class IrfManager
extends java.lang.Object

Information Retrieval Manager

The IrfManager is a central, globally accessible control object through which document collections, indexes, and other information can be accessed. The IrfManager is responsible for the global thread of control, although this is mostly delegated to other parts of the framework.

Version:
$Revision: 1.3 $
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.

Field Summary
private  java.lang.String directoryForInfoServerSerialization
           
private  InfoServer infoServer
           
 
Constructor Summary
IrfManager(java.lang.String serializationDirectory, boolean createIfNotFound)
           
 
Method Summary
 InfoServer getInfoServer()
          Get the InfoServer that is part of this IrfManager
 java.util.Vector getModifiedDocColls()
          Find the document collections that have been modified
 java.lang.String makeInfoServerSerializationFileName()
          Compose the fully qualified name of the InfoServer serialization file from the directoryForInfoServerSerialization and the fixed name of the file "DB.Info".
 java.lang.String makeLastOid_FileName()
           
private  java.lang.String makeSerializationNameWith(java.lang.String serializedInfoServerFileName)
           
 void present()
          Print out information on the contents of the IrfManager
 boolean setDirectoryForInfoServerSerialization(java.lang.String directory)
          Set the directory for serializing the InfoServer iff none is set
 void shutdown()
          Serialize the IrfManager to a known location
 
Methods inherited from class java.lang.Object
, clone, equals, finalize, getClass, hashCode, notify, notifyAll, registerNatives, toString, wait, wait, wait
 

Field Detail

infoServer

private InfoServer infoServer

directoryForInfoServerSerialization

private java.lang.String directoryForInfoServerSerialization
Constructor Detail

IrfManager

public IrfManager(java.lang.String serializationDirectory,
                  boolean createIfNotFound)
           throws java.io.FileNotFoundException
Method Detail

getInfoServer

public InfoServer getInfoServer()
Get the InfoServer that is part of this IrfManager
Returns:
the InfoServer which is a component of this IRManager

setDirectoryForInfoServerSerialization

public boolean setDirectoryForInfoServerSerialization(java.lang.String directory)
Set the directory for serializing the InfoServer iff none is set
Parameters:
directory - directory in which InfoServer is to be serialized

makeInfoServerSerializationFileName

public java.lang.String makeInfoServerSerializationFileName()
Compose the fully qualified name of the InfoServer serialization file from the directoryForInfoServerSerialization and the fixed name of the file "DB.Info".
Returns:
name fully qualified file name for InfoServer serialization

makeLastOid_FileName

public java.lang.String makeLastOid_FileName()

makeSerializationNameWith

private java.lang.String makeSerializationNameWith(java.lang.String serializedInfoServerFileName)

present

public void present()
Print out information on the contents of the IrfManager

getModifiedDocColls

public java.util.Vector getModifiedDocColls()
Find the document collections that have been modified
Returns:
the modified document collections

shutdown

public void shutdown()
Serialize the IrfManager to a known location