de.unidu.is.retrieval
Interface Retriever

All Known Subinterfaces:

IR, MomentsIR

All Known Implementing Classes:

AbstractRetriever, Async2SyncRetriever, PDatalogIR

public interface Retriever

An interface for abstracting from different XML-based IR engines (e.g. the XML PIRE extension, HyREX). This interface only supports the retrieval part.

Since:

2004-03-14

Version:

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

Author:

Henrik Nottelmann

Method Summary

void	close() Closes the retriever, and optionally frees used system resources (e.g. closes a network connection).
org.w3c.dom.Document	getDocument(ProbDoc doc) Returns the full XML document.
org.w3c.dom.Document	getDocument(java.lang.String docID) Returns the full XML document.
java.util.List	getDocuments(java.util.List result) Returns the full XML documents.
java.util.List	getResult(Query query) Returns result for the specified query.
java.util.List	getResultSummaries(Query query) Returns a summarised result for the specified query.
Schema	getSchema() Returns the schema used by this retriever.
java.util.List	getSummaries(java.util.List result) Returns summaries of the XML documents.
org.w3c.dom.Document	getSummary(ProbDoc doc) Returns a summary of the XML document.
org.w3c.dom.Document	getSummary(java.lang.String docID) Returns a summary of the XML document.

Method Detail

getSchema

public Schema getSchema()

Returns the schema used by this retriever.

Returns:

schema used by this retriever

getResult

public java.util.List getResult(Query query)
                         throws UnsupportedQueryException,
                                IndexException

Returns result for the specified query.

Parameters:

query - XIRQL query

Returns:

list of ProbDoc instances

Throws:

UnsupportedQueryException

IndexException

getResultSummaries

public java.util.List getResultSummaries(Query query)
                                  throws UnsupportedQueryException,
                                         IndexException,
                                         DocumentNotFoundException

Returns a summarised result for the specified query.

Parameters:

query - XIRQL query

Returns:

list of XMLDoc instances

Throws:

UnsupportedQueryException

IndexException

DocumentNotFoundException

getSummary

public org.w3c.dom.Document getSummary(java.lang.String docID)
                                throws DocumentNotFoundException

Returns a summary of the XML document.

Parameters:

docID - document id

Returns:

summary of XML document

Throws:

DocumentNotFoundException

getSummary

public org.w3c.dom.Document getSummary(ProbDoc doc)
                                throws DocumentNotFoundException

Returns a summary of the XML document.

Parameters:

doc - document descriptor

Returns:

summary of XML document

Throws:

DocumentNotFoundException

getSummaries

public java.util.List getSummaries(java.util.List result)
                            throws DocumentNotFoundException

Returns summaries of the XML documents.

Parameters:

result - list of ProbDoc instances

Returns:

list of XMLDoc instances

Throws:

DocumentNotFoundException

getDocument

public org.w3c.dom.Document getDocument(java.lang.String docID)
                                 throws DocumentNotFoundException

Returns the full XML document.

Parameters:

docID - document id

Returns:

full XML document

Throws:

DocumentNotFoundException

getDocument

public org.w3c.dom.Document getDocument(ProbDoc doc)
                                 throws DocumentNotFoundException

Returns the full XML document.

Parameters:

doc - document descriptor

Returns:

full XML document

Throws:

DocumentNotFoundException

getDocuments

public java.util.List getDocuments(java.util.List result)
                            throws DocumentNotFoundException

Returns the full XML documents.

Parameters:

result - list of ProbDoc instances

Returns:

list of XMLDoc instances

Throws:

DocumentNotFoundException

close

public void close()
           throws IndexException

Closes the retriever, and optionally frees used system resources (e.g. closes a network connection).

Throws:

IndexException