gov.nist.nlpir.irf.document
Interface DocumentIntrf

All Known Subinterfaces:

CranfieldDocumentIntrf, FbisDocumentIntrf, HciDocIntrf, TrecDocumentIntrf

All Known Implementing Classes:

Document, ProxyDocument

public abstract interface DocumentIntrf

Parent class of all application IR document interfaces.

Used to provide/enforce a common view e.g., of Documents and their proxies

Version:

$Revision: 1.2 $

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.

Method Summary

void	addHTML(java.lang.StringBuffer baseString, int unused, boolean form) Adds HTML to the given string buffer.
java.util.Vector	getFeatureNames() Gets feature names of document.
java.util.Vector	getFeatureTypes() Gets feature types of document.
java.util.Vector	getFeatureValues() Gets the values of the indexable features.
java.util.Vector	getIndexingFeatures(IndexingModalities im, ProxyDocument peroxyDoc) Returns indexing features as a Vector of Vectors: one inner Vector for each modality unit.
IndexingModalities	getIndexingModalities() Gets indexing modalities for this document.
void	index(IndexingModalities im, ProxyDocument proxyDoc) Indexes this document.
java.util.Vector	makeResultsForDocMatchingQuery(QueryRep query, java.util.Vector collPartialResults) Makes a complete result for documents matching the supplied query from the partial results supplied.
void	present() Displays document in ascii form to standard out
void	presentBrief() Displays document on one line to standard out
RetrievalResult	retrieve(RetrievalModalities rm, ProxyDocument proxyDoc) Returns this document as a query.

Method Detail

getFeatureNames

public java.util.Vector getFeatureNames()

Gets feature names of document.

Returns:

The collection of feature names

getFeatureTypes

public java.util.Vector getFeatureTypes()

Gets feature types of document.

Returns:

A collection of feature types as Strings.

getFeatureValues

public java.util.Vector getFeatureValues()

Gets the values of the indexable features. Features can be indexed if they are declared public.

Returns:

a collection of Data Elements (DataElem)

present

public void present()

Displays document in ascii form to standard out

presentBrief

public void presentBrief()

Displays document on one line to standard out

index

public void index(IndexingModalities im,
                  ProxyDocument proxyDoc)

Indexes this document.

Parameters:

im - Indexing Modality list .

retrieve

public RetrievalResult retrieve(RetrievalModalities rm,
                                ProxyDocument proxyDoc)

Returns this document as a query.

Parameters:

rm - Retrieval Modalities

Returns:

The retrieval result for the given modalities.

getIndexingFeatures

public java.util.Vector getIndexingFeatures(IndexingModalities im,
                                            ProxyDocument peroxyDoc)

Returns indexing features as a Vector of Vectors: one inner Vector for each modality unit.

Parameters:

im - Indexing Modalities

Returns:

Vector containing vectors of indexing features

getIndexingModalities

public IndexingModalities getIndexingModalities()

Gets indexing modalities for this document. should be overriden by subclass.

Returns:

null always.

addHTML

public void addHTML(java.lang.StringBuffer baseString,
                    int unused,
                    boolean form)

Adds HTML to the given string buffer.

Parameters:

baseString - The StringBuffer the HTML text will be appended to.

unused - Unused.

form - Boolean set to true if you wish HTML document to be a form document.

makeResultsForDocMatchingQuery

public java.util.Vector makeResultsForDocMatchingQuery(QueryRep query,
                                                       java.util.Vector collPartialResults)

Makes a complete result for documents matching the supplied query from the partial results supplied.

Parameters:

query - The query to match.

collPR - A collection of partial Results.

Returns:

A Vector of ResultForDocMatchingQuery. There is one of them by Document in the results, containing every Result..ModalityUnit linked to this document.