gov.nist.nlpir.irfapps.trec.cran
Class CranfieldDocument

java.lang.Object
  |
  +--gov.nist.nlpir.irf.document.Document
        |
        +--gov.nist.nlpir.irfapps.trec.TrecDocument
              |
              +--gov.nist.nlpir.irfapps.trec.cran.CranfieldDocument

public class CranfieldDocument
extends TrecDocument

An extension of TrecDocument that models a document from the Cranfield collection (in TREC format)

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.
See Also:
Document, TrecDocument

Field Summary
 ProxyDeString author
          Document author
 ProxyDeString biblio
          Bibliographic information
 ProxyDeHtml text
          Document text
 ProxyDeString title
          Document title
 
Fields inherited from class gov.nist.nlpir.irfapps.trec.TrecDocument
docNumber, serialVersionUID
 
Fields inherited from class gov.nist.nlpir.irf.document.Document
proxyRefsCountedTrue, UID_String
 
Constructor Summary
CranfieldDocument()
          No-argument constructor
CranfieldDocument(ProxyDeString docNr, DeString ti, DeString auth, DeString bib, java.lang.String txt)
          Constructs a document given the pieces
CranfieldDocument(ProxyDeString docNr, ProxyDeString ti, ProxyDeString auth, ProxyDeString bib, ProxyDeString txt)
          Constructs a document given the pieces
CranfieldDocument(ProxyDeString docNr, java.lang.String ti, java.lang.String auth, java.lang.String bib, java.lang.String txt)
          Constructs a document given the pieces
CranfieldDocument(java.lang.String docNr)
          Constructs a document given a document number
CranfieldDocument(java.lang.String docNr, java.lang.String ti, java.lang.String auth, java.lang.String bib, java.lang.String txt)
          Constructs a document given the pieces
 
Method Summary
 boolean equals(java.lang.Object o)
          Overrides
 Document getQueryDocument()
           
 void presentBrief()
           
 java.lang.String toString()
          Returns string representation of CRANFIELD Document
 
Methods inherited from class gov.nist.nlpir.irfapps.trec.TrecDocument
hashCode
 
Methods inherited from class gov.nist.nlpir.irf.document.Document
addHTML, finalize, getFeatureNames, getFeatureTypes, getFeatureValues, getFirstInstances, getIndexingFeatures, getIndexingModalities, index, makeResultsForDocMatchingQuery, present, retrieve, setProxyRefsCountedTrue, typeName
 
Methods inherited from class java.lang.Object
, clone, getClass, notify, notifyAll, registerNatives, wait, wait, wait
 

Field Detail

title

public ProxyDeString title
Document title

author

public ProxyDeString author
Document author

biblio

public ProxyDeString biblio
Bibliographic information

text

public ProxyDeHtml text
Document text
Constructor Detail

CranfieldDocument

public CranfieldDocument()
No-argument constructor

CranfieldDocument

public CranfieldDocument(java.lang.String docNr)
Constructs a document given a document number
Parameters:
docNr - document number

CranfieldDocument

public CranfieldDocument(java.lang.String docNr,
                         java.lang.String ti,
                         java.lang.String auth,
                         java.lang.String bib,
                         java.lang.String txt)
Constructs a document given the pieces
Parameters:
docNr - document number
ti - title
auth - author
bib - bibliograhic info
txt - text

CranfieldDocument

public CranfieldDocument(ProxyDeString docNr,
                         java.lang.String ti,
                         java.lang.String auth,
                         java.lang.String bib,
                         java.lang.String txt)
Constructs a document given the pieces
Parameters:
docNr - document number
ti - title
auth - author
bib - bibliograhic info
txt - text

CranfieldDocument

public CranfieldDocument(ProxyDeString docNr,
                         DeString ti,
                         DeString auth,
                         DeString bib,
                         java.lang.String txt)
Constructs a document given the pieces
Parameters:
docNr - document number
ti - title
auth - author
bib - bibliograhic info
txt - text

CranfieldDocument

public CranfieldDocument(ProxyDeString docNr,
                         ProxyDeString ti,
                         ProxyDeString auth,
                         ProxyDeString bib,
                         ProxyDeString txt)
Constructs a document given the pieces
Parameters:
docNr - document number
ti - title
auth - author
bib - bibliograhic info
txt - text
Method Detail

toString

public java.lang.String toString()
Returns string representation of CRANFIELD Document
Overrides:
toString in class TrecDocument

equals

public boolean equals(java.lang.Object o)
Overrides
Overrides:
equals in class TrecDocument

getQueryDocument

public Document getQueryDocument()
Overrides:
getQueryDocument in class Document

presentBrief

public void presentBrief()
Overrides:
presentBrief in class Document