DLESE Tools
v1.6.0

org.dlese.dpc.schemedit.dcs
Class DcsDataDocReader

java.lang.Object
  extended by org.dlese.dpc.index.reader.DocReader
      extended by org.dlese.dpc.index.reader.FileIndexingServiceDocReader
          extended by org.dlese.dpc.index.reader.XMLDocReader
              extended by org.dlese.dpc.schemedit.dcs.DcsDataDocReader
All Implemented Interfaces:
Serializable

public class DcsDataDocReader
extends XMLDocReader

Reader to extract DcsData (aka "workflow status") information from a LuceneDoc created by DcsDataFileIndexingPlugin.

Author:
Jonathan Ostwald
See Also:
Serialized Form

Nested Class Summary
 
Nested classes/interfaces inherited from class org.dlese.dpc.index.reader.XMLDocReader
XMLDocReader.VocabUiLabelsCollection
 
Field Summary
 
Fields inherited from class org.dlese.dpc.index.reader.XMLDocReader
metadataVocab, recordDataService, repositoryManager
 
Fields inherited from class org.dlese.dpc.index.reader.DocReader
conf, doc, resultDoc, score
 
Constructor Summary
DcsDataDocReader()
          Constructor for the DcsDataDocReader object
DcsDataDocReader(Document doc, SimpleLuceneIndex index)
          Constructor that may be used programatically to wrap a reader around a Lucene Document created by a DleseCollectionFileIndexingWriter.
 
Method Summary
 String getIsFinalStatus()
           
 String getIsValid()
          Gets the isValid attribute of the DcsDataDocReader object
 String getLastEditor()
          Gets the title of the new-opps item.
 Date getLastTouchDate()
          Gets the eventStartDate attribute of the DcsDataDocReader object
 String getNdrHandle()
           
 String getReaderType()
          Gets the String 'DcsDataDocReader,' which is the key that describes this reader type.
 Date getRecordCreationDate()
           
 String getRecordCreator()
           
 String getStatus()
          Gets the status attribute of the DcsDataDocReader object
 String getStatusNote()
          Gets the description of the new-opps item.
 String hasNdrSyncError()
           
 
Methods inherited from class org.dlese.dpc.index.reader.XMLDocReader
getAllIds, getAnnoCollectionKeys, getAnnoFormats, getAnnoPathways, getAnnoRatings, getAnnoStatus, getAnnotationResultDocs, getAnnoTypes, getAssignedByIdRelatedRecordsMap, getAssignedByUrlRelatedRecordsMap, getAssignedRelatedIdsOfType, getAssignedRelatedUrlsOfType, getAssignedRelationshipByIdTypes, getAssignedRelationshipByUrlTypes, getAssignedRelationshipsForItemsMap, getAssociatedIds, getAudioAnnosInProgress, getAvailableFormats, getAverageAnnoRating, getAverageAnnoRatingFloat, getCanDissiminateFormat, getCollection, getCollectionKey, getCollectionKeys, getCollectionLabel, getCollections, getCompletedAdvice, getCompletedAnnoCollectionKeys, getCompletedAnnos, getCompletedAnnosOfType, getCompletedAnnotation, getCompletedAverageScores, getCompletedBias, getCompletedChallengingSituations, getCompletedChange, getCompletedComment, getCompletedEditorSummaries, getCompletedEducationalStandard, getCompletedExample, getCompletedExplanation, getCompletedQuestion, getCompletedReviews, getCompletedSeeAlso, getCompletedTeachingTips, getDescription, getDocsource, getFieldId, getGraphicalAnnosInProgress, getHasAssignedRelations, getHasCompletedAnno, getHasInProgressAnno, getHasRelations, getId, getIdEncoded, getIdsOfRecordsWithAssignedRelationships, getIndexedContent, getInProgressAnnosOfFormat, getIsMyCollectionDisabled, getIsMyCollectionEnabled, getMetadataPrefix, getMetadataVocab, getMetadataVocabAudience, getMetadataVocabLanguage, getMultiDoc, getMyCollectionDoc, getMyCollectionsRecordId, getNativeFormat, getNsdlDublinCoreXml, getNumAnnoRatings, getNumAnnoRatingsInt, getNumAudioAnnosInProgress, getNumCompletedAnnos, getNumGraphicalAnnosInProgress, getNumInProgressAnnos, getNumTextAnnosInProgress, getNumVideoAnnosInProgress, getOaiDatestamp, getOaiDublinCoreXml, getOaiLastModifiedString, getOaiSets, getRelatedIdsOfType, getRelatedRecordsMap, getRelationshipTypes, getRequestedXml, getRequestedXmlFormat, getSet, getSets, getSetString, getTextAnnosInProgress, getTitle, getUiLabelFromVocabId, getUiLabelFromVocabName, getUiLabelsFromVocabIds, getUrl, getValidationReport, getValueId, getVideoAnnosInProgress, getW3CXmlDoc, getWhatsNewDate, getWhatsNewDateDate, getWhatsNewType, getXml, getXmlDoc, getXmlFormat, getXmlLocalized, getXmlStripped, hasAnnotations, hasCompletedAnno, hasCompletedAnnoOfType, hasInProgressAnno, hasInProgressAnnoOfFormat, init, isValid, prtln, prtlnErr, setMetadataVocabAudience, setMetadataVocabLanguage, setRequestedXmlFormat
 
Methods inherited from class org.dlese.dpc.index.reader.FileIndexingServiceDocReader
fileExists, getDateFileWasIndexed, getDateFileWasIndexedString, getDateStamp, getDeleted, getDocDir, getDocsourceEncoded, getDoctype, getFile, getFileExists, getFileName, getFullContent, getFullContentEncodedAs, getLastModified, getLastModifiedAsUTC, getLastModifiedString, isDeleted, setDebug
 
Methods inherited from class org.dlese.dpc.index.reader.DocReader
doInit, getAttribute, getDocMap, getDocument, getIndex, getLazyDocMap, getQuery, getRepositoryManager, getScore, setDoc
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DcsDataDocReader

public DcsDataDocReader()
Constructor for the DcsDataDocReader object


DcsDataDocReader

public DcsDataDocReader(Document doc,
                        SimpleLuceneIndex index)
Constructor that may be used programatically to wrap a reader around a Lucene Document created by a DleseCollectionFileIndexingWriter.

Parameters:
doc - A Lucene Document created by a DleseCollectionFileIndexingWriter.
index - The index being used
Method Detail

getReaderType

public String getReaderType()
Gets the String 'DcsDataDocReader,' 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 'DcsDataDocReader'.

getLastEditor

public String getLastEditor()
Gets the title of the new-opps item.

Returns:
The title

hasNdrSyncError

public String hasNdrSyncError()

getNdrHandle

public String getNdrHandle()

getStatus

public String getStatus()
Gets the status attribute of the DcsDataDocReader object

Returns:
The status value

getStatusNote

public String getStatusNote()
Gets the description of the new-opps item.

Returns:
The description

getIsValid

public String getIsValid()
Gets the isValid attribute of the DcsDataDocReader object

Returns:
The isValid value

getIsFinalStatus

public String getIsFinalStatus()

getLastTouchDate

public Date getLastTouchDate()
Gets the eventStartDate attribute of the DcsDataDocReader object

Returns:
The eventStartDate value

getRecordCreationDate

public Date getRecordCreationDate()

getRecordCreator

public String getRecordCreator()

DLESE Tools
v1.6.0