|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--gov.nist.nlpir.irf.document.Document
Parent class of all document classes. To create a new type of document, subclass this and create instance variables for the fields you want to support in the document. There is an example of this in gov.nist.nlpir.irfapps.hci.HciDoc. (gov.nist.nlpir.irfapps.hci.HciDoc.java)
Index
,
IdxIntern
,
HciDoc
Field Summary | |
private boolean |
proxyRefsCountedTrue
Flag indicating if references to contained proxies can be counted |
private static java.lang.String |
UID_String
Name of a system-supplied field |
Constructor Summary | |
Document()
|
Method Summary | |
void |
addHTML(java.lang.StringBuffer baseString,
int unused,
boolean form)
Adds HTML to the given string buffer. |
void |
finalize()
Updates the counts of references to proxies for the contained proxy data elements before this document is garbage collected |
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. |
void |
getFirstInstances()
Completes the recursion of getFirstInstance() calls |
java.util.Vector |
getIndexingFeatures(IndexingModalities im,
ProxyDocument proxyDoc)
Returns indexing features as a Vector of Vectors: one inner Vector for each modality unit (i.e., document field, index). |
IndexingModalities |
getIndexingModalities()
Gets indexing modalities for this document. |
abstract Document |
getQueryDocument()
Build an IR document suitable for use as a query |
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 screen |
void |
presentBrief()
Displays document on one line to standard out |
RetrievalResult |
retrieve(RetrievalModalities rm,
ProxyDocument proxyDoc)
Retrieves relevant documents to this one, as defined by the passed retreival modalities |
void |
setProxyRefsCountedTrue()
|
private static java.lang.String |
typeName(java.lang.Class t)
Returns the name of an interface or primitive type |
Methods inherited from class java.lang.Object |
|
Field Detail |
private static final java.lang.String UID_String
private boolean proxyRefsCountedTrue
Constructor Detail |
public Document()
Method Detail |
public void setProxyRefsCountedTrue()
public java.util.Vector getFeatureNames()
private static final java.lang.String typeName(java.lang.Class t)
public java.util.Vector getFeatureTypes()
public java.util.Vector getFeatureValues()
public void present()
public void presentBrief()
public void index(IndexingModalities im, ProxyDocument proxyDoc)
im
- information to control indexingproxyDoc
- proxy IR document needed for the indexing featurespublic RetrievalResult retrieve(RetrievalModalities rm, ProxyDocument proxyDoc)
rm
- Information controling retrievalproxyDoc
- A proxy IR document needed for the results builtpublic java.util.Vector getIndexingFeatures(IndexingModalities im, ProxyDocument proxyDoc)
im
- Information controling indexingproxyDoc
- A proxy IR document need to build indexing featurespublic IndexingModalities getIndexingModalities()
public void addHTML(java.lang.StringBuffer baseString, int unused, boolean form)
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.public java.util.Vector makeResultsForDocMatchingQuery(QueryRep query, java.util.Vector collPartialResults)
query
- The query to match.collPR
- A collection of partial Results.public void getFirstInstances()
VirtualProxy.getFirstInstance()
public abstract Document getQueryDocument()
public void finalize()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |