XMLDocReader (jOAI Java Documentation v3.3)

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

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

DcsDataDocReader, DleseAnnoDocReader, DleseCollectionDocReader, ItemDocReader, NewsOppsDocReader
```
public class XMLDocReader
extends FileIndexingServiceDocReader
```
A bean meant for subclassing that contains methods to read search results from indexed XML records. Subclasses of this bean provide specific accessor methods for XML data of their type. The data is read from a Lucene Document that was returned from a search and from XML on file.
In general, one XMLDocReader may be created for each document type that is defined in package org.dlese.dpc.index.writer.

Author:

John Weatherley

See Also:

XMLFileIndexingWriter, Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

class XMLDocReader.VocabUiLabelsCollection
A collection of user interface labels derived from vocabulary field/value IDs.

Nested Classes
Modifier and Type	Class and Description
`class`	`XMLDocReader.VocabUiLabelsCollection` A collection of user interface labels derived from vocabulary field/value IDs.

Field Summary

Fields
Modifier and Type	Field and Description
`protected MetadataVocab`	`metadataVocab` The vocab manager
`protected RecordDataService`	`recordDataService` The record data service
`protected RepositoryManager`	`repositoryManager` The RepositoryManager

Fields inherited from class org.dlese.dpc.index.reader.DocReader
conf, doc, resultDoc, score

Constructor Summary

Constructors
Constructor and Description
`XMLDocReader()` Constructor for the XMLDocReader object
`XMLDocReader(org.apache.lucene.document.Document doc)` Constructor that may be used programatically to wrap a reader around a Lucene `Document` created by a `FileIndexingServiceWriter`.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String[]`	`getAllIds()` Gets all the IDs associated with this resource, including this record's ID.
`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.Map`	`getAssignedByIdRelatedRecordsMap()` Gets a Map of records that this item assignes a relationship to by ID, keyed by relationship type, for example 'isAnnotatedBy'.
`java.util.Map`	`getAssignedByUrlRelatedRecordsMap()` Gets a Map of record ResultDoc arrays that this item assignes a relationship to by URL, keyed by relationship type, for example 'isAnnotatedBy'.
`java.lang.String[]`	`getAssignedRelatedIdsOfType(java.lang.String relationType)` Gets the record IDs for the items that this record assignes the given relationship to.
`java.lang.String[]`	`getAssignedRelatedUrlsOfType(java.lang.String relationType)` Gets the URLs for the items that this record assignes the given relationship to.
`java.lang.String[]`	`getAssignedRelationshipByIdTypes()` Gets the types of relationships that were asigned by this item by related ID, for example 'isAnnotatedBy'.
`java.lang.String[]`	`getAssignedRelationshipByUrlTypes()` Gets the types of relationships that were asigned by this item by related URL, for example 'isAnnotatedBy'.
`java.util.Map`	`getAssignedRelationshipsForItemsMap()` Gets a Map of record IDs and the corresponding relationships they are assigned.
`java.lang.String[]`	`getAssociatedIds()` Gets the IDs of records that refer to the same resource, not including this record's ID.
`java.util.ArrayList`	`getAudioAnnosInProgress()` Gets a list of `DleseAnnoDocReader`s containing each of the in-progress type 'audio' annotations for this resource.
`java.util.ArrayList`	`getAvailableFormats()` Gets the XML formats that are available for this item including those that are available through `XMLConversionService`.
`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.
`boolean`	`getCanDissiminateFormat()` Determine if XML for this item can be dissiminated in the requested format specified using the `setRequestedXmlFormat(String)`, as available through `XMLConversionService`.
`java.lang.String`	`getCollection()` Gets the primary collection associated with this item, for example 'dcc'.
`java.lang.String`	`getCollectionKey()` Gets the collection key associated with this record, for example 01.
`java.lang.String[]`	`getCollectionKeys()` Gets all collection keys associated with this record, for example {01,02}.
`java.lang.String`	`getCollectionLabel()` Gets the collection UI label from the vocab manager for this record, for example 'DLESE Community Collection (DCC)', or the short title from the collection record if the vocab manager is not available.
`java.lang.String[]`	`getCollections()` Gets the collections associated with this record as an array of Strings, for example {dcc,comet}.
`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.lang.String`	`getDescription()` Gets the description for the item.
`java.lang.String`	`getDocsource()` Gets the path to the source file of the document used to create this index record.
`protected java.lang.String`	`getFieldId(java.lang.String fieldString, java.lang.String metadataFormat)` Gets the field ID from the field name, for example 'gradeRange' will return 'gr'.
`java.util.ArrayList`	`getGraphicalAnnosInProgress()` Gets a list of `DleseAnnoDocReader`s containing each of the in-progress type 'graphical' annotations for this resource.
`boolean`	`getHasAssignedRelations()` Determines whether this item assigns one or more relationships by ID or URL.
`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.
`boolean`	`getHasRelations()` Determines whether this item has one or more relations.
`java.lang.String`	`getId()` Gets the id for this record, for example 'DLESE-000-000-000-001'.
`java.lang.String`	`getIdEncoded()` Gets the id for this record as encoded for unique searching and inexing.
`java.util.List`	`getIdsOfRecordsWithAssignedRelationships()` Gets a List of all IDs for records that this item assignes relationships for by ID or URL.
`java.lang.String`	`getIndexedContent()` Gets the full text of the content that was indexed.
`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'.
`boolean`	`getIsMyCollectionDisabled()` Determines whether my collection is 'disabled'.
`boolean`	`getIsMyCollectionEnabled()` Determines whether my collection is 'enabled'.
`java.lang.String`	`getMetadataPrefix()` Gets the metadata previx (format) of the file associated with this reader, for example 'dlese_ims' or 'adn'.
`MetadataVocab`	`getMetadataVocab()` Gets the metadataVocab manager, or null if one is not available
`java.lang.String`	`getMetadataVocabAudience()` Gets the metadataVocabAudience attribute of the XMLDocReader object
`java.lang.String`	`getMetadataVocabLanguage()` Gets the metadataVocabLanguage attribute of the XMLDocReader object
`protected org.apache.lucene.document.Document`	`getMultiDoc()` Gets the multiDoc lucene Document for this item, or the single doc, if none available.
`DleseCollectionDocReader`	`getMyCollectionDoc()` Gets the collection doc for the collection in which this record is a part.
`java.lang.String`	`getMyCollectionsRecordId()` Gets the ID of collection record in which this item belongs.
`java.lang.String`	`getNativeFormat()` Gets the nativeFormat of the file associated with this reader, for example 'dlese_ims' or 'adn'.
`java.lang.String`	`getNsdlDublinCoreXml()` Gets the content in NSDL Dublin Core XML format, or empty String if not available.
`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`	`getOaiDatestamp()` Gets the oaiDatestamp in UTC format for the given record.
`java.lang.String`	`getOaiDublinCoreXml()` Gets the content in OAI Dublin Core XML format, or empty String if not available.
`java.lang.String`	`getOaiLastModifiedString()` Gets a String representataion of the oai datestamp in readable format.
`java.util.List`	`getOaiSets()` Gets the OAI sets associated with this record as an ArrayList of Strings, for example 'dcc' or null.
`java.lang.String`	`getReaderType()` Gets the String 'XmlDocReader,' which is the key that describes this reader type.
`java.lang.String[]`	`getRelatedIdsOfType(java.lang.String relationType)` Gets the record IDs for the documents with the given relationship to this item, for example 'isAnnotatedBy'.
`java.util.Map`	`getRelatedRecordsMap()` Gets a Map of records that are related to this item, keyed by relationship type, for example 'isAnnotatedBy'.
`java.lang.String[]`	`getRelationshipTypes()` Gets the types of relationships that were indexed for this item, for example 'isAnnotatedBy'.
`java.lang.String`	`getRequestedXml()` Same as `getRequestedXmlFormat()` except returns the non-localized XML if no format was specified.
`java.lang.String`	`getRequestedXmlFormat()` Gets XML in the format that was previously specified using the `setRequestedXmlFormat(String)` method, or the localized native format if none was specified.
`java.lang.String`	`getSet()` Gets the primary set (collection) associated with this item, for example dcc.
`java.lang.String[]`	`getSets()` Gets the sets (collections) associated with this record as an array of Strings, for example dcc, which is not the same as the OAI sets.
`java.lang.String`	`getSetString()` Gets the collections associated with this record as a single String.
`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.
`protected java.lang.String`	`getUiLabelFromVocabId(java.lang.String fieldId, java.lang.String valueId, java.lang.String metadataFormat)` Gets the UI label corresponding to the given vocab value IDs and field ID.
`protected java.lang.String`	`getUiLabelFromVocabName(java.lang.String fieldName, java.lang.String vocabName, java.lang.String metadataFormat)` Gets the UI label corresponding to the given vocab value name from the XML and field name.
`protected java.util.Collection`	`getUiLabelsFromVocabIds(java.lang.String fieldId, java.lang.String[] valueIds, java.lang.String metadataFormat)` Gets the UI labels corresponding to the given vocab value IDs and field ID.
`java.lang.String`	`getUrl()` Gets the url for the item.
`java.lang.String`	`getValidationReport()` Gets the validationReport for this document, or null if no validationReport was found.
`protected java.lang.String`	`getValueId(java.lang.String fieldName, java.lang.String vocabName, java.lang.String metadataFormat)` Gets the value ID from the field name and value name, for example 'key', 'dcc' will return '09'.
`java.util.ArrayList`	`getVideoAnnosInProgress()` Gets a list of `DleseAnnoDocReader`s containing each of the in-progress type 'video' annotations for this resource.
`org.w3c.dom.Document`	`getW3CXmlDoc()` Gets a org.w3c.dom.Document for this record.
`java.lang.String`	`getWhatsNewDate()` Gets the Whats New date as a String.
`java.util.Date`	`getWhatsNewDateDate()` Gets the Whats New date as a Date.
`java.lang.String`	`getWhatsNewType()` Gets the Whats New type, which is one of 'itemnew,' 'itemannocomplete,' 'itemannoinprogress,' 'annocomplete,' 'annoinprogress,' 'drcannocomplete,' 'drcannoinprogress,' 'collection'.
`java.lang.String`	`getXml()` Gets the full XML for this record in it's native format.
`org.dom4j.Document`	`getXmlDoc()` Gets a dom4j XML Document for this record.
`java.lang.String`	`getXmlFormat(java.lang.String format, boolean filter)` Gets XML in the given format.
`java.lang.String`	`getXmlLocalized()` Gets the native format in a localized form if available, otherwise returns the native format stripped of XML and DTD declarations.
`java.lang.String`	`getXmlStripped()` Gets the full XML for this record in it's native format, with no XML or DTD declaration.
`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'.
`void`	`init()` Initialized a new XMLDocReader at search time.
`boolean`	`isValid()` Determines whether the XML for this record is valid.
`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.
`void`	`setMetadataVocabAudience(java.lang.String audience)` Sets the metadataVocabAudience attribute of the XMLDocReader object
`void`	`setMetadataVocabLanguage(java.lang.String language)` Sets the metadataVocabLanguage attribute of the XMLDocReader object
`void`	`setRequestedXmlFormat(java.lang.String format)` Sets the XML format that will be returned by the `getRequestedXmlFormat()` method.

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

- Field Detail
  - metadataVocab
```
protected MetadataVocab metadataVocab
```
    The vocab manager
  - recordDataService
```
protected RecordDataService recordDataService
```
    The record data service
  - repositoryManager
```
protected RepositoryManager repositoryManager
```
    The RepositoryManager
- Constructor Detail
  - XMLDocReader
```
public XMLDocReader()
```
    Constructor for the XMLDocReader object
  - XMLDocReader
```
public XMLDocReader(org.apache.lucene.document.Document doc)
```
    Constructor that may be used programatically to wrap a reader around a Lucene Document created by a FileIndexingServiceWriter.
    
    Parameters:
    
    doc - A Lucene Document created by a ItemFileIndexingWriter.
- Method Detail
  - init
```
public void init()
```
    Initialized a new XMLDocReader at search time.
    
    Specified by:
    
    init in class DocReader
  - getReaderType
```
public java.lang.String getReaderType()
```
    Gets the String 'XmlDocReader,' 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.
    
    Specified by:
    
    getReaderType in class DocReader
    
    Returns:
    
    The String 'XmlDocReader'.
  - getIndexedContent
```
public java.lang.String getIndexedContent()
```
    Gets the full text of the content that was indexed.
    
    Returns:
    
    The indexedContent value.
  - getTitle
```
public java.lang.String getTitle()
```
    Gets the title of the item.
    
    Returns:
    
    The title or empty if none
  - getDescription
```
public java.lang.String getDescription()
```
    Gets the description for the item.
    
    Returns:
    
    The description or empty
  - getUrl
```
public java.lang.String getUrl()
```
    Gets the url for the item.
    
    Returns:
    
    The url or empty
  - getId
```
public java.lang.String getId()
```
    Gets the id for this record, for example 'DLESE-000-000-000-001'.
    
    Returns:
    
    The id value
  - getIdEncoded
```
public java.lang.String getIdEncoded()
```
    Gets the id for this record as encoded for unique searching and inexing.
    
    Returns:
    
    The id encoded
  - getMetadataPrefix
```
public java.lang.String getMetadataPrefix()
```
    Gets the metadata previx (format) of the file associated with this reader, for example 'dlese_ims' or 'adn'.
    
    Returns:
    
    The metadataPrefix value
  - getNativeFormat
```
public java.lang.String getNativeFormat()
```
    Gets the nativeFormat of the file associated with this reader, for example 'dlese_ims' or 'adn'. Same as getMetadataPrefix().
    
    Returns:
    
    The nativeFormat.
  - getWhatsNewType
```
public java.lang.String getWhatsNewType()
```
    Gets the Whats New type, which is one of 'itemnew,' 'itemannocomplete,' 'itemannoinprogress,' 'annocomplete,' 'annoinprogress,' 'drcannocomplete,' 'drcannoinprogress,' 'collection'.
    
    Returns:
    
    The What's New type or empty String.
  - getWhatsNewDate
```
public java.lang.String getWhatsNewDate()
```
    Gets the Whats New date as a String. Note that for ADN records, the appropriate method to use when displaying this value to an end user is ItemDocReader.getMultiWhatsNewDate().
    
    Returns:
    
    The What's New date or empty String.
  - getWhatsNewDateDate
```
public java.util.Date getWhatsNewDateDate()
```
    Gets the Whats New date as a Date. Note that for ADN records, the appropriate method to use when displaying this value to an end user is ItemDocReader.getMultiWhatsNewDateDate().
    
    Returns:
    
    The What's New date or null.
  - getSetString
```
public java.lang.String getSetString()
```
    Gets the collections associated with this record as a single String.
    
    Returns:
    
    The collections.
  - getSets
```
public java.lang.String[] getSets()
```
    Gets the sets (collections) associated with this record as an array of Strings, for example dcc, which is not the same as the OAI sets. Assumes the set key has not been encoded using the vocab manager. The first set in the array is the primary set. Additional sets, if present, represent secondary sets that have been associated with this record via the ID mapper service.
    
    Returns:
    
    The set(s) associated with this record.
  - getOaiSets
```
public java.util.List getOaiSets()
```
    Gets the OAI sets associated with this record as an ArrayList of Strings, for example 'dcc' or null.
    
    Returns:
    
    A List of OAI set Strings, or null if none
  - getSet
```
public java.lang.String getSet()
```
    Gets the primary set (collection) associated with this item, for example dcc. The first collection in the array is the primary collection. Additional collection, if present, represent secondary collections that have been associated with this record via the ID mapper service.
    
    Returns:
    
    The primary collection associated with this record.
  - getCollection
```
public java.lang.String getCollection()
```
    Gets the primary collection associated with this item, for example 'dcc'. The first collection in the array is the primary collection. Additional collection, if present, represent secondary collections that have been associated with this record via the ID mapper service.
    
    Returns:
    
    The primary collection associated with this record.
  - getCollections
```
public java.lang.String[] getCollections()
```
    Gets the collections associated with this record as an array of Strings, for example {dcc,comet}. Assumes the collection key has not been encoded using the vocab manager. The first collection in the array is the primary collection. Additional collection, if present, represent secondary collections that have been associated with this record via the ID mapper service.
    
    Returns:
    
    The collection(s) associated with this record.
  - getCollectionKey
```
public java.lang.String getCollectionKey()
```
    Gets the collection key associated with this record, for example 01. Assumes the set key has been encoded using the vocab manager and that there is only one collection associated with this item.
    
    Returns:
    
    The collection for which this item belogs.
  - getCollectionKeys
```
public java.lang.String[] getCollectionKeys()
```
    Gets all collection keys associated with this record, for example {01,02}. Assumes the set key has been encoded using the vocab manager and that there are more than one collections associated with this item.
    
    Returns:
    
    The collections for which this item belogs.
  - getCollectionLabel
```
public java.lang.String getCollectionLabel()
```
    Gets the collection UI label from the vocab manager for this record, for example 'DLESE Community Collection (DCC)', or the short title from the collection record 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"/>
   ${docReader.collectionLabel}
  
```
    Returns:
    
    The collection label for this record
  - getMyCollectionDoc
```
public DleseCollectionDocReader getMyCollectionDoc()
```
    Gets the collection doc for the collection in which this record is a part.
    
    Returns:
    
    The myCollectionDoc value, or null if none available.
  - getIsMyCollectionEnabled
```
public boolean getIsMyCollectionEnabled()
```
    Determines whether my collection is 'enabled'.
    
    Returns:
    
    True if my collection is configured and is enabled, false if not
  - getIsMyCollectionDisabled
```
public boolean getIsMyCollectionDisabled()
```
    Determines whether my collection is 'disabled'.
    
    Returns:
    
    True if my collection is configured and is disabled, false if not
  - getMyCollectionsRecordId
```
public java.lang.String getMyCollectionsRecordId()
```
    Gets the ID of collection record in which this item belongs.
    
    Returns:
    
    The ID of this item's collection record, or null if not available.
  - getXml
```
public final java.lang.String getXml()
```
    Gets the full XML for this record in it's native format. Characters in the String returned are encoded as UTF-8.
    
    Returns:
    
    The XML, or empty string if unable to process.
  - getXmlDoc
```
public final org.dom4j.Document getXmlDoc()
```
    Gets a dom4j XML Document for this record. This method is optimized to create only one DOM when accessed multiple times for the same XMLDocReader.
    
    Returns:
    
    A dom4j XML Document, or null if unable to read
  - getW3CXmlDoc
```
public org.w3c.dom.Document getW3CXmlDoc()
```
    Gets a org.w3c.dom.Document for this record. This method is optimized to create only one DOM when accessed multiple times for the same XMLDocReader.
    
    Returns:
    
    A org.w3c.dom.Document, or null if unable to read.
  - getXmlStripped
```
public final java.lang.String getXmlStripped()
```
    Gets the full XML for this record in it's native format, with no XML or DTD declaration. Characters in the returned String are encoded as UTF-8.
    
    Returns:
    
    The XML, or empty string if unable to process.
  - getXmlLocalized
```
public final java.lang.String getXmlLocalized()
```
    Gets the native format in a localized form if available, otherwise returns the native format stripped of XML and DTD declarations. Localized XML contains no namespace declarations, making XPath sytax much simpler to work with since there is no need to use the local-name() function. Characters in the String retured are encoded at UTF-8.
    
    Returns:
    
    The localized XML, or the native format stripped of XML and DTD declarations.
  - getXmlFormat
```
public java.lang.String getXmlFormat(java.lang.String format,
                                     boolean filter)
```
    Gets XML in the given format. The resulting String contains XML in the given format, or an empty String if unable to dissiminate. Uses an XMLConversionService to perform the transformation from the native format to the requested format. If filter is set to true then the output will have the XML declaration stripped out and the DTD declaration will be commented out, in the case of DLESE IMS. Use filter=true to get XML suitable for insertion into an OAI container. Use filter=true to get the full XML including XML and DTD declaration, if present. Characters in the String returned are encoded as UTF-8.
    
    Parameters:
    
    format - The format desired.
    
    filter - Indicates whether to filter out the XML and DTD declaration.
    
    Returns:
    
    XML for the given format, or an empty String if unable to process.
  - getRequestedXmlFormat
```
public final java.lang.String getRequestedXmlFormat()
```
    Gets XML in the format that was previously specified using the setRequestedXmlFormat(String) method, or the localized native format if none was specified. The resulting String contains XML in the requested format, or an empty String if unable to process. Uses an XMLConversionService to perform the transformation from the native format to the requested format. XML and DTD declarations do not appear the output.
    
    Returns:
    
    XML for the requested format, or an empty String if unable to process.
    
    See Also:
    
    setRequestedXmlFormat(String)
  - getRequestedXml
```
public final java.lang.String getRequestedXml()
```
    Same as getRequestedXmlFormat() except returns the non-localized XML if no format was specified. XML and DTD declarations do not appear the output.
    
    Returns:
    
    XML for the requested format, or an empty String if unable to process.
    
    See Also:
    
    setRequestedXmlFormat(String), getRequestedXmlFormat()
  - setRequestedXmlFormat
```
public void setRequestedXmlFormat(java.lang.String format)
```
    Sets the XML format that will be returned by the getRequestedXmlFormat() method.
    
    Parameters:
    
    format - The new requestedXmlFormat value
    
    See Also:
    
    getRequestedXmlFormat()
  - getAvailableFormats
```
public java.util.ArrayList getAvailableFormats()
```
    Gets the XML formats that are available for this item including those that are available through XMLConversionService.
    
    Returns:
    
    The availableFormats, for example adn, oai_dc
  - getCanDissiminateFormat
```
public boolean getCanDissiminateFormat()
```
    Determine if XML for this item can be dissiminated in the requested format specified using the setRequestedXmlFormat(String), as available through XMLConversionService.
    
    Returns:
    
    True if the requested XML format can be dissiminated
    
    See Also:
    
    setRequestedXmlFormat(String), getXmlFormat(java.lang.String, boolean), getRequestedXmlFormat(), getRequestedXml()
  - getOaiDublinCoreXml
```
public java.lang.String getOaiDublinCoreXml()
```
    Gets the content in OAI Dublin Core XML format, or empty String if not available. The output contains no XML and DTD declaration.
    
    Returns:
    
    The oaiDublinCoreXml or empty String
  - getNsdlDublinCoreXml
```
public java.lang.String getNsdlDublinCoreXml()
```
    Gets the content in NSDL Dublin Core XML format, or empty String if not available. The output contains no XML and DTD declaration.
    
    Returns:
    
    The nsdlDublinCoreXml or empty String
  - getOaiDatestamp
```
public java.lang.String getOaiDatestamp()
```
    Gets the oaiDatestamp in UTC format for the given record.
    
    Returns:
    
    The oaiDatestamp value.
  - getOaiLastModifiedString
```
public java.lang.String getOaiLastModifiedString()
```
    Gets a String representataion of the oai datestamp in readable format.
    
    Returns:
    
    The File modification time.
  - getValidationReport
```
public java.lang.String getValidationReport()
```
    Gets the validationReport for this document, or null if no validationReport was found.
    
    Returns:
    
    The validationReport value.
    
    See Also:
    
    isValid()
  - getDocsource
```
public java.lang.String getDocsource()
```
    Gets the path to the source file of the document used to create this index record.
    
    Overrides:
    
    getDocsource in class FileIndexingServiceDocReader
    
    Returns:
    
    The document source file path
  - isValid
```
public boolean isValid()
```
    Determines whether the XML for this record is valid. To search for valididity, use field valid:[true|false] (unstored). If the XML was not valid there will be a validation report available.
    
    Returns:
    
    True if valid, else false.
    
    See Also:
    
    getValidationReport()
  - getFieldId
```
protected java.lang.String getFieldId(java.lang.String fieldString,
                                      java.lang.String metadataFormat)
```
    Gets the field ID from the field name, for example 'gradeRange' will return 'gr'.
    
    Parameters:
    
    fieldString - A vocab field, for example 'gradeRange'
    
    metadataFormat - The metadata format, for example 'adn'
    
    Returns:
    
    The field ID, for example 'gr', or the original field name if a translation is not available
  - getValueId
```
protected java.lang.String getValueId(java.lang.String fieldName,
                                      java.lang.String vocabName,
                                      java.lang.String metadataFormat)
```
    Gets the value ID from the field name and value name, for example 'key', 'dcc' will return '09'.
    
    Parameters:
    
    fieldName - The vocab field ID, for example 'key' or 'gradeRange'.
    
    vocabName - The vocab value name, for example 'dcc' or 'DLESE:High school'.
    
    metadataFormat - The metadata format, for example 'adn'
    
    Returns:
    
    The value ID, for example '09' or '02', or the original value name if a translation is not available
  - getMetadataVocab
```
public MetadataVocab getMetadataVocab()
```
    Gets the metadataVocab manager, or null if one is not available
    
    Returns:
    
    The metadataVocab manager
  - getMetadataVocabLanguage
```
public java.lang.String getMetadataVocabLanguage()
```
    Gets the metadataVocabLanguage attribute of the XMLDocReader object
    
    Returns:
    
    The metadataVocabLanguage value
  - setMetadataVocabLanguage
```
public void setMetadataVocabLanguage(java.lang.String language)
```
    Sets the metadataVocabLanguage attribute of the XMLDocReader object
    
    Parameters:
    
    language - The new metadataVocabLanguage value
  - getMetadataVocabAudience
```
public java.lang.String getMetadataVocabAudience()
```
    Gets the metadataVocabAudience attribute of the XMLDocReader object
    
    Returns:
    
    The metadataVocabAudience value
  - setMetadataVocabAudience
```
public void setMetadataVocabAudience(java.lang.String audience)
```
    Sets the metadataVocabAudience attribute of the XMLDocReader object
    
    Parameters:
    
    audience - The new metadataVocabAudience value
  - getUiLabelFromVocabId
```
protected java.lang.String getUiLabelFromVocabId(java.lang.String fieldId,
                                                 java.lang.String valueId,
                                                 java.lang.String metadataFormat)
```
    Gets the UI label corresponding to the given vocab value IDs and field ID. To specify the vocab interface to use, first call #setVocabInterface(String), otherwise the default will be used, which is 'dds.descr.en-us'. Note that if the vocab manager can not translate the given IDs then a comment string <!-- MUI... will be returned.
    
    Parameters:
    
    fieldId - The vocab field ID, for example 'gr'.
    
    valueId - The vocab value IDs, for example '07'.
    
    metadataFormat - The metadata format, for example 'adn'
    
    Returns:
    
    The UI lables for the given IDs, for example 'Primary (K-2)'
  - getUiLabelFromVocabName
```
protected java.lang.String getUiLabelFromVocabName(java.lang.String fieldName,
                                                   java.lang.String vocabName,
                                                   java.lang.String metadataFormat)
```
    Gets the UI label corresponding to the given vocab value name from the XML and field name. To specify the vocab interface to use, first call #setVocabInterface(String), otherwise the default will be used, which is 'dds.descr.en-us'. Note that if the vocab manager can not translate the given name then a comment string <!-- MUI... will be returned.
    
    Parameters:
    
    fieldName - The vocab field ID, for example 'key' or 'gradeRange'.
    
    vocabName - The vocab value name, for example 'dcc' or 'DLESE:High school'.
    
    metadataFormat - The metadata format, for example 'adn'
    
    Returns:
    
    The UI lables for the given IDs, for example 'DLESE Community Collection (DCC)' or 'High (9-12)'.
  - getUiLabelsFromVocabIds
```
protected java.util.Collection getUiLabelsFromVocabIds(java.lang.String fieldId,
                                                       java.lang.String[] valueIds,
                                                       java.lang.String metadataFormat)
```
    Gets the UI labels corresponding to the given vocab value IDs and field ID. To specify the vocab interface to use, first call #setVocabInterface(String), otherwise the default will be used, which is 'dds.descr.en-us'. Note that if the vocab manager can not translate the given IDs then the valueIds will be returned unchanged.
    
    Parameters:
    
    fieldId - The vocab field ID, for example 'gr'.
    
    valueIds - The vocab value IDs, for example '07', '04', '05'.
    
    metadataFormat - The metadata format, for example 'adn'
    
    Returns:
    
    The UI lables for the given IDs, for example 'Primary (K-2)', 'Intermediate (3-5)', 'Middle (6-8)'
  - getMultiDoc
```
protected org.apache.lucene.document.Document getMultiDoc()
```
    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.
    
    Returns:
    
    The multiDoc value
  - getHasAssignedRelations
```
public boolean getHasAssignedRelations()
```
    Determines whether this item assigns one or more relationships by ID or URL.
    
    Returns:
    
    True if asigned relations are present, false otherwise.
  - getAssignedRelationshipByIdTypes
```
public java.lang.String[] getAssignedRelationshipByIdTypes()
```
    Gets the types of relationships that were asigned by this item by related ID, for example 'isAnnotatedBy'.
    
    Returns:
    
    The types of assigned relationships, or empty array if none
  - getAssignedRelationshipByUrlTypes
```
public java.lang.String[] getAssignedRelationshipByUrlTypes()
```
    Gets the types of relationships that were asigned by this item by related URL, for example 'isAnnotatedBy'.
    
    Returns:
    
    The types of assigned relationships, or empty array if none
  - getAssignedRelatedIdsOfType
```
public java.lang.String[] getAssignedRelatedIdsOfType(java.lang.String relationType)
```
    Gets the record IDs for the items that this record assignes the given relationship to.
    
    Parameters:
    
    relationType - The type of relationship assigned, for example 'isAnnotatedBy'
    
    Returns:
    
    The IDs of the related records
  - getAssignedRelatedUrlsOfType
```
public java.lang.String[] getAssignedRelatedUrlsOfType(java.lang.String relationType)
```
    Gets the URLs for the items that this record assignes the given relationship to.
    
    Parameters:
    
    relationType - The type of relationship assigned, for example 'isAnnotatedBy'
    
    Returns:
    
    The URLs of the related items
  - getAssignedByIdRelatedRecordsMap
```
public java.util.Map getAssignedByIdRelatedRecordsMap()
```
    Gets a Map of records that this item assignes a relationship to by ID, keyed by relationship type, for example 'isAnnotatedBy'.
    
    Returns:
    
    A Map of record ResultDoc arrays keyed by relationship type
  - getAssignedByUrlRelatedRecordsMap
```
public java.util.Map getAssignedByUrlRelatedRecordsMap()
```
    Gets a Map of record ResultDoc arrays that this item assignes a relationship to by URL, keyed by relationship type, for example 'isAnnotatedBy'.
    
    Returns:
    
    A Map of record ResultDoc arrays keyed by relationship type
  - getAssignedRelationshipsForItemsMap
```
public java.util.Map getAssignedRelationshipsForItemsMap()
```
    Gets a Map of record IDs and the corresponding relationships they are assigned. The key is the record ID, the value is a list of relationships assigned for that ID (assigned by ID or URL).
    
    Returns:
    
    A Map of type
  - getIdsOfRecordsWithAssignedRelationships
```
public java.util.List getIdsOfRecordsWithAssignedRelationships()
```
    Gets a List of all IDs for records that this item assignes relationships for by ID or URL.
    
    Returns:
    
    A List of ID Strings.
  - getHasRelations
```
public boolean getHasRelations()
```
    Determines whether this item has one or more relations.
    
    Returns:
    
    True if relations are present, false otherwise.
  - getRelationshipTypes
```
public java.lang.String[] getRelationshipTypes()
```
    Gets the types of relationships that were indexed for this item, for example 'isAnnotatedBy'.
    
    Returns:
    
    The types of relationships, or empty array if none
  - getRelatedIdsOfType
```
public java.lang.String[] getRelatedIdsOfType(java.lang.String relationType)
```
    Gets the record IDs for the documents with the given relationship to this item, for example 'isAnnotatedBy'.
    
    Parameters:
    
    relationType - The type of relationship, for example 'isAnnotatedBy'
    
    Returns:
    
    The IDs of the related records
  - getRelatedRecordsMap
```
public java.util.Map getRelatedRecordsMap()
```
    Gets a Map of records that are related to this item, keyed by relationship type, for example 'isAnnotatedBy'.
    
    Returns:
    
    A Map of record ResultDoc arrays keyed by relationship type
  - hasAnnotations
```
public boolean hasAnnotations()
```
    Determines whether this item has annotations.
    
    Returns:
    
    True if annotations are present, false otherwise.
  - getAllIds
```
public java.lang.String[] getAllIds()
```
    Gets all the IDs associated with this resource, including this record's ID.
    
    Returns:
    
    The allIds value
  - getAssociatedIds
```
public java.lang.String[] getAssociatedIds()
```
    Gets the IDs of records that refer to the same resource, not including this record's ID.
    
    Returns:
    
    The associated IDs value.
  - getAnnotationResultDocs
```
public ResultDocList getAnnotationResultDocs()
```
    Gets the ResultDocs for all annotations that refer to this resource.
    
    Returns:
    
    The ResultDocs value
  - hasCompletedAnno
```
public boolean hasCompletedAnno()
```
    Determines whether this item has at least one completed annotation.
    
    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
    
    Returns:
    
    The hasCompletedAnno value
  - getNumCompletedAnnos
```
public java.lang.String getNumCompletedAnnos()
```
    Gets the numCompletedAnnos attribute of the ItemDocReader object
    
    Returns:
    
    The numCompletedAnnos value
  - getNumInProgressAnnos
```
public java.lang.String getNumInProgressAnnos()
```
    Gets the numInProgressAnnos attribute of the ItemDocReader object
    
    Returns:
    
    The numInProgressAnnos value
  - getNumTextAnnosInProgress
```
public java.lang.String getNumTextAnnosInProgress()
```
    Gets the numTextAnnosInProgress attribute of the ItemDocReader object
    
    Returns:
    
    The numTextAnnosInProgress value
  - getNumAudioAnnosInProgress
```
public java.lang.String getNumAudioAnnosInProgress()
```
    Gets the numAudioAnnosInProgress attribute of the ItemDocReader object
    
    Returns:
    
    The numAudioAnnosInProgress value
  - getNumGraphicalAnnosInProgress
```
public java.lang.String getNumGraphicalAnnosInProgress()
```
    Gets the numGraphicalAnnosInProgress attribute of the ItemDocReader object
    
    Returns:
    
    The numGraphicalAnnosInProgress value
  - getNumVideoAnnosInProgress
```
public java.lang.String getNumVideoAnnosInProgress()
```
    Gets the number of video format annotations in progress for this item.
    
    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.
    
    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.
    
    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.
    
    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.
    
    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'.
    
    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'.
    
    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.
    
    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.
    
    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.
    
    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.
    
    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.
    
    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.
    
    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.
    
    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.
    
    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.
    
    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.
    
    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.
    
    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.
    
    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.
    
    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.
    
    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.
    
    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.
    
    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.
    
    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.
    
    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.
    
    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.
    
    Returns:
    
    A list of DleseAnnoDocReaders or empty list
  - getAnnoCollectionKeys
```
public java.lang.String[] getAnnoCollectionKeys()
```
    Gets the annotataion collection keys, for example {06, 08}, for all collections that annotate this item.
    
    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.
    
    Returns:
    
    The completedAnnoCollectionKeys value
  - getAnnoTypes
```
public java.lang.String[] getAnnoTypes()
```
    Gets the anno types that are associated with this record.
    
    Returns:
    
    The anno types value.
  - getAnnoPathways
```
public java.util.ArrayList getAnnoPathways()
```
    Gets the anno pathways that are associated with this record.
    
    Returns:
    
    The list of anno pathway Strings
  - getAnnoStatus
```
public java.util.ArrayList getAnnoStatus()
```
    Gets the annotation statuses that are associated with this item.
    
    Returns:
    
    A list of anno status Strings
  - getAnnoFormats
```
public java.util.ArrayList getAnnoFormats()
```
    Gets the annotation formats that are associated with this item.
    
    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.
    
    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'.
    
    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.
    
    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'.
    
    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.
    
    Returns:
    
    The number of star ratings for this item
  - 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 XMLDocReader

Nested Class Summary

Field Summary

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

Constructor Summary

Method Summary

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

Field Detail

metadataVocab

recordDataService

repositoryManager

Constructor Detail

XMLDocReader

XMLDocReader

Method Detail

init

getReaderType

getIndexedContent

getTitle

getDescription

getUrl

getId

getIdEncoded

getMetadataPrefix

getNativeFormat

getWhatsNewType

getWhatsNewDate

getWhatsNewDateDate

getSetString

getSets

getOaiSets

getSet

getCollection

getCollections

getCollectionKey

getCollectionKeys

getCollectionLabel

getMyCollectionDoc

getIsMyCollectionEnabled

getIsMyCollectionDisabled

getMyCollectionsRecordId

getXml

getXmlDoc

getW3CXmlDoc

getXmlStripped

getXmlLocalized

getXmlFormat

getRequestedXmlFormat

getRequestedXml

setRequestedXmlFormat

getAvailableFormats

getCanDissiminateFormat

getOaiDublinCoreXml

getNsdlDublinCoreXml

getOaiDatestamp

getOaiLastModifiedString

getValidationReport

getDocsource

isValid

getFieldId

getValueId

getMetadataVocab

getMetadataVocabLanguage

setMetadataVocabLanguage

getMetadataVocabAudience

setMetadataVocabAudience

getUiLabelFromVocabId

getUiLabelFromVocabName

getUiLabelsFromVocabIds

getMultiDoc

getHasAssignedRelations

getAssignedRelationshipByIdTypes

getAssignedRelationshipByUrlTypes

getAssignedRelatedIdsOfType

getAssignedRelatedUrlsOfType

getAssignedByIdRelatedRecordsMap

getAssignedByUrlRelatedRecordsMap

getAssignedRelationshipsForItemsMap