MetadataProviderReader (DLESE Tools API Documentation v1.6.0)

Field Summary
- Fields inherited from class org.dlese.dpc.ndr.reader.NdrObjectReader
  createdDate, doc, dsFormats, handle, lastModifiedDate, nativeDataStreamFormat, nsContext, objectType

Constructor Summary

Constructors
Constructor and Description
`MetadataProviderReader(org.dom4j.Document ndrResponse)` Constructor for the MetadataProviderReader object for the provided Document representing a NDR "get" call for a MetadataProvider object.
`MetadataProviderReader(java.lang.String handle)` Constructor for the MetadataProviderReader object at the specified NDR handle.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`getAggregatedBy()` Gets the aggregatedBy attribute of the MetadataProviderReader object
`java.lang.String`	`getChildToParentRelationship()` Gets the childToParentRelationship attribute of the GroupingObjectReader object
`java.lang.String`	`getCollectionId()` Gets the collectionId attribute of the MetadataProviderReader object (corresponding to the "setSpec" attribute of the collection's SetInfo object).
`java.lang.String`	`getCollectionName()` Gets the collectionName attribute of the MetadataProviderReader object (corresponding to the "name" attribute of the collection's SetInfo object).
`org.dom4j.Element`	`getCollectionRecord()` Gets the collectionRecord (dlese_collect format) of the MetadataProviderReader object
`HarvestInfoReader`	`getHarvestInfo()` Gets the serviceDescription attribute of the MetadataProviderReader object
`java.util.List`	`getInactiveItemHandles()` Gets the handles of the inactive metadata objects of the MetadataProviderReader object
`java.util.List`	`getItemHandles()` Gets the metadata object handles for the MetadataProviderReader object
`java.lang.String`	`getMetadataProviderFor()` Gets the metadataProviderFor attribute (an agent handle) of the MetadataProviderReader object
`java.lang.String`	`getNativeFormat()` Gets the nativeFormat for the ITEM-level metadata of this collection.
`java.lang.String`	`getSetName()` Gets the setName attribute of the MetadataProviderReader object
`java.lang.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(java.lang.String handle)
                       throws java.lang.Exception
```
    Constructor for the MetadataProviderReader object at the specified NDR handle.
    
    Parameters:
    
    handle - NOT YET DOCUMENTED
    
    Throws:
    
    java.lang.Exception - NOT YET DOCUMENTED
  - MetadataProviderReader
```
public MetadataProviderReader(org.dom4j.Document ndrResponse)
                       throws java.lang.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:
    
    java.lang.Exception - NOT YET DOCUMENTED
- Method Detail
  - getChildToParentRelationship
```
public java.lang.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 java.lang.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 java.lang.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 java.lang.String getNativeFormat()
```
    Gets the nativeFormat for the ITEM-level metadata of this collection.
    
    Returns:
    
    The nativeFormat value
  - getAggregatedBy
```
public java.lang.String getAggregatedBy()
```
    Gets the aggregatedBy attribute of the MetadataProviderReader object
    
    Returns:
    
    The aggregatedBy value
  - getMetadataProviderFor
```
public java.lang.String getMetadataProviderFor()
```
    Gets the metadataProviderFor attribute (an agent handle) of the MetadataProviderReader object
    
    Returns:
    
    The metadataProviderFor value
  - getSetSpec
```
public java.lang.String getSetSpec()
```
    Gets the setSpec attribute of the MetadataProviderReader object
    
    Returns:
    
    The setSpec value
  - getSetName
```
public java.lang.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 java.util.List getItemHandles()
                              throws java.lang.Exception
```
    Gets the metadata object handles for the MetadataProviderReader object
    
    Returns:
    
    The itemHandles value
    
    Throws:
    
    java.lang.Exception - NOT YET DOCUMENTED
  - getInactiveItemHandles
```
public java.util.List getInactiveItemHandles()
                                      throws java.lang.Exception
```
    Gets the handles of the inactive metadata objects of the MetadataProviderReader object
    
    Returns:
    
    The inactiveItemHandles value
    
    Throws:
    
    java.lang.Exception - NOT YET DOCUMENTED

Class MetadataProviderReader

Field Summary

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

Constructor Summary

Method Summary

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

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

Methods inherited from class java.lang.Object

Constructor Detail

MetadataProviderReader

MetadataProviderReader

Method Detail

getChildToParentRelationship

getCollectionId

getCollectionName

getCollectionRecord

getNativeFormat

getAggregatedBy

getMetadataProviderFor

getSetSpec

getSetName

getHarvestInfo

getItemHandles

getInactiveItemHandles