Package org.dlese.dpc.index.reader

Class ItemDocReader

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.ItemDocReader
All Implemented Interfaces:
Serializable
public class ItemDocReader extends XMLDocReader
A bean for accessing the data stored in a Lucene Document that was indexed from a DLESE item-level metadata record, such as ADN. The index writer that is responsible for creating this type of Lucene Document is a ItemFileIndexingWriter.
Author:
John Weatherley
See Also:

  • Constructor Details

    • ItemDocReader

      public ItemDocReader()
      Constructor for the ItemDocReader object

    • ItemDocReader

      public ItemDocReader(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 ItemFileIndexingWriter.
      Parameters:
      doc - A Lucene Document created by a ItemFileIndexingWriter.
      index - The SimpleLuceneIndex in use

  • Method Details

    • init

      public void init()
      Initializes the ItemDocReader at search time.
      Overrides:
      init in class XMLDocReader

    • getMultiDoc

      protected org.apache.lucene.document.Document getMultiDoc()
      Description copied from class: XMLDocReader
      Gets the multiDoc lucene Document for this item, or the single doc, if none available. A multiDoc is a Document that holds data from multiple XML records that catalog/reference the same resource. This method is overridden by the sub classes that support it.
      Overrides:
      getMultiDoc in class XMLDocReader
      Returns:
      The multiDoc value

    • getReaderType

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

    • getTitle

      public String getTitle()
      Gets the title of the item.
      Overrides:
      getTitle in class XMLDocReader
      Returns:
      The title value

    • getKeywords

      public String[] getKeywords()
      Gets the keywords as a sorted array. Duplicate keywords are ommitted.
      Returns:
      The keywords

    • getMultiKeywords

      public String[] getMultiKeywords()
      Gets the keywords for all associated records as a sorted array. Duplicate keywords are ommitted.
      Returns:
      The keywords

    • getKeywordsDisplay

      public String getKeywordsDisplay()
      Gets the keywords as a sorted comma separated list terminated with a period suitable for display to users. For example: ocean, rain, sea.
      Returns:
      The keywords displayed suitable for users.

    • getMultiTitle

      public String getMultiTitle()
      Gets the concatinated title of all associated records for this item.
      Returns:
      The concatinated title text.

    • getDescription

      public String getDescription()
      Gets the description for this item.
      Overrides:
      getDescription in class XMLDocReader
      Returns:
      The description value

    • getMultiDescription

      public String getMultiDescription()
      Gets the concatinated descriptions of all associated records for this item.
      Returns:
      The multiDescription value

    • getMultiIds

      public String getMultiIds()
      Gets the the concatinated IDs of all associated records for this item.
      Returns:
      The multiIds value

    • getPartOfDRC

      public String getPartOfDRC()
      Gets the part-of-DRC status (true or false).
      Returns:
      The String "true" or "false".

    • getUrl

      public String getUrl()
      Gets the URL for this resource.
      Overrides:
      getUrl in class XMLDocReader
      Returns:
      The url value

    • getUrlEncoded

      public String getUrlEncoded()
      Gets the URL for this resource.
      Returns:
      The url value

    • getUrlTruncated

      public String getUrlTruncated()
      Gets the URL for this resource, truncated if it is very long
      Returns:
      The url value

    • getCollectionsString

      public String getCollectionsString()
      Gets the collections associated with this record as a single String. Same as Same as XMLDocReader.getSetString().
      Returns:
      The collections.

    • getMultiWhatsNewType

      public String getMultiWhatsNewType()
      Gets the Whats New type for the multi-record (if it exists), which is one of 'itemnew,' 'itemannocomplete,' 'itemannoinprogress,' 'annocomplete,' 'annoinprogress,' 'drcannocomplete,' 'drcannoinprogress,' 'collection'.
      Returns:
      The What's New type or empty String.

    • getMultiWhatsNewDate

      public String getMultiWhatsNewDate()
      Gets the Whats New date for the multi-record as a String, which is the whats new date for this resource across all records that catalog it. Note that this is the appropriate method to use when displaying this value to an end user, instead of XMLDocReader.getWhatsNewDate().
      Returns:
      The What's New date or empty String.

    • getMultiWhatsNewDateDate

      public Date getMultiWhatsNewDateDate()
      Gets the Whats New date for the multi-record (if it exists) as a Date, which is the whats new date for this resource across all records that catalog it. Note that this is the appropriate method to use when displaying this value to an end user, instead of XMLDocReader.getWhatsNewDateDate().
      Returns:
      The What's New date or null.

    • getCreationDate

      public String getCreationDate()
      Gets the created date as a String. ADN XPath metaMetadata/dateInfo@created.
      Returns:
      The created date or empty String.

    • getCreationDateDate

      public Date getCreationDateDate()
      Gets the created date as a Java Date ADN XPath metaMetadata/dateInfo@created.
      Returns:
      The created Date or null.

    • getMultiAccessionDate

      public String getMultiAccessionDate()
      Gets the accession date for this muti-doc, as a date String, which is the date the resource first appeared in the library among all records that catalog it. Note that this is the appropriate method to use when displaying this value to an end user, instead of getAccessionDate().
      Returns:
      The accession date or empty String.

    • getMultiAccessionDateDate

      public Date getMultiAccessionDateDate()
      Gets the accession date for this multi-doc as a Java Date, which is the date the resource first appeared in the library among all records that catalog it. Note that this is the appropriate method to use when displaying this value to an end user, instead of getAccessionDateDate().
      Returns:
      The accession Date or null.

    • getAccessionDate

      public String getAccessionDate()
      Gets the accession date as a String. Note that the appropriate method to use when displaying this value to an end user is getMultiAccessionDate().
      Returns:
      The accession date or empty String.

    • getAccessionDateDate

      public Date getAccessionDateDate()
      Gets the accession date as a Java Date. Note that the appropriate method to use when displaying this value to an end user is getMultiAccessionDateDate().
      Returns:
      The accession Date or null.

    • getAccessionStatus

      public String getAccessionStatus()
      Gets the AccessionStatus for this record.
      Returns:
      The status value

    • getMultiAccessionStatus

      public String getMultiAccessionStatus()
      Gets the the concatinated accession statuses of all associated records for this item.
      Returns:
      The status value

    • getBeneficiary

      public String[] getBeneficiary()
      Gets the beneficiary attribute of the ItemDocReader object
      Returns:
      The beneficiary value

    • getToolFor

      public String[] getToolFor()
      Gets the toolFor attribute of the ItemDocReader object
      Returns:
      The toolFor value

    • getInstructionalGoal

      public String[] getInstructionalGoal()
      Gets the instructionalGoal attribute of the ItemDocReader object
      Returns:
      The instructionalGoal value

    • getTeachingMethod

      public String[] getTeachingMethod()
      Gets the teachingMethod attribute of the ItemDocReader object
      Returns:
      The teachingMethod value

    • getTypicalAgeRange

      public String[] getTypicalAgeRange()
      Gets the typicalAgeRange attribute of the ItemDocReader object
      Returns:
      The typicalAgeRange value

    • getGradeRanges

      public String[] getGradeRanges()
      Gets the grade ranges for this record, for example 07, or 'DLESE:Primary elementary' if no vocab manager is available.
      Returns:
      The grade ranges

    • getMultiGradeRanges

      public String[] getMultiGradeRanges()
      Gets the grade ranges for this record and all others that catalog the same resource, for example 07, or 'DLESE:Primary elementary' if no vocab manager is available.
      Returns:
      The grade ranges as cataloged by all records for this resource

    • getGradeRangeLabels

      public Collection getGradeRangeLabels()
      Gets the grade range UI labels from the vocab manager for this record, for example 'Primary (K-2)', or 'DLESE:Primary elementary' if the vocab manager is not available. To specify the vocab interface to use, first call
      invalid reference 
      #setVocabInterface(String)
      , otherwise the default will be used, which is 'dds.descr.en-us'.

      An example application using JSTL might look like:

         <%-- The following line is optional --%>
   <c:set property="vocabInterface" target="${docReader}" value="dds.descr.en-us"/>
   <c:forEach items="${docReader.gradeRangeLabels}" var="myVocabLabel">
        ${myVocabLabel}
   </c:forEach>
      Returns:
      A Collection of grade range UI labels as cataloged for this record

    • getMultiGradeRangeLabels

      public Collection getMultiGradeRangeLabels()
      Gets the grade range UI labels from the vocab manager for this record and all others that catalog the same resource, for example 'Primary (K-2)', or 'DLESE:Primary elementary' if the vocab manager is not available. To specify the vocab interface to use, first call
      invalid reference 
      #setVocabInterface(String)
      , otherwise the default will be used, which is 'dds.descr.en-us'.

      An example application using JSTL might look like:

         <%-- The following line is optional --%>
   <c:set property="vocabInterface" target="${docReader}" value="dds.descr.en-us"/>
   <c:forEach items="${docReader.multiGradeRangeLabels}" var="myVocabLabel">
        ${myVocabLabel}
   </c:forEach>
      Returns:
      A Collection of grade range UI labels as cataloged by all records for this resource

    • getSubjects

      public String[] getSubjects()
      Gets the subjects for this record, for example 03, or 'DLESE:Biology' if no vocab manager is available.
      Returns:
      The subjects

    • getMultiSubjects

      public String[] getMultiSubjects()
      Gets the subjects for this item and all additional items associated via the ID mapper. Duplicats are ommitted.
      Returns:
      The subjects value

    • getSubjectLabels

      public Object[] getSubjectLabels()
      Gets the subject UI labels from the vocab manager for this record, for example 'Biology', or 'DLESE:Biology' if the vocab manager is not available, sorted alphabetically. To specify the vocab interface to use, first call
      invalid reference 
      #setVocabInterface(String)
      , otherwise the default will be used, which is 'dds.descr.en-us'.

      An example application using JSTL might look like:

         <%-- The following line is optional --%>
   <c:set property="vocabInterface" target="${docReader}" value="dds.descr.en-us"/>
   <c:forEach items="${docReader.subjectLabels}" var="myVocabLabel">
        ${myVocabLabel}
   </c:forEach>
      Returns:
      An array of subject UI label strings as cataloged for this record, sorted alphabetically

    • getMultiSubjectLabels

      public Object[] getMultiSubjectLabels()
      Gets the subject UI labels from the vocab manager for this record and all others that catalog the same resource, for example 'Biology', or 'DLESE:Biology' if the vocab manager is not available, sorted alphabetically. To specify the vocab interface to use, first call
      invalid reference 
      #setVocabInterface(String)
      , otherwise the default will be used, which is 'dds.descr.en-us'.

      An example application using JSTL might look like:

         <%-- The following line is optional --%>
   <c:set property="vocabInterface" target="${docReader}" value="dds.descr.en-us"/>
   <c:forEach items="${docReader.multiSubjectLabels}" var="myVocabLabel">
        ${myVocabLabel}
   </c:forEach>
      Returns:
      An array of subject UI label Strings as cataloged by all records for this resource, sorted alphabetically

    • getContentStandards

      public String[] getContentStandards()
      Gets the content standards for this record, for example 01, or 'NSES:K-4:Unifying Concepts and Processes Standards:Change, constancy, and measurement' if no vocab manager is available.
      Returns:
      The content standards

    • getMultiContentStandards

      public String[] getMultiContentStandards()
      Gets the content standards for this record and all others that catalog the same resource, for example 01, or 'NSES:K-4:Unifying Concepts and Processes Standards:Change, constancy, and measurement' if no vocab manager is available.
      Returns:
      The content standards

    • getContentStandardLabels

      public Collection getContentStandardLabels()
      Gets the content standard UI labels from the vocab manager for this record, for example 'Change, constancy, and measurement', or 'NSES:K-4:Unifying Concepts and Processes Standards:Change, constancy, and measurement' if the vocab manager is not available. To specify the vocab interface to use, first call
      invalid reference 
      #setVocabInterface(String)
      , otherwise the default will be used, which is 'dds.descr.en-us'.

      An example application using JSTL might look like:

         <%-- The following line is optional --%>
   <c:set property="vocabInterface" target="${docReader}" value="dds.descr.en-us"/>
   <c:forEach items="${docReader.contentStandardLabels}" var="myVocabLabel">
        ${myVocabLabel}
   </c:forEach>
      Returns:
      A Collection of content standard UI labels as cataloged for this record

    • getMultiContentStandardLabels

      public Collection getMultiContentStandardLabels()
      Gets the content standard UI labels from the vocab manager for this record and all others that catalog this resource, for example 'Change, constancy, and measurement', or 'NSES:K-4:Unifying Concepts and Processes Standards:Change, constancy, and measurement' if the vocab manager is not available. To specify the vocab interface to use, first call
      invalid reference 
      #setVocabInterface(String)
      , otherwise the default will be used, which is 'dds.descr.en-us'.

      An example application using JSTL might look like:

         <%-- The following line is optional --%>
   <c:set property="vocabInterface" target="${docReader}" value="dds.descr.en-us"/>
   <c:forEach items="${docReader.multiContentStandardLabels}" var="myVocabLabel">
        ${myVocabLabel}
   </c:forEach>
      Returns:
      A Collection of content standard UI labels as cataloged by all records for this resource

    • getResourceTypes

      public String[] getResourceTypes()
      Gets the resource types for this record, for example 0c, or 'DLESE:Learning materials:Classroom activity' if no vocab manager is available.
      Returns:
      The resource types

    • getMultiResourceTypes

      public String[] getMultiResourceTypes()
      Gets the resource types for this record and all others that catalog the same resource, for example 0c, or 'DLESE:Learning materials:Classroom activity' if no vocab manager is available.
      Returns:
      The resource types

    • getResourceTypeLabels

      public Object[] getResourceTypeLabels()
      Gets the resource type UI labels from the vocab manager for this record, for example 'Classroom activity', or 'DLESE:Learning materials:Classroom activity' if the vocab manager is not available, sorted alphabetically. To specify the vocab interface to use, first call
      invalid reference 
      #setVocabInterface(String)
      , otherwise the default will be used, which is 'dds.descr.en-us'.

      An example application using JSTL might look like:

         <%-- The following line is optional --%>
   <c:set property="vocabInterface" target="${docReader}" value="dds.descr.en-us"/>
   <c:forEach items="${docReader.resourceTypeLabels}" var="myVocabLabel">
        ${myVocabLabel}
   </c:forEach>
      Returns:
      An array of resource type UI label Strings as cataloged by this record, sorted alphabetically.

    • getMultiResourceTypeLabels

      public Object[] getMultiResourceTypeLabels()
      Gets the resource type UI labels from the vocab manager for this record and all others that catalog the same resource, for example 'Classroom activity', or 'DLESE:Learning materials:Classroom activity' if the vocab manager is not available, sorted alphabetically. To specify the vocab interface to use, first call
      invalid reference 
      #setVocabInterface(String)
      , otherwise the default will be used, which is 'dds.descr.en-us'.

      An example application using JSTL might look like:

         <%-- The following line is optional --%>
   <c:set property="vocabInterface" target="${docReader}" value="dds.descr.en-us"/>
   <c:forEach items="${docReader.multiResourceTypeLabels}" var="myVocabLabel">
        ${myVocabLabel}
   </c:forEach>
      Returns:
      An array of resource type UI label Strings as cataloged by all records for this resource, sorted alphabetically

    • getMultiRecordStatus

      public String getMultiRecordStatus()
      Gets the value 'true' or 'false' depending on whether this item does or does not have multiple records associated with it.
      Returns:
      'true' if there are multiple records, 'false' if only one.

    • isMultiRecord

      public boolean isMultiRecord()
      Determines whether this item does or does not have multiple records associated with it.
      Returns:
      True if there are multiple records, false if only one.

    • hasAnnotations

      public boolean hasAnnotations()
      Determines whether this item has annotations.
      Overrides:
      hasAnnotations in class XMLDocReader
      Returns:
      True if annotations are present, false otherwise.

    • getAnnoTypes

      public String[] getAnnoTypes()
      Gets the anno types that are associated with this record.
      Overrides:
      getAnnoTypes in class XMLDocReader
      Returns:
      The anno types value.

    • getAnnoPathways

      public ArrayList getAnnoPathways()
      Gets the anno pathways that are associated with this record.
      Overrides:
      getAnnoPathways in class XMLDocReader
      Returns:
      The list of anno pathway Strings

    • getAnnoStatus

      public ArrayList getAnnoStatus()
      Gets the annotation statuses that are associated with this item.
      Overrides:
      getAnnoStatus in class XMLDocReader
      Returns:
      A list of anno status Strings

    • getAnnoFormats

      public ArrayList getAnnoFormats()
      Gets the annotation formats that are associated with this item.
      Overrides:
      getAnnoFormats in class XMLDocReader
      Returns:
      A list of anno formats Strings

    • getAnnoRatings

      public String[] getAnnoRatings()
      Gets a String array of all annotation star ratings for this item in numerical form from 1 to 5, or null if none. Each rating represents a single annotation's star rating for this item.
      Overrides:
      getAnnoRatings in class XMLDocReader
      Returns:
      An String array of numbers 1, 2, 3, 4, 5, or null

    • getAverageAnnoRating

      public String getAverageAnnoRating()
      Gets a the average of all star ratings for this item as a String, or null if none. The rating is shown to three decimal points, for example '4.333' or '3.000'.
      Overrides:
      getAverageAnnoRating in class XMLDocReader
      Returns:
      The average star rating to three decimal points as a String

    • getAverageAnnoRatingFloat

      public float getAverageAnnoRatingFloat()
      Gets a the average of all star ratings for this item as a float, or -1 if none.
      Overrides:
      getAverageAnnoRatingFloat in class XMLDocReader
      Returns:
      The average star rating or -1 if none

    • getNumAnnoRatings

      public String getNumAnnoRatings()
      Gets a the total number of star ratings for this item as a String. The number is displayed to five digits, for example '00002' or '00000'.
      Overrides:
      getNumAnnoRatings in class XMLDocReader
      Returns:
      The number of star ratings as a String

    • getNumAnnoRatingsInt

      public int getNumAnnoRatingsInt()
      Gets a the total number of star ratings for this item as a int.
      Overrides:
      getNumAnnoRatingsInt in class XMLDocReader
      Returns:
      The number of star ratings for this item

    • getAnnoCollectionKeys

      public String[] getAnnoCollectionKeys()
      Gets the annotataion collection keys, for example {06, 08}, for all collections that annotate this item.
      Overrides:
      getAnnoCollectionKeys in class XMLDocReader
      Returns:
      The annoCollectionKeys value

    • getCompletedAnnoCollectionKeys

      public String[] getCompletedAnnoCollectionKeys()
      Gets the annotataion collection keys, for example {06, 08}, for all collections that annotate this item with one or more status completed annotations.
      Overrides:
      getCompletedAnnoCollectionKeys in class XMLDocReader
      Returns:
      The completedAnnoCollectionKeys value

    • getAssociatedCollectionKeys

      public ArrayList getAssociatedCollectionKeys()
      Gets the collection keys for all enabled collections that are associated with this resource. Associated annotations such as CRS and JESSE that are identified as collections are included. Disabled collections are not included.
      Returns:
      A list of associatedCollectionKeys Strings

    • getAllAssociatedCollectionKeys

      public String[] getAllAssociatedCollectionKeys()
      Gets the collection keys for all collections that are associated with this resource including collections that are not enabled.
      Returns:
      The associatedCollectionKeys value

    • getAssociatedIds

      public String[] getAssociatedIds()
      Gets the IDs of records that refer to the same resource, not including this record's ID.
      Overrides:
      getAssociatedIds in class XMLDocReader
      Returns:
      The associated IDs value.

    • getAllIds

      public String[] getAllIds()
      Gets all the IDs associated with this resource, including this record's ID.
      Overrides:
      getAllIds in class XMLDocReader
      Returns:
      The allIds value

    • getErrorTypes

      public String[] getErrorTypes()
      Gets the errors types (codes) identified by the ID mapper for this records. Returns integers as strings.
      Returns:
      The ID mapper error types (codes).

    • getErrorStrings

      public String[] getErrorStrings()
      Gets the errors identified by the ID mapper for this records.
      Returns:
      The ID mapper errors.

    • getAllItemResultDocs

      public ResultDocList getAllItemResultDocs()
      Gets the ItemDocReaders for all records that refer to this resource. The first record is this item. This returns the full ResultDoc for each item, not the de-duped ResultDocs.
      Returns:
      All records that refer to this resource.

    • getDeDupedResultDocs

      public ResultDocList getDeDupedResultDocs()
      Gets the de-duped ResultDocs for all records that refer to this resource from the dup items index, or null if this is not a duped record. These are sorted if a sort was specified in the ResultDoc attributes via key 'sortAscendingByField' or 'sortDescendingByField'. See also getAllItemResultDocs().
      Returns:
      All de-duped ResultDocs for this resource.
      See Also:

    • getAssociatedItemResultDocs

      public ResultDocList getAssociatedItemResultDocs()
      Gets the ItemDocReaders for all associated items for this item (refer to same resource).
      Returns:
      The associatedItemDocReaders value

    • getDisplayableAssociatedItemResultDocs

      public ResultDocList getDisplayableAssociatedItemResultDocs()
      Gets the ItemDocReaders for all associated items (refer to same resource) for this item that have an appropriate status for display in discovery.
      Returns:
      The displayableAssociatedItemDocReaders value

    • getMissingAssociatedItemIds

      public ArrayList getMissingAssociatedItemIds()
      Gets the missingAssociatedItemIds for associated items that are not in the index.
      Returns:
      A list of missingAssociatedItemIds Strings

    • hasRelatedResource

      public boolean hasRelatedResource()
      Determines whether this item has one or more related resources of any type. If the related resource is an ID, checks to see that the ID is currently available in the repository.
      Returns:
      True if this item has one or more related resources of any type, else false.

    • hasMultiRelatedResource

      public boolean hasMultiRelatedResource()
      Determines whether this item has one or more related resources of any type from any records that catalogs this resource. If the related resource is an ID, checks to see that the ID is currently available in the repository.
      Returns:
      True if this item has one or more related resources of any type, else false.

    • getHasRelatedResource

      public String getHasRelatedResource()
      Determines whether this item has one or more related resources of any type.
      Returns:
      'true' if this item has one or more related resources of any type, else 'false'.

    • getMultiHasRelatedResource

      public String getMultiHasRelatedResource()
      Determines whether this item has one or more related resources of any type from any records that catalogs this resource.
      Returns:
      'true' if this item has one or more related resources of any type, else 'false'.

    • getRelatedResourceIds

      public String[] getRelatedResourceIds()
      Gets the IDs of all related resources that were cataloged by ID, or null if none were present
      Returns:
      The relatedResourceIds

    • getMultiRelatedResourceIds

      public String[] getMultiRelatedResourceIds()
      Gets the IDs of all related resources that were cataloged by ID from all records that catalog this resource, or null if none were present.
      Returns:
      The relatedResourceIds

    • getRelatedResourceByIdDocs

      public ResultDocList getRelatedResourceByIdDocs()
      Gets the relatedResourceByIdDocs attribute of the ItemDocReader object
      Returns:
      The relatedResourceByIdDocs value

    • getMultiRelatedResourceByIdDocs

      public ResultDocList getMultiRelatedResourceByIdDocs()
      Gets the multiRelatedResourceByIdDocs attribute of the ItemDocReader object
      Returns:
      The multiRelatedResourceByIdDocs value

    • getMultiRelatedResources

      public List getMultiRelatedResources()
      Gets a List of RelatedResource Objects for each related resource from each of the records that catalog this resource, or null if none.
      Returns:
      A List of RelatedResource Objects, or null

    • getMultiDisplayableRelatedResources

      public List getMultiDisplayableRelatedResources()
      Gets a List of RelatedResource Objects for each related resource from each of the records that catalog this resource that have an appropriate status for display in discovery, or null if none.
      Returns:
      A List of RelatedResource Objects, or null

    • getRelatedResourceUrls

      public String[] getRelatedResourceUrls()
      Gets the URLs of all related resources that were cataloged by URL, or null if none were present
      Returns:
      The relatedResourceUrls

    • getMultiRelatedResourceUrls

      public String[] getMultiRelatedResourceUrls()
      Gets the URLs of all related resources that were cataloged by URL from all records that catalog this resource, or null if none were present
      Returns:
      The relatedResourceUrls

    • getAnnotationResultDocs

      public ResultDocList getAnnotationResultDocs()
      Gets the ResultDocs for all annotations that refer to this resource.
      Overrides:
      getAnnotationResultDocs in class XMLDocReader
      Returns:
      The ResultDocs value

    • hasCompletedAnno

      public boolean hasCompletedAnno()
      Determines whether this item has at least one completed annotation.
      Overrides:
      hasCompletedAnno in class XMLDocReader
      Returns:
      True if this item has one or more completed annotation, false otherwise.

    • getHasCompletedAnno

      public String getHasCompletedAnno()
      Gets the hasCompletedAnno attribute of the ItemDocReader object
      Overrides:
      getHasCompletedAnno in class XMLDocReader
      Returns:
      The hasCompletedAnno value

    • getNumCompletedAnnos

      public String getNumCompletedAnnos()
      Gets the numCompletedAnnos attribute of the ItemDocReader object
      Overrides:
      getNumCompletedAnnos in class XMLDocReader
      Returns:
      The numCompletedAnnos value

    • getNumInProgressAnnos

      public String getNumInProgressAnnos()
      Gets the numInProgressAnnos attribute of the ItemDocReader object
      Overrides:
      getNumInProgressAnnos in class XMLDocReader
      Returns:
      The numInProgressAnnos value

    • getNumTextAnnosInProgress

      public String getNumTextAnnosInProgress()
      Gets the numTextAnnosInProgress attribute of the ItemDocReader object
      Overrides:
      getNumTextAnnosInProgress in class XMLDocReader
      Returns:
      The numTextAnnosInProgress value

    • getNumAudioAnnosInProgress

      public String getNumAudioAnnosInProgress()
      Gets the numAudioAnnosInProgress attribute of the ItemDocReader object
      Overrides:
      getNumAudioAnnosInProgress in class XMLDocReader
      Returns:
      The numAudioAnnosInProgress value

    • getNumGraphicalAnnosInProgress

      public String getNumGraphicalAnnosInProgress()
      Gets the numGraphicalAnnosInProgress attribute of the ItemDocReader object
      Overrides:
      getNumGraphicalAnnosInProgress in class XMLDocReader
      Returns:
      The numGraphicalAnnosInProgress value

    • getNumVideoAnnosInProgress

      public String getNumVideoAnnosInProgress()
      Gets the number of video format annotations in progress for this item.
      Overrides:
      getNumVideoAnnosInProgress in class XMLDocReader
      Returns:
      The number of video format annotations

    • hasCompletedAnnoOfType

      public boolean hasCompletedAnnoOfType(String type)
      Determines whether this item has a completed annotataion of the given type, for example 'Review', 'Comment', 'Educational standard', etc.
      Overrides:
      hasCompletedAnnoOfType in class XMLDocReader
      Parameters:
      type - The annotation type
      Returns:
      True if this item has a completed annotataion of the given type.

    • getCompletedAnnosOfType

      public ArrayList getCompletedAnnosOfType(String type)
      Gets a list of all completed annotataions for this item of the given type.
      Overrides:
      getCompletedAnnosOfType in class XMLDocReader
      Parameters:
      type - The annotation type, for example 'Review', 'Teaching tip', etc.
      Returns:
      A list of DleseAnnoDocReaders for all completed annotataions for this item of the given type, or an empty list.

    • getHasInProgressAnno

      public String getHasInProgressAnno()
      Determines whether the item has an annotation in progress.
      Overrides:
      getHasInProgressAnno in class XMLDocReader
      Returns:
      'true' if the item has an annotation in progress, otherwise 'false'.

    • hasInProgressAnno

      public boolean hasInProgressAnno()
      Determines whether the item has an annotation in progress.
      Overrides:
      hasInProgressAnno in class XMLDocReader
      Returns:
      True if the item has an annotation in progress, otherwise false.

    • hasInProgressAnnoOfFormat

      public boolean hasInProgressAnnoOfFormat(String format)
      Determines whether the item has an annotation in progress of the given format, which is one of 'text', 'audio', 'graphical', or 'video'.
      Overrides:
      hasInProgressAnnoOfFormat in class XMLDocReader
      Parameters:
      format - Annotation format
      Returns:
      True if the item has an annotation in progress of the given format, otherwise false.

    • getInProgressAnnosOfFormat

      public ArrayList getInProgressAnnosOfFormat(String format)
      Gets all in-progress annotations for this item that have the given format, which is one of 'text', 'audio', 'graphical', or 'video'.
      Overrides:
      getInProgressAnnosOfFormat in class XMLDocReader
      Parameters:
      format - Annotation format
      Returns:
      A list of DleseAnnoDocReaders

    • getTextAnnosInProgress

      public ArrayList getTextAnnosInProgress()
      Gets a list of DleseAnnoDocReaders containing each of the in-progress type 'text' annotations for this resource.
      Overrides:
      getTextAnnosInProgress in class XMLDocReader
      Returns:
      A list of DleseAnnoDocReaders or empty list

    • getAudioAnnosInProgress

      public ArrayList getAudioAnnosInProgress()
      Gets a list of DleseAnnoDocReaders containing each of the in-progress type 'audio' annotations for this resource.
      Overrides:
      getAudioAnnosInProgress in class XMLDocReader
      Returns:
      A list of DleseAnnoDocReaders

    • getGraphicalAnnosInProgress

      public ArrayList getGraphicalAnnosInProgress()
      Gets a list of DleseAnnoDocReaders containing each of the in-progress type 'graphical' annotations for this resource.
      Overrides:
      getGraphicalAnnosInProgress in class XMLDocReader
      Returns:
      A list of DleseAnnoDocReaders or empty list

    • getVideoAnnosInProgress

      public ArrayList getVideoAnnosInProgress()
      Gets a list of DleseAnnoDocReaders containing each of the in-progress type 'video' annotations for this resource.
      Overrides:
      getVideoAnnosInProgress in class XMLDocReader
      Returns:
      A list of DleseAnnoDocReaders or empty list

    • getCompletedAnnos

      public ArrayList getCompletedAnnos()
      Gets a list of DleseAnnoDocReaders containing each of the completed annotations, regardless of type, for this resource.
      Overrides:
      getCompletedAnnos in class XMLDocReader
      Returns:
      A list of DleseAnnoDocReaders or empty list

    • getCompletedReviews

      public ArrayList getCompletedReviews()
      Gets a list of DleseAnnoDocReaders containing each of the completed type 'review' annotations for this resource.
      Overrides:
      getCompletedReviews in class XMLDocReader
      Returns:
      A list of DleseAnnoDocReaders or empty list

    • getCompletedTeachingTips

      public ArrayList getCompletedTeachingTips()
      Gets a list of DleseAnnoDocReaders containing each of the completed type 'teaching tip' annotations for this resource.
      Overrides:
      getCompletedTeachingTips in class XMLDocReader
      Returns:
      A list of DleseAnnoDocReaders or empty list

    • getCompletedEditorSummaries

      public ArrayList getCompletedEditorSummaries()
      Gets a list of DleseAnnoDocReaders containing each of the completed type 'editors summary' annotations for this resource.
      Overrides:
      getCompletedEditorSummaries in class XMLDocReader
      Returns:
      A list of DleseAnnoDocReaders or empty list

    • getCompletedChallengingSituations

      public ArrayList getCompletedChallengingSituations()
      Gets a list of DleseAnnoDocReaders containing each of the completed type 'challenging situation' annotations for this resource.
      Overrides:
      getCompletedChallengingSituations in class XMLDocReader
      Returns:
      A list of DleseAnnoDocReaders or empty list

    • getCompletedAverageScores

      public ArrayList getCompletedAverageScores()
      Gets a list of DleseAnnoDocReaders containing each of the completed type 'average scores' annotations for this resource.
      Overrides:
      getCompletedAverageScores in class XMLDocReader
      Returns:
      A list of DleseAnnoDocReaders or empty list

    • getCompletedAdvice

      public ArrayList getCompletedAdvice()
      Gets a list of DleseAnnoDocReaders containing each of the completed type 'advice' annotations for this resource.
      Overrides:
      getCompletedAdvice in class XMLDocReader
      Returns:
      A list of DleseAnnoDocReaders or empty list

    • getCompletedAnnotation

      public ArrayList getCompletedAnnotation()
      Gets a list of DleseAnnoDocReaders containing each of the completed type 'annotation' annotations for this resource.
      Overrides:
      getCompletedAnnotation in class XMLDocReader
      Returns:
      A list of DleseAnnoDocReaders or empty list

    • getCompletedBias

      public ArrayList getCompletedBias()
      Gets a list of DleseAnnoDocReaders containing each of the completed type 'bias' annotations for this resource.
      Overrides:
      getCompletedBias in class XMLDocReader
      Returns:
      A list of DleseAnnoDocReaders or empty list

    • getCompletedChange

      public ArrayList getCompletedChange()
      Gets a list of DleseAnnoDocReaders containing each of the completed type 'change' annotations for this resource.
      Overrides:
      getCompletedChange in class XMLDocReader
      Returns:
      A list of DleseAnnoDocReaders or empty list

    • getCompletedComment

      public ArrayList getCompletedComment()
      Gets a list of DleseAnnoDocReaders containing each of the completed type 'comment' annotations for this resource.
      Overrides:
      getCompletedComment in class XMLDocReader
      Returns:
      A list of DleseAnnoDocReaders or empty list

    • getCompletedEducationalStandard

      public ArrayList getCompletedEducationalStandard()
      Gets a list of DleseAnnoDocReaders containing each of the completed type 'educational standard' annotations for this resource.
      Overrides:
      getCompletedEducationalStandard in class XMLDocReader
      Returns:
      A list of DleseAnnoDocReaders or empty list

    • getCompletedExample

      public ArrayList getCompletedExample()
      Gets a list of DleseAnnoDocReaders containing each of the completed type 'example' annotations for this resource.
      Overrides:
      getCompletedExample in class XMLDocReader
      Returns:
      A list of DleseAnnoDocReaders or empty list

    • getCompletedExplanation

      public ArrayList getCompletedExplanation()
      Gets a list of DleseAnnoDocReaders containing each of the completed type 'explanation' annotations for this resource.
      Overrides:
      getCompletedExplanation in class XMLDocReader
      Returns:
      A list of DleseAnnoDocReaders or empty list

    • getCompletedQuestion

      public ArrayList getCompletedQuestion()
      Gets a list of DleseAnnoDocReaders containing each of the completed type 'question' annotations for this resource.
      Overrides:
      getCompletedQuestion in class XMLDocReader
      Returns:
      A list of DleseAnnoDocReaders or empty list

    • getCompletedSeeAlso

      public ArrayList getCompletedSeeAlso()
      Gets a list of DleseAnnoDocReaders containing each of the completed type 'see also' annotations for this resource.
      Overrides:
      getCompletedSeeAlso in class XMLDocReader
      Returns:
      A list of DleseAnnoDocReaders or empty list

    • prtlnErr

      protected static void prtlnErr(String s)
      Output a line of text to error out, with datestamp.
      Parameters:
      s - The text that will be output to error out.

    • prtln

      protected static void prtln(String s)
      Output a line of text to standard out, with datestamp, if debug is set to true.
      Parameters:
      s - The String that will be output.