Package org.dlese.dpc.ndr.reader

Class MetadataProviderReader

java.lang.Object
org.dlese.dpc.ndr.reader.NdrObjectReader
org.dlese.dpc.ndr.reader.GroupingObjectReader
org.dlese.dpc.ndr.reader.MetadataProviderReader
public class MetadataProviderReader extends GroupingObjectReader
/** Extension of NdrObjectReader for accessing properties, dataStreams, and relationships of NDR MetadataProvider Objects.

More Info:

  • MetadataProvider overview: http://wiki.nsdl.org/index.php/Community:NDR/ObjectTypes#MetadataProvider
  • MetadataProvider data model: http://wiki.nsdl.org/index.php/Community:NCore/Model/Objects/MetadataProvider
  • MetadataProvider API requests: http://wiki.nsdl.org/index.php/Community:NDR/APIRequestsByObject#MetadataProvider_requests
    • Author:
    ostwald

    • Constructor Details

      • MetadataProviderReader

        public MetadataProviderReader(String handle) throws Exception
        Constructor for the MetadataProviderReader object at the specified NDR handle.
        Parameters:
        handle - NOT YET DOCUMENTED
        Throws:
        Exception - NOT YET DOCUMENTED

      • MetadataProviderReader

        public MetadataProviderReader(org.dom4j.Document ndrResponse) throws Exception
        Constructor for the MetadataProviderReader object for the provided Document representing a NDR "get" call for a MetadataProvider object.
        Parameters:
        ndrResponse - NOT YET DOCUMENTED
        Throws:
        Exception - NOT YET DOCUMENTED

    • Method Details

      • getChildToParentRelationship

        public String getChildToParentRelationship()
        Description copied from class: GroupingObjectReader
        Gets the childToParentRelationship attribute of the GroupingObjectReader object
        Specified by:
        getChildToParentRelationship in class GroupingObjectReader
        Returns:
        The childToParentRelationship value

      • getCollectionId

        public String getCollectionId()
        Gets the collectionId attribute of the MetadataProviderReader object (corresponding to the "setSpec" attribute of the collection's SetInfo object).
        Returns:
        The collectionId value

      • getCollectionName

        public String getCollectionName()
        Gets the collectionName attribute of the MetadataProviderReader object (corresponding to the "name" attribute of the collection's SetInfo object).
        Returns:
        The collectionName value

      • getCollectionRecord

        public org.dom4j.Element getCollectionRecord()
        Gets the collectionRecord (dlese_collect format) of the MetadataProviderReader object
        Returns:
        The collectionRecord value

      • getNativeFormat

        public String getNativeFormat()
        Gets the nativeFormat for the ITEM-level metadata of this collection.
        Returns:
        The nativeFormat value

      • getAggregatedBy

        public String getAggregatedBy()
        Gets the aggregatedBy attribute of the MetadataProviderReader object
        Returns:
        The aggregatedBy value

      • getMetadataProviderFor

        public String getMetadataProviderFor()
        Gets the metadataProviderFor attribute (an agent handle) of the MetadataProviderReader object
        Returns:
        The metadataProviderFor value

      • getSetSpec

        public String getSetSpec()
        Gets the setSpec attribute of the MetadataProviderReader object
        Returns:
        The setSpec value

      • getSetName

        public String getSetName()
        Gets the setName attribute of the MetadataProviderReader object
        Returns:
        The setName value

      • getHarvestInfo

        public HarvestInfoReader getHarvestInfo()
        Gets the serviceDescription attribute of the MetadataProviderReader object
        Returns:
        The serviceDescription value

      • getItemHandles

        public List getItemHandles() throws Exception
        Gets the metadata object handles for the MetadataProviderReader object
        Returns:
        The itemHandles value
        Throws:
        Exception - NOT YET DOCUMENTED

      • getInactiveItemHandles

        public List getInactiveItemHandles() throws Exception
        Gets the handles of the inactive metadata objects of the MetadataProviderReader object
        Returns:
        The inactiveItemHandles value
        Throws:
        Exception - NOT YET DOCUMENTED