DLESE Tools
v1.6.0

org.dlese.dpc.ndr.reader
Class AggregatorReader

java.lang.Object
  extended by org.dlese.dpc.ndr.reader.NdrObjectReader
      extended by org.dlese.dpc.ndr.reader.GroupingObjectReader
          extended by org.dlese.dpc.ndr.reader.AggregatorReader

public class AggregatorReader
extends GroupingObjectReader

Extension of NdrObjectReader for accessing properties, dataStreams, and relationships of NDR Aggregator Objects.

More Info:

  • Aggregator overview: http://wiki.nsdl.org/index.php/Community:NDR/ObjectTypes#Aggregator
  • Aggregator data model: http://wiki.nsdl.org/index.php/Community:NCore/Model/Objects/Aggregator
  • Aggregator API requests: http://wiki.nsdl.org/index.php/Community:NDR/APIRequestsByObject#Aggregator_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
    AggregatorReader(Document ndrResponse)
              Constructor for the AggregatorReader object for the provided Document representing a NDR "get" call for a Aggregator object.
    AggregatorReader(String handle)
              Constructor for the AggregatorReader object at the specified NDR handle.
     
    Method Summary
     String getAggregatorFor()
              Gets the aggregatorFor attribute of the AggregatorReader object
     String getChildToParentRelationship()
              Gets the childToParentRelationship attribute of the AggregatorReader object
     String getCollectionResource()
              Gets the collectionResource attribute of the AggregatorReader object
     String getMdpHandle()
              Gets the mdpHandle attribute of the AggregatorReader object
     String getNativeFormat()
              Gets the nativeFormat for the ITEM-level metadata of this collection.
     
    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

    AggregatorReader

    public AggregatorReader(String handle)
                     throws Exception
    Constructor for the AggregatorReader object at the specified NDR handle.

    Parameters:
    handle - NOT YET DOCUMENTED
    Throws:
    Exception - NOT YET DOCUMENTED

    AggregatorReader

    public AggregatorReader(Document ndrResponse)
                     throws Exception
    Constructor for the AggregatorReader object for the provided Document representing a NDR "get" call for a Aggregator object.

    Parameters:
    ndrResponse - NOT YET DOCUMENTED
    Throws:
    Exception - NOT YET DOCUMENTED
    Method Detail

    getChildToParentRelationship

    public String getChildToParentRelationship()
    Gets the childToParentRelationship attribute of the AggregatorReader object

    Specified by:
    getChildToParentRelationship in class GroupingObjectReader
    Returns:
    The childToParentRelationship value

    getMdpHandle

    public String getMdpHandle()
    Gets the mdpHandle attribute of the AggregatorReader object

    Returns:
    The mdpHandle value

    getNativeFormat

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

    Returns:
    The nativeFormat value

    getAggregatorFor

    public String getAggregatorFor()
    Gets the aggregatorFor attribute of the AggregatorReader object

    Returns:
    The aggregatorFor value

    getCollectionResource

    public String getCollectionResource()
    Gets the collectionResource attribute of the AggregatorReader object

    Returns:
    The collectionResource value

    DLESE Tools
    v1.6.0