org.dlese.dpc.ndr.reader

Class GroupingObjectReader

java.lang.Object

org.dlese.dpc.ndr.reader.NdrObjectReader

org.dlese.dpc.ndr.reader.GroupingObjectReader

Direct Known Subclasses:

AggregatorReader, MetadataProviderReader

public abstract class GroupingObjectReader
extends NdrObjectReader

Base class for MetadataProvider and Aggregator Readers with support for listing members, authorization, and service descriptions.

Author:

ostwald

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
GroupingObjectReader(org.dom4j.Document ndrResponse) Constructor for the GroupingObjectReader object for the provided Document representing a NDR "get" call for a MetadataProvider object.
GroupingObjectReader(org.dom4j.Document ndrResponse, java.lang.String format) Constructor for the GroupingObjectReader object
GroupingObjectReader(java.lang.String handle) Constructor for the GroupingObjectReader object at the specified NDR handle.
GroupingObjectReader(java.lang.String handle, java.lang.String format) Constructor for the GroupingObjectReader object

Method Summary

Modifier and Type	Method and Description
abstract java.lang.String	getChildToParentRelationship() Gets the childToParentRelationship attribute of the GroupingObjectReader object
int	getInactiveMemberCount() Gets the number of inactive Members of the GroupingObjectReader object
java.util.List	getInactiveMemberHandles() Gets the handles of the inactive metadata objects of the GroupingObjectReader object
int	getMemberCount() Gets the number of visible metadata records of the GroupingObjectReader object
java.util.List	getMemberHandles() Gets the metadata object handles for the GroupingObjectReader object
ServiceDescriptionReader	getServiceDescription() Gets the serviceDescription attribute of the GroupingObjectReader object
boolean	isAuthorizedToChange() Returns true if the configured NCS_AGENT is authorized to change this object
boolean	isAuthorizedToChange(java.lang.String agentHandle) Returns true if specified agent is authorized to change this object.

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

GroupingObjectReader

public GroupingObjectReader(java.lang.String handle)
                     throws java.lang.Exception

Constructor for the GroupingObjectReader object at the specified NDR handle.

Parameters:

handle - NOT YET DOCUMENTED

Throws:

java.lang.Exception - NOT YET DOCUMENTED

GroupingObjectReader

public GroupingObjectReader(java.lang.String handle,
                            java.lang.String format)
                     throws java.lang.Exception

Constructor for the GroupingObjectReader object

Parameters:

handle - NOT YET DOCUMENTED

format - NOT YET DOCUMENTED

Throws:

java.lang.Exception - NOT YET DOCUMENTED

GroupingObjectReader

public GroupingObjectReader(org.dom4j.Document ndrResponse)
                     throws java.lang.Exception

Constructor for the GroupingObjectReader 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

GroupingObjectReader

public GroupingObjectReader(org.dom4j.Document ndrResponse,
                            java.lang.String format)
                     throws java.lang.Exception

Constructor for the GroupingObjectReader object

Parameters:

ndrResponse - NOT YET DOCUMENTED

format - NOT YET DOCUMENTED

Throws:

java.lang.Exception - NOT YET DOCUMENTED

Method Detail

getChildToParentRelationship

public abstract java.lang.String getChildToParentRelationship()

Gets the childToParentRelationship attribute of the GroupingObjectReader object

Returns:

The childToParentRelationship value

getServiceDescription

public ServiceDescriptionReader getServiceDescription()

Gets the serviceDescription attribute of the GroupingObjectReader object

Returns:

The serviceDescription value

getMemberHandles

public java.util.List getMemberHandles()
                                throws java.lang.Exception

Gets the metadata object handles for the GroupingObjectReader object

Returns:

The memberHandles value

Throws:

java.lang.Exception - NOT YET DOCUMENTED

getMemberCount

public int getMemberCount()
                   throws java.lang.Exception

Gets the number of visible metadata records of the GroupingObjectReader object

Returns:

The number of members for this MDP

Throws:

java.lang.Exception - NOT YET DOCUMENTED

getInactiveMemberHandles

public java.util.List getInactiveMemberHandles()
                                        throws java.lang.Exception

Gets the handles of the inactive metadata objects of the GroupingObjectReader object

Returns:

The inactiveMemberHandles value

Throws:

java.lang.Exception - NOT YET DOCUMENTED

getInactiveMemberCount

public int getInactiveMemberCount()
                           throws java.lang.Exception

Gets the number of inactive Members of the GroupingObjectReader object

Returns:

The inactiveMemberCount value

Throws:

java.lang.Exception - NOT YET DOCUMENTED

isAuthorizedToChange

public boolean isAuthorizedToChange()

Returns true if the configured NCS_AGENT is authorized to change this object

Returns:

The authorizedToChange value

isAuthorizedToChange

public boolean isAuthorizedToChange(java.lang.String agentHandle)

Returns true if specified agent is authorized to change this object.

Parameters:

agentHandle - the agent handle

Returns:

The authorizedToChange value