org.dlese.dpc.index.reader
Class NewsOppsDocReader

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.NewsOppsDocReader

All Implemented Interfaces:

Serializable

public class NewsOppsDocReader
extends XMLDocReader

A bean for accessing the data stored in a Lucene Document that was indexed from a DLESE news and opportunities metadata record. The index writer that is responsible for creating this type of Lucene Document is a NewsOppsFileIndexingWriter.

Author:

John Weatherley

See Also:

NewsOppsFileIndexingWriter, 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

NewsOppsDocReader()
Constructor for the NewsOppsDocReader object

NewsOppsDocReader(org.apache.lucene.document.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[]	getAnnouncements() Gets the announcements attribute of the NewsOppsDocReader object
String	getAnnouncementUrl() Gets the announcement Url.
Date	getApplyByDate() Gets the applyByDate attribute of the NewsOppsDocReader object
Date	getArchiveDate() Gets the archiveDate attribute of the NewsOppsDocReader object
String[]	getAudiences() Gets the audiences attribute of the NewsOppsDocReader object
String[]	getCityStates() Gets an array of city state strings for display.
String	getDescription() Gets the description of the new-opps item.
String[]	getDiversities() Gets the diversities attribute of the NewsOppsDocReader object
Date	getDueDate() Gets the dueDate attribute of the NewsOppsDocReader object
Date	getEventStartDate() Gets the eventStartDate attribute of the NewsOppsDocReader object
Date	getEventStopDate() Gets the eventStopDate attribute of the NewsOppsDocReader object
String[]	getKeywords() Gets the keywords attribute of the NewsOppsDocReader object
String[]	getLocations() Gets the locations, which are two character state or country codes, for example 'CO'.
Date	getPostDate() Gets the postDate attribute of the NewsOppsDocReader object
String	getReaderType() Gets the String 'NewsOppsDocReader,' which is the key that describes this reader type.
Date	getRecordCreationtDate() Gets the recordCreationtDate attribute of the NewsOppsDocReader object
String[]	getSponsors() Gets the sponsors attribute of the NewsOppsDocReader object
String	getTitle() Gets the title of the new-opps item.
String[]	getTopics() Gets the topics attribute of the NewsOppsDocReader object
String	getUrl() The primary URL, which for news opps is the same as getAnnouncementUrl().

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, 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, getUiLabelFromVocabId, getUiLabelFromVocabName, getUiLabelsFromVocabIds, 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

NewsOppsDocReader

public NewsOppsDocReader()

Constructor for the NewsOppsDocReader object

NewsOppsDocReader

public NewsOppsDocReader(org.apache.lucene.document.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 'NewsOppsDocReader,' 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 'NewsOppsDocReader'.

getTitle

public String getTitle()

Gets the title of the new-opps item.

Overrides:

getTitle in class XMLDocReader

Returns:

The title

getDescription

public String getDescription()

Gets the description of the new-opps item.

Overrides:

getDescription in class XMLDocReader

Returns:

The description

getAnnouncementUrl

public String getAnnouncementUrl()

Gets the announcement Url. Same as getUrl().

Returns:

The announcementUrl value

getUrl

public String getUrl()

The primary URL, which for news opps is the same as getAnnouncementUrl().

Overrides:

getUrl in class XMLDocReader

Returns:

Same as getAnnouncementUrl()

getAnnouncements

public String[] getAnnouncements()

Gets the announcements attribute of the NewsOppsDocReader object

Returns:

The announcements value

getTopics

public String[] getTopics()

Gets the topics attribute of the NewsOppsDocReader object

Returns:

The topics value

getKeywords

public String[] getKeywords()

Gets the keywords attribute of the NewsOppsDocReader object

Returns:

The keywords value

getAudiences

public String[] getAudiences()

Gets the audiences attribute of the NewsOppsDocReader object

Returns:

The audiences value

getDiversities

public String[] getDiversities()

Gets the diversities attribute of the NewsOppsDocReader object

Returns:

The diversities value

getLocations

public String[] getLocations()

Gets the locations, which are two character state or country codes, for example 'CO'.

Returns:

The locations value

getCityStates

public String[] getCityStates()

Gets an array of city state strings for display. These are comprised of a city, if provided, followed by a comma followed by the state abbreviation. For example 'Boulder, CO'.

Returns:

An array of city-state strings, for example 'Boulder, CO'

getSponsors

public String[] getSponsors()

Gets the sponsors attribute of the NewsOppsDocReader object

Returns:

The sponsors value

getEventStartDate

public Date getEventStartDate()

Gets the eventStartDate attribute of the NewsOppsDocReader object

Returns:

The eventStartDate value

getEventStopDate

public Date getEventStopDate()

Gets the eventStopDate attribute of the NewsOppsDocReader object

Returns:

The eventStopDate value

getArchiveDate

public Date getArchiveDate()

Gets the archiveDate attribute of the NewsOppsDocReader object

Returns:

The archiveDate value

getPostDate

public Date getPostDate()

Gets the postDate attribute of the NewsOppsDocReader object

Returns:

The postDate value

getRecordCreationtDate

public Date getRecordCreationtDate()

Gets the recordCreationtDate attribute of the NewsOppsDocReader object

Returns:

The recordCreationtDate value

getDueDate

public Date getDueDate()

Gets the dueDate attribute of the NewsOppsDocReader object

Returns:

The dueDate value

getApplyByDate

public Date getApplyByDate()

Gets the applyByDate attribute of the NewsOppsDocReader object

Returns:

The applyByDate value