de.unidu.is.retrieval
Interface IR

All Superinterfaces:

Retriever

All Known Subinterfaces:

MomentsIR

All Known Implementing Classes:

PDatalogIR

public interface IR

extends Retriever

An interface for abstracting from different XML-based IR engines (e.g. the XML PIRE extension, HyREX). This interface supports both creating an index as well as querying.

Since:

2003-12-16

Version:

$Revision: 1.8 $, $Date: 2005/02/21 17:29:22 $

Author:

Henrik Nottelmann

Method Summary

void	addToIndex(java.lang.String docID, org.w3c.dom.Document document) Add the XML document to the index.
void	addToIndex(java.lang.String docID, java.lang.String document) Add the XML document to the index.
void	computeIndex() Computes the index, based on the document values which were added before.
void	initIndex() Inits the index.
void	registerSchema(Schema schema) Registers the specified schema.
void	removeIndex() Removes the index.

Methods inherited from interface de.unidu.is.retrieval.Retriever

close, getDocument, getDocument, getDocuments, getResult, getResultSummaries, getSchema, getSummaries, getSummary, getSummary

Method Detail

registerSchema

public void registerSchema(Schema schema)

Registers the specified schema.

Parameters:

schema - collection schema

initIndex

public void initIndex()
               throws IndexException

Inits the index.

Throws:

IndexException

addToIndex

public void addToIndex(java.lang.String docID,
                       org.w3c.dom.Document document)
                throws IndexException,
                       DocumentNotStorableException,
                       DocumentMismatchException

Add the XML document to the index.

Parameters:

docID - document id

document - XML document

Throws:

IndexException

DocumentNotStorableException

DocumentMismatchException

addToIndex

public void addToIndex(java.lang.String docID,
                       java.lang.String document)
                throws IndexException,
                       DocumentNotStorableException,
                       DocumentMismatchException

Add the XML document to the index.

Parameters:

docID - document id

document - XML document

Throws:

IndexException

DocumentNotStorableException

DocumentMismatchException

computeIndex

public void computeIndex()
                  throws IndexException

Computes the index, based on the document values which were added before.

Throws:

IndexException

removeIndex

public void removeIndex()
                 throws IndexException

Removes the index.

Throws:

IndexException