org.dlese.dpc.index.reader
Class DleseAnnoDocReader

java.lang.Object
  org.dlese.dpc.index.reader.DocReader
      org.dlese.dpc.index.reader.FileIndexingServiceDocReader
          org.dlese.dpc.index.reader.XMLDocReader
              org.dlese.dpc.index.reader.DleseAnnoDocReader

All Implemented Interfaces:

Serializable

public class DleseAnnoDocReader

extends XMLDocReader

Index Doc reader that reads DLESE Annotataion Documents that were created by a DleseAnnoFileIndexingServiceWriter.

Author:

John Weatherley

See Also:

ResultDoc, DleseAnnoFileIndexingServiceWriter, Serialized Form

Field Summary

Fields inherited from class org.dlese.dpc.index.reader.XMLDocReader

recordDataService, vocab

Fields inherited from class org.dlese.dpc.index.reader.DocReader

conf, doc, score

Constructor Summary

DleseAnnoDocReader(Document doc)
Constructor that may be used programatically to wrap a reader around a Lucene Document that was created by a FileIndexingServiceWriter.

DleseAnnoDocReader(Document doc, float score, ResultDocConfig conf)
Constructor that is used by ResultDoc at search time to create a new instance.

Method Summary

ResultDoc	getAnnotatedItemResultDoc()
String	getDate()
String	getDescription()
String	getIsAudioInProgress()
String	getIsCompleted()
String	getIsGraphicalInProgress()
String	getIsPartOfDrc()
String	getIsTextInProgress()
String	getItemId()
String	getPathway()
String	getReaderType() Gets the String 'DleseAnnoDocReader,' which is the key that describes this reader type.
String	getServiceName()
String	getStatus()
String	getTitle()
String	getType()
String	getUrl()
boolean	isAudioInProgress()
boolean	isCompleted()
boolean	isGraphicalInProgress()
boolean	isPartOfDrc()
boolean	isTextInProgress()

Methods inherited from class org.dlese.dpc.index.reader.XMLDocReader

getAvailableFormats, getCollectionKey, getCollectionKeys, getCollections, getDocsource, getFieldName, getId, getIndexedContent, getMetadataPrefix, getNativeFormat, getOaiDatestamp, getOaiLastModifiedString, getSets, getSetString, getValidationReport, getXml, getXmlFormat, getXmlStripped, isValid, setXMLConversionService

Methods inherited from class org.dlese.dpc.index.reader.FileIndexingServiceDocReader

fileExists, getDateStamp, getDeleted, getDocDir, getDocsourceEncoded, getDoctype, getFileExists, getFileName, getFullContent, getLastModified, getLastModifiedString, getSourceFile, isDeleted, prtln, prtlnErr, setDebug

Methods inherited from class org.dlese.dpc.index.reader.DocReader

getDocument, getIndex, getQuery, getScore, setDoc

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DleseAnnoDocReader

public DleseAnnoDocReader(Document doc,
                          float score,
                          ResultDocConfig conf)

Constructor that is used by ResultDoc at search time to create a new instance.

Parameters:

doc - The Lucene Document that is read.

score - The rank of the Document in a set of results.

DleseAnnoDocReader

public DleseAnnoDocReader(Document doc)

Constructor that may be used programatically to wrap a reader around a Lucene Document that was created by a FileIndexingServiceWriter.

Parameters:

doc - A Lucene Document created by a ItemFileIndexingWriter.

Method Detail

getReaderType

public String getReaderType()

Gets the String 'DleseAnnoDocReader,' which is the key that describes this reader type. This may be used in (Struts) beans to determine which type of reader is available for a given search result and thus what data is available for display in the UI. The reader type determines which getter methods are available.

Overrides:

getReaderType in class XMLDocReader

Returns:

The String 'DleseAnnoDocReader'.

getAnnotatedItemResultDoc

public ResultDoc getAnnotatedItemResultDoc()

getServiceName

public String getServiceName()

getItemId

public String getItemId()

getTitle

public String getTitle()

getDescription

public String getDescription()

getUrl

public String getUrl()

getPathway

public String getPathway()

getStatus

public String getStatus()

getType

public String getType()

getDate

public String getDate()

getIsPartOfDrc

public String getIsPartOfDrc()

isPartOfDrc

public boolean isPartOfDrc()

getIsCompleted

public String getIsCompleted()

isCompleted

public boolean isCompleted()

isAudioInProgress

public boolean isAudioInProgress()

getIsAudioInProgress

public String getIsAudioInProgress()

isTextInProgress

public boolean isTextInProgress()

getIsTextInProgress

public String getIsTextInProgress()

isGraphicalInProgress

public boolean isGraphicalInProgress()

getIsGraphicalInProgress

public String getIsGraphicalInProgress()