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

Field Summary

Fields inherited from class org.dlese.dpc.ndr.reader.NdrObjectReader

createdDate, doc, dsFormats, handle, lastModifiedDate, nativeDataStreamFormat, nsContext, objectType

Constructor Summary

MetadataProviderReader(Document ndrResponse)
Constructor for the MetadataProviderReader object for the provided Document representing a NDR "get" call for a MetadataProvider object.

MetadataProviderReader(String handle)
Constructor for the MetadataProviderReader object at the specified NDR handle.

Method Summary

String	getAggregatedBy() Gets the aggregatedBy attribute of the MetadataProviderReader object
String	getChildToParentRelationship() Gets the childToParentRelationship attribute of the GroupingObjectReader object
String	getCollectionId() Gets the collectionId attribute of the MetadataProviderReader object (corresponding to the "setSpec" attribute of the collection's SetInfo object).
String	getCollectionName() Gets the collectionName attribute of the MetadataProviderReader object (corresponding to the "name" attribute of the collection's SetInfo object).
Element	getCollectionRecord() Gets the collectionRecord (dlese_collect format) of the MetadataProviderReader object
HarvestInfoReader	getHarvestInfo() Gets the serviceDescription attribute of the MetadataProviderReader object
List	getInactiveItemHandles() Gets the handles of the inactive metadata objects of the MetadataProviderReader object
List	getItemHandles() Gets the metadata object handles for the MetadataProviderReader object
String	getMetadataProviderFor() Gets the metadataProviderFor attribute (an agent handle) of the MetadataProviderReader object
String	getNativeFormat() Gets the nativeFormat for the ITEM-level metadata of this collection.
String	getSetName() Gets the setName attribute of the MetadataProviderReader object
String	getSetSpec() Gets the setSpec attribute of the MetadataProviderReader object

Methods inherited from class org.dlese.dpc.ndr.reader.GroupingObjectReader

getInactiveMemberCount, getInactiveMemberHandles, getMemberCount, getMemberHandles, getServiceDescription, isAuthorizedToChange, isAuthorizedToChange

Methods inherited from class org.dlese.dpc.ndr.reader.NdrObjectReader

getCanonicalNsdlDcDataStream, getCreated, getCreatedDate, getDataStream, getDataStream, getDocument, getFormats, getHandle, getLastModified, getLastModifiedDate, getNativeDataStream, getNativeDataStream, getNode, getNodes, getNodeText, getNsContext, getObjectType, getProperty, getPropertyValues, getRelationship, getRelationshipValues, getState, getXPath, initDataStreams, pp, setDebug

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

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(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 Detail

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