MetadataReader (jOAI Java Documentation v3.3)

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
`MetadataReader(org.dom4j.Document response)` Constructor for the MetadataReader object
`MetadataReader(org.dom4j.Document response, java.lang.String nativeDataStreamFormat)` Constructor for the MetadataReader object
`MetadataReader(java.lang.String handle)` Constructor for the MetadataReader object
`MetadataReader(java.lang.String handle, java.lang.String nativeDataStreamFormat)` Constructor for the MetadataReader object with nativeFormat specified

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`org.dom4j.Document`	`getCanonicalNsdlDcItemRecord()` Gets the "nsdl_dc" datastream as a dom4j.Document
`boolean`	`getIsFinal()` Returns true if the ncs:status property of the Metadata object (which is only present if this object is managed by the NCS) is NCS_FINAL_STATUS.
`boolean`	`getIsValid()` Returns true if the ncs:isValid property of the Metadata object, which is defined only if this object is managed by the NCS, is "true", and false otherwise.
`java.lang.String`	`getItemId()` Gets the nsdl:itemId property of the Metadata object
`org.dom4j.Document`	`getItemRecord()` Gets the native datastream as a dom4j.Document (using the nativeDataStream attribute of this reader).
`java.lang.String`	`getRecordId()` Gets the ncs:recordId property of the Metadata object, which is defined only if this object is managed by the NCS.
`java.lang.String`	`getStatus()` Gets the ncs:status property of the Metadata object, which is defined only if this object is managed by the NCS
`java.lang.String`	`getUniqueID()` Gets the nsdl:uniqueID property of the Metadata object.
`boolean`	`isNcsMetadata()` Returns true if this Metadata object is managed by the NCS.
`protected static void`	`pp(org.dom4j.Node node)`

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

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - MetadataReader
```
public MetadataReader(java.lang.String handle)
               throws java.lang.Exception
```
    Constructor for the MetadataReader object
    
    Parameters:
    
    handle - handle to MetadataObject in the NDR
    
    Throws:
    
    java.lang.Exception - if handle does not correspond to existing Metatadata object
  - MetadataReader
```
public MetadataReader(java.lang.String handle,
                      java.lang.String nativeDataStreamFormat)
               throws java.lang.Exception
```
    Constructor for the MetadataReader object with nativeFormat specified
    
    Parameters:
    
    handle - handle to MetadataObject in the NDR
    
    nativeDataStreamFormat - nativeFormat of the collection to which this metata belongs
    
    Throws:
    
    java.lang.Exception - if handle does not correspond to existing Metatadata object
  - MetadataReader
```
public MetadataReader(org.dom4j.Document response)
               throws java.lang.Exception
```
    Constructor for the MetadataReader object
    
    Parameters:
    
    response - NOT YET DOCUMENTED
    
    Throws:
    
    java.lang.Exception - NOT YET DOCUMENTED
  - MetadataReader
```
public MetadataReader(org.dom4j.Document response,
                      java.lang.String nativeDataStreamFormat)
               throws java.lang.Exception
```
    Constructor for the MetadataReader object
    
    Parameters:
    
    response - NOT YET DOCUMENTED
    
    nativeDataStreamFormat - NOT YET DOCUMENTED
    
    Throws:
    
    java.lang.Exception - NOT YET DOCUMENTED
- Method Detail
  - getRecordId
```
public java.lang.String getRecordId()
```
    Gets the ncs:recordId property of the Metadata object, which is defined only if this object is managed by the NCS.
    
    Returns:
    
    The recordId value
  - getUniqueID
```
public java.lang.String getUniqueID()
```
    Gets the nsdl:uniqueID property of the Metadata object.
    
    Returns:
    
    The uniqueID value
  - getItemId
```
public java.lang.String getItemId()
```
    Gets the nsdl:itemId property of the Metadata object
    
    Returns:
    
    The itemId value
  - getStatus
```
public java.lang.String getStatus()
```
    Gets the ncs:status property of the Metadata object, which is defined only if this object is managed by the NCS
    
    Returns:
    
    The status value
  - getIsValid
```
public boolean getIsValid()
```
    Returns true if the ncs:isValid property of the Metadata object, which is defined only if this object is managed by the NCS, is "true", and false otherwise.
    
    Returns:
    
    The isValid value
  - getIsFinal
```
public boolean getIsFinal()
```
    Returns true if the ncs:status property of the Metadata object (which is only present if this object is managed by the NCS) is NCS_FINAL_STATUS.
    
    Returns:
    
    The isFinal value
  - isNcsMetadata
```
public boolean isNcsMetadata()
```
    Returns true if this Metadata object is managed by the NCS.
    
    Returns:
    
    The ncsMetadata value
  - getItemRecord
```
public org.dom4j.Document getItemRecord()
                                 throws java.lang.Exception
```
    Gets the native datastream as a dom4j.Document (using the nativeDataStream attribute of this reader).
    
    Returns:
    
    the native datastream
    
    Throws:
    
    java.lang.Exception - if the native datastream could not be read or processed
  - getCanonicalNsdlDcItemRecord
```
public org.dom4j.Document getCanonicalNsdlDcItemRecord()
                                                throws java.lang.Exception
```
    Gets the "nsdl_dc" datastream as a dom4j.Document
    
    Returns:
    
    The canonicalNsdlDcItemRecord value
    
    Throws:
    
    java.lang.Exception - NOT YET DOCUMENTED
  - pp
```
protected static void pp(org.dom4j.Node node)
```

Class MetadataReader

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

Methods inherited from class java.lang.Object

Constructor Detail

MetadataReader

MetadataReader

MetadataReader

MetadataReader

Method Detail

getRecordId

getUniqueID

getItemId

getStatus

getIsValid

getIsFinal

isNcsMetadata

getItemRecord

getCanonicalNsdlDcItemRecord

pp