ItemDocReader (DLESE Tools API Documentation v1.6.0)

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:

java.io.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:

ItemFileIndexingWriter, Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

class ItemDocReader.RelatedResource
Data for a related resource.
- Nested classes/interfaces inherited from class org.dlese.dpc.index.reader.XMLDocReader
  XMLDocReader.VocabUiLabelsCollection

Nested Classes
Modifier and Type	Class and Description
`class`	`ItemDocReader.RelatedResource` Data for a related resource.

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

Constructors
Constructor and Description
`ItemDocReader()` Constructor for the ItemDocReader object
`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`.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`getAccessionDate()` Gets the accession date as a String.
`java.util.Date`	`getAccessionDateDate()` Gets the accession date as a Java Date.
`java.lang.String`	`getAccessionStatus()` Gets the AccessionStatus for this record.
`java.lang.String[]`	`getAllAssociatedCollectionKeys()` Gets the collection keys for all collections that are associated with this resource including collections that are not enabled.
`java.lang.String[]`	`getAllIds()` Gets all the IDs associated with this resource, including this record's ID.
`ResultDocList`	`getAllItemResultDocs()` Gets the ItemDocReaders for all records that refer to this resource.
`java.lang.String[]`	`getAnnoCollectionKeys()` Gets the annotataion collection keys, for example {06, 08}, for all collections that annotate this item.
`java.util.ArrayList`	`getAnnoFormats()` Gets the annotation formats that are associated with this item.
`java.util.ArrayList`	`getAnnoPathways()` Gets the anno pathways that are associated with this record.
`java.lang.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.
`java.util.ArrayList`	`getAnnoStatus()` Gets the annotation statuses that are associated with this item.
`ResultDocList`	`getAnnotationResultDocs()` Gets the ResultDocs for all annotations that refer to this resource.
`java.lang.String[]`	`getAnnoTypes()` Gets the anno types that are associated with this record.
`java.util.ArrayList`	`getAssociatedCollectionKeys()` Gets the collection keys for all enabled collections that are associated with this resource.
`java.lang.String[]`	`getAssociatedIds()` Gets the IDs of records that refer to the same resource, not including this record's ID.
`ResultDocList`	`getAssociatedItemResultDocs()` Gets the ItemDocReaders for all associated items for this item (refer to same resource).
`java.util.ArrayList`	`getAudioAnnosInProgress()` Gets a list of `DleseAnnoDocReader`s containing each of the in-progress type 'audio' annotations for this resource.
`java.lang.String`	`getAverageAnnoRating()` Gets a the average of all star ratings for this item as a String, or null if none.
`float`	`getAverageAnnoRatingFloat()` Gets a the average of all star ratings for this item as a float, or -1 if none.
`java.lang.String[]`	`getBeneficiary()` Gets the beneficiary attribute of the ItemDocReader object
`java.lang.String`	`getCollectionsString()` Gets the collections associated with this record as a single String.
`java.util.ArrayList`	`getCompletedAdvice()` Gets a list of `DleseAnnoDocReader`s containing each of the completed type 'advice' annotations for this resource.
`java.lang.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.
`java.util.ArrayList`	`getCompletedAnnos()` Gets a list of `DleseAnnoDocReader`s containing each of the completed annotations, regardless of type, for this resource.
`java.util.ArrayList`	`getCompletedAnnosOfType(java.lang.String type)` Gets a list of all completed annotataions for this item of the given type.
`java.util.ArrayList`	`getCompletedAnnotation()` Gets a list of `DleseAnnoDocReader`s containing each of the completed type 'annotation' annotations for this resource.
`java.util.ArrayList`	`getCompletedAverageScores()` Gets a list of `DleseAnnoDocReader`s containing each of the completed type 'average scores' annotations for this resource.
`java.util.ArrayList`	`getCompletedBias()` Gets a list of `DleseAnnoDocReader`s containing each of the completed type 'bias' annotations for this resource.
`java.util.ArrayList`	`getCompletedChallengingSituations()` Gets a list of `DleseAnnoDocReader`s containing each of the completed type 'challenging situation' annotations for this resource.
`java.util.ArrayList`	`getCompletedChange()` Gets a list of `DleseAnnoDocReader`s containing each of the completed type 'change' annotations for this resource.
`java.util.ArrayList`	`getCompletedComment()` Gets a list of `DleseAnnoDocReader`s containing each of the completed type 'comment' annotations for this resource.
`java.util.ArrayList`	`getCompletedEditorSummaries()` Gets a list of `DleseAnnoDocReader`s containing each of the completed type 'editors summary' annotations for this resource.
`java.util.ArrayList`	`getCompletedEducationalStandard()` Gets a list of `DleseAnnoDocReader`s containing each of the completed type 'educational standard' annotations for this resource.
`java.util.ArrayList`	`getCompletedExample()` Gets a list of `DleseAnnoDocReader`s containing each of the completed type 'example' annotations for this resource.
`java.util.ArrayList`	`getCompletedExplanation()` Gets a list of `DleseAnnoDocReader`s containing each of the completed type 'explanation' annotations for this resource.
`java.util.ArrayList`	`getCompletedQuestion()` Gets a list of `DleseAnnoDocReader`s containing each of the completed type 'question' annotations for this resource.
`java.util.ArrayList`	`getCompletedReviews()` Gets a list of `DleseAnnoDocReader`s containing each of the completed type 'review' annotations for this resource.
`java.util.ArrayList`	`getCompletedSeeAlso()` Gets a list of `DleseAnnoDocReader`s containing each of the completed type 'see also' annotations for this resource.
`java.util.ArrayList`	`getCompletedTeachingTips()` Gets a list of `DleseAnnoDocReader`s containing each of the completed type 'teaching tip' annotations for this resource.
`java.util.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.
`java.lang.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.
`java.lang.String`	`getCreationDate()` Gets the created date as a String.
`java.util.Date`	`getCreationDateDate()` Gets the created date as a Java Date ADN XPath metaMetadata/dateInfo@created.
`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.
`java.lang.String`	`getDescription()` Gets the description for this item.
`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.
`java.lang.String[]`	`getErrorStrings()` Gets the errors identified by the ID mapper for this records.
`java.lang.String[]`	`getErrorTypes()` Gets the errors types (codes) identified by the ID mapper for this records.
`java.util.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.
`java.lang.String[]`	`getGradeRanges()` Gets the grade ranges for this record, for example 07, or 'DLESE:Primary elementary' if no vocab manager is available.
`java.util.ArrayList`	`getGraphicalAnnosInProgress()` Gets a list of `DleseAnnoDocReader`s containing each of the in-progress type 'graphical' annotations for this resource.
`java.lang.String`	`getHasCompletedAnno()` Gets the hasCompletedAnno attribute of the ItemDocReader object
`java.lang.String`	`getHasInProgressAnno()` Determines whether the item has an annotation in progress.
`java.lang.String`	`getHasRelatedResource()` Determines whether this item has one or more related resources of any type.
`java.util.ArrayList`	`getInProgressAnnosOfFormat(java.lang.String format)` Gets all in-progress annotations for this item that have the given format, which is one of 'text', 'audio', 'graphical', or 'video'.
`java.lang.String[]`	`getInstructionalGoal()` Gets the instructionalGoal attribute of the ItemDocReader object
`java.lang.String[]`	`getKeywords()` Gets the keywords as a sorted array.
`java.lang.String`	`getKeywordsDisplay()` Gets the keywords as a sorted comma separated list terminated with a period suitable for display to users.
`java.util.ArrayList`	`getMissingAssociatedItemIds()` Gets the missingAssociatedItemIds for associated items that are not in the index.
`java.lang.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.
`java.util.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.
`java.lang.String`	`getMultiAccessionStatus()` Gets the the concatinated accession statuses of all associated records for this item.
`java.util.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.
`java.lang.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.
`java.lang.String`	`getMultiDescription()` Gets the concatinated descriptions of all associated records for this item.
`java.util.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.
`protected org.apache.lucene.document.Document`	`getMultiDoc()` Gets the multiDoc lucene Document for this item, or the single doc, if none available.
`java.util.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.
`java.lang.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.
`java.lang.String`	`getMultiHasRelatedResource()` Determines whether this item has one or more related resources of any type from any records that catalogs this resource.
`java.lang.String`	`getMultiIds()` Gets the the concatinated IDs of all associated records for this item.
`java.lang.String[]`	`getMultiKeywords()` Gets the keywords for all associated records as a sorted array.
`java.lang.String`	`getMultiRecordStatus()` Gets the value 'true' or 'false' depending on whether this item does or does not have multiple records associated with it.
`ResultDocList`	`getMultiRelatedResourceByIdDocs()` Gets the multiRelatedResourceByIdDocs attribute of the ItemDocReader object
`java.lang.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.
`java.util.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.
`java.lang.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
`java.lang.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.
`java.lang.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.
`java.lang.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.
`java.lang.String[]`	`getMultiSubjects()` Gets the subjects for this item and all additional items associated via the ID mapper.
`java.lang.String`	`getMultiTitle()` Gets the concatinated title of all associated records for this item.
`java.lang.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.
`java.util.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.
`java.lang.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'.
`java.lang.String`	`getNumAnnoRatings()` Gets a the total number of star ratings for this item as a String.
`int`	`getNumAnnoRatingsInt()` Gets a the total number of star ratings for this item as a int.
`java.lang.String`	`getNumAudioAnnosInProgress()` Gets the numAudioAnnosInProgress attribute of the ItemDocReader object
`java.lang.String`	`getNumCompletedAnnos()` Gets the numCompletedAnnos attribute of the ItemDocReader object
`java.lang.String`	`getNumGraphicalAnnosInProgress()` Gets the numGraphicalAnnosInProgress attribute of the ItemDocReader object
`java.lang.String`	`getNumInProgressAnnos()` Gets the numInProgressAnnos attribute of the ItemDocReader object
`java.lang.String`	`getNumTextAnnosInProgress()` Gets the numTextAnnosInProgress attribute of the ItemDocReader object
`java.lang.String`	`getNumVideoAnnosInProgress()` Gets the number of video format annotations in progress for this item.
`java.lang.String`	`getPartOfDRC()` Gets the part-of-DRC status (true or false).
`java.lang.String`	`getReaderType()` Gets the String 'ItemDocReader,' which is the key that describes this reader type.
`ResultDocList`	`getRelatedResourceByIdDocs()` Gets the relatedResourceByIdDocs attribute of the ItemDocReader object
`java.lang.String[]`	`getRelatedResourceIds()` Gets the IDs of all related resources that were cataloged by ID, or null if none were present
`java.lang.String[]`	`getRelatedResourceUrls()` Gets the URLs of all related resources that were cataloged by URL, or null if none were present
`java.lang.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.
`java.lang.String[]`	`getResourceTypes()` Gets the resource types for this record, for example 0c, or 'DLESE:Learning materials:Classroom activity' if no vocab manager is available.
`java.lang.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.
`java.lang.String[]`	`getSubjects()` Gets the subjects for this record, for example 03, or 'DLESE:Biology' if no vocab manager is available.
`java.lang.String[]`	`getTeachingMethod()` Gets the teachingMethod attribute of the ItemDocReader object
`java.util.ArrayList`	`getTextAnnosInProgress()` Gets a list of `DleseAnnoDocReader`s containing each of the in-progress type 'text' annotations for this resource.
`java.lang.String`	`getTitle()` Gets the title of the item.
`java.lang.String[]`	`getToolFor()` Gets the toolFor attribute of the ItemDocReader object
`java.lang.String[]`	`getTypicalAgeRange()` Gets the typicalAgeRange attribute of the ItemDocReader object
`java.lang.String`	`getUrl()` Gets the URL for this resource.
`java.lang.String`	`getUrlEncoded()` Gets the URL for this resource.
`java.lang.String`	`getUrlTruncated()` Gets the URL for this resource, truncated if it is very long
`java.util.ArrayList`	`getVideoAnnosInProgress()` Gets a list of `DleseAnnoDocReader`s containing each of the in-progress type 'video' annotations for this resource.
`boolean`	`hasAnnotations()` Determines whether this item has annotations.
`boolean`	`hasCompletedAnno()` Determines whether this item has at least one completed annotation.
`boolean`	`hasCompletedAnnoOfType(java.lang.String type)` Determines whether this item has a completed annotataion of the given type, for example 'Review', 'Comment', 'Educational standard', etc.
`boolean`	`hasInProgressAnno()` Determines whether the item has an annotation in progress.
`boolean`	`hasInProgressAnnoOfFormat(java.lang.String format)` Determines whether the item has an annotation in progress of the given format, which is one of 'text', 'audio', 'graphical', or 'video'.
`boolean`	`hasMultiRelatedResource()` Determines whether this item has one or more related resources of any type from any records that catalogs this resource.
`boolean`	`hasRelatedResource()` Determines whether this item has one or more related resources of any type.
`void`	`init()` Initializes the ItemDocReader at search time.
`boolean`	`isMultiRecord()` Determines whether this item does or does not have multiple records associated with it.
`protected static void`	`prtln(java.lang.String s)` Output a line of text to standard out, with datestamp, if debug is set to true.
`protected static void`	`prtlnErr(java.lang.String s)` Output a line of text to error out, with datestamp.

Methods inherited from class org.dlese.dpc.index.reader.XMLDocReader
getAssignedByIdRelatedRecordsMap, getAssignedByUrlRelatedRecordsMap, getAssignedRelatedIdsOfType, getAssignedRelatedUrlsOfType, getAssignedRelationshipByIdTypes, getAssignedRelationshipByUrlTypes, getAssignedRelationshipsForItemsMap, getAvailableFormats, getCanDissiminateFormat, getCollection, getCollectionKey, getCollectionKeys, getCollectionLabel, getCollections, getDocsource, getFieldId, getHasAssignedRelations, getHasRelations, getId, getIdEncoded, getIdsOfRecordsWithAssignedRelationships, getIndexedContent, getIsMyCollectionDisabled, getIsMyCollectionEnabled, getMetadataPrefix, getMetadataVocab, getMetadataVocabAudience, getMetadataVocabLanguage, getMyCollectionDoc, getMyCollectionsRecordId, getNativeFormat, getNsdlDublinCoreXml, getOaiDatestamp, getOaiDublinCoreXml, getOaiLastModifiedString, getOaiSets, getRelatedIdsOfType, getRelatedRecordsMap, getRelationshipTypes, getRequestedXml, getRequestedXmlFormat, getSet, getSets, getSetString, getUiLabelFromVocabId, getUiLabelFromVocabName, getUiLabelsFromVocabIds, getValidationReport, getValueId, getW3CXmlDoc, getWhatsNewDate, getWhatsNewDateDate, getWhatsNewType, getXml, getXmlDoc, getXmlFormat, getXmlLocalized, getXmlStripped, isValid, 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
  - 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 Detail
  - 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 java.lang.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 java.lang.String getTitle()
```
    Gets the title of the item.
    
    Overrides:
    
    getTitle in class XMLDocReader
    
    Returns:
    
    The title value
  - getKeywords
```
public java.lang.String[] getKeywords()
```
    Gets the keywords as a sorted array. Duplicate keywords are ommitted.
    
    Returns:
    
    The keywords
  - getMultiKeywords
```
public java.lang.String[] getMultiKeywords()
```
    Gets the keywords for all associated records as a sorted array. Duplicate keywords are ommitted.
    
    Returns:
    
    The keywords
  - getKeywordsDisplay
```
public java.lang.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 java.lang.String getMultiTitle()
```
    Gets the concatinated title of all associated records for this item.
    
    Returns:
    
    The concatinated title text.
  - getDescription
```
public java.lang.String getDescription()
```
    Gets the description for this item.
    
    Overrides:
    
    getDescription in class XMLDocReader
    
    Returns:
    
    The description value
  - getMultiDescription
```
public java.lang.String getMultiDescription()
```
    Gets the concatinated descriptions of all associated records for this item.
    
    Returns:
    
    The multiDescription value
  - getMultiIds
```
public java.lang.String getMultiIds()
```
    Gets the the concatinated IDs of all associated records for this item.
    
    Returns:
    
    The multiIds value
  - getPartOfDRC
```
public java.lang.String getPartOfDRC()
```
    Gets the part-of-DRC status (true or false).
    
    Returns:
    
    The String "true" or "false".
  - getUrl
```
public java.lang.String getUrl()
```
    Gets the URL for this resource.
    
    Overrides:
    
    getUrl in class XMLDocReader
    
    Returns:
    
    The url value
  - getUrlEncoded
```
public java.lang.String getUrlEncoded()
```
    Gets the URL for this resource.
    
    Returns:
    
    The url value
  - getUrlTruncated
```
public java.lang.String getUrlTruncated()
```
    Gets the URL for this resource, truncated if it is very long
    
    Returns:
    
    The url value
  - getCollectionsString
```
public java.lang.String getCollectionsString()
```
    Gets the collections associated with this record as a single String. Same as Same as XMLDocReader.getSetString().
    
    Returns:
    
    The collections.
  - getMultiWhatsNewType
```
public java.lang.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 java.lang.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 java.util.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 java.lang.String getCreationDate()
```
    Gets the created date as a String. ADN XPath metaMetadata/dateInfo@created.
    
    Returns:
    
    The created date or empty String.
  - getCreationDateDate
```
public java.util.Date getCreationDateDate()
```
    Gets the created date as a Java Date ADN XPath metaMetadata/dateInfo@created.
    
    Returns:
    
    The created Date or null.
  - getMultiAccessionDate
```
public java.lang.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 java.util.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 java.lang.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 java.util.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 java.lang.String getAccessionStatus()
```
    Gets the AccessionStatus for this record.
    
    Returns:
    
    The status value
  - getMultiAccessionStatus
```
public java.lang.String getMultiAccessionStatus()
```
    Gets the the concatinated accession statuses of all associated records for this item.
    
    Returns:
    
    The status value
  - getBeneficiary
```
public java.lang.String[] getBeneficiary()
```
    Gets the beneficiary attribute of the ItemDocReader object
    
    Returns:
    
    The beneficiary value
  - getToolFor
```
public java.lang.String[] getToolFor()
```
    Gets the toolFor attribute of the ItemDocReader object
    
    Returns:
    
    The toolFor value
  - getInstructionalGoal
```
public java.lang.String[] getInstructionalGoal()
```
    Gets the instructionalGoal attribute of the ItemDocReader object
    
    Returns:
    
    The instructionalGoal value
  - getTeachingMethod
```
public java.lang.String[] getTeachingMethod()
```
    Gets the teachingMethod attribute of the ItemDocReader object
    
    Returns:
    
    The teachingMethod value
  - getTypicalAgeRange
```
public java.lang.String[] getTypicalAgeRange()
```
    Gets the typicalAgeRange attribute of the ItemDocReader object
    
    Returns:
    
    The typicalAgeRange value
  - getGradeRanges
```
public java.lang.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 java.lang.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 java.util.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 #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 java.util.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 #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 java.lang.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 java.lang.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 java.lang.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 #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 java.lang.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 #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 java.lang.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 java.lang.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 java.util.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 #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 java.util.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 #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 java.lang.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 java.lang.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 java.lang.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 #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 java.lang.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 #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 java.lang.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 java.lang.String[] getAnnoTypes()
```
    Gets the anno types that are associated with this record.
    
    Overrides:
    
    getAnnoTypes in class XMLDocReader
    
    Returns:
    
    The anno types value.
  - getAnnoPathways
```
public java.util.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 java.util.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 java.util.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 java.lang.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 java.lang.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 java.lang.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 java.lang.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 java.lang.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 java.util.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 java.lang.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 java.lang.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 java.lang.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 java.lang.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 java.lang.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:
    
    getAllItemResultDocs()
  - 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 java.util.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 java.lang.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 java.lang.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 java.lang.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 java.lang.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 java.util.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 java.util.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 java.lang.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 java.lang.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 java.lang.String getHasCompletedAnno()
```
    Gets the hasCompletedAnno attribute of the ItemDocReader object
    
    Overrides:
    
    getHasCompletedAnno in class XMLDocReader
    
    Returns:
    
    The hasCompletedAnno value
  - getNumCompletedAnnos
```
public java.lang.String getNumCompletedAnnos()
```
    Gets the numCompletedAnnos attribute of the ItemDocReader object
    
    Overrides:
    
    getNumCompletedAnnos in class XMLDocReader
    
    Returns:
    
    The numCompletedAnnos value
  - getNumInProgressAnnos
```
public java.lang.String getNumInProgressAnnos()
```
    Gets the numInProgressAnnos attribute of the ItemDocReader object
    
    Overrides:
    
    getNumInProgressAnnos in class XMLDocReader
    
    Returns:
    
    The numInProgressAnnos value
  - getNumTextAnnosInProgress
```
public java.lang.String getNumTextAnnosInProgress()
```
    Gets the numTextAnnosInProgress attribute of the ItemDocReader object
    
    Overrides:
    
    getNumTextAnnosInProgress in class XMLDocReader
    
    Returns:
    
    The numTextAnnosInProgress value
  - getNumAudioAnnosInProgress
```
public java.lang.String getNumAudioAnnosInProgress()
```
    Gets the numAudioAnnosInProgress attribute of the ItemDocReader object
    
    Overrides:
    
    getNumAudioAnnosInProgress in class XMLDocReader
    
    Returns:
    
    The numAudioAnnosInProgress value
  - getNumGraphicalAnnosInProgress
```
public java.lang.String getNumGraphicalAnnosInProgress()
```
    Gets the numGraphicalAnnosInProgress attribute of the ItemDocReader object
    
    Overrides:
    
    getNumGraphicalAnnosInProgress in class XMLDocReader
    
    Returns:
    
    The numGraphicalAnnosInProgress value
  - getNumVideoAnnosInProgress
```
public java.lang.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(java.lang.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 java.util.ArrayList getCompletedAnnosOfType(java.lang.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 java.lang.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(java.lang.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 java.util.ArrayList getInProgressAnnosOfFormat(java.lang.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 java.util.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 java.util.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 java.util.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 java.util.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 java.util.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 java.util.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 java.util.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 java.util.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 java.util.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 java.util.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 java.util.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 java.util.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 java.util.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 java.util.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 java.util.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 java.util.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 java.util.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 java.util.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 java.util.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 java.util.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(java.lang.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(java.lang.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.

Class ItemDocReader

Nested Class Summary

Nested classes/interfaces inherited from class org.dlese.dpc.index.reader.XMLDocReader

Field Summary

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

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

Constructor Summary

Method Summary

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

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

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

Methods inherited from class java.lang.Object

Constructor Detail

ItemDocReader

ItemDocReader

Method Detail

init

getMultiDoc

getReaderType

getTitle

getKeywords

getMultiKeywords

getKeywordsDisplay

getMultiTitle

getDescription

getMultiDescription

getMultiIds

getPartOfDRC

getUrl

getUrlEncoded

getUrlTruncated

getCollectionsString

getMultiWhatsNewType

getMultiWhatsNewDate

getMultiWhatsNewDateDate

getCreationDate

getCreationDateDate

getMultiAccessionDate

getMultiAccessionDateDate

getAccessionDate

getAccessionDateDate

getAccessionStatus

getMultiAccessionStatus

getBeneficiary

getToolFor

getInstructionalGoal

getTeachingMethod

getTypicalAgeRange

getGradeRanges

getMultiGradeRanges

getGradeRangeLabels

getMultiGradeRangeLabels

getSubjects

getMultiSubjects

getSubjectLabels

getMultiSubjectLabels

getContentStandards

getMultiContentStandards

getContentStandardLabels

getMultiContentStandardLabels

getResourceTypes

getMultiResourceTypes

getResourceTypeLabels

getMultiResourceTypeLabels

getMultiRecordStatus

isMultiRecord

hasAnnotations

getAnnoTypes

getAnnoPathways

getAnnoStatus

getAnnoFormats

getAnnoRatings

getAverageAnnoRating

getAverageAnnoRatingFloat

getNumAnnoRatings

getNumAnnoRatingsInt

getAnnoCollectionKeys

getCompletedAnnoCollectionKeys

getAssociatedCollectionKeys

getAllAssociatedCollectionKeys