org.dlese.dpc.schemedit.ndr.writer

Class MetadataWriter

java.lang.Object

org.dlese.dpc.schemedit.ndr.writer.MetadataWriter

Direct Known Subclasses:

NSDLCollectionWriter

public class MetadataWriter
extends java.lang.Object

Class responsible for writing Metadata records to the NDR as Metadata Objects.

Author:

Jonathan Ostwald

Field Summary

Fields

Modifier and Type	Field and Description
protected CollectionConfig	collectionConfig NOT YET DOCUMENTED
protected DcsDataRecord	dcsDataRecord NOT YET DOCUMENTED
protected XMLDocReader	docReader NOT YET DOCUMENTED
protected boolean	finalAndValid Description of the Field
protected org.dom4j.Document	itemRecord NOT YET DOCUMENTED
protected MetadataReader	mdReader NOT YET DOCUMENTED
protected java.lang.String	nsdlItemId
protected java.lang.String	recId NOT YET DOCUMENTED
protected RepositoryManager	rm NOT YET DOCUMENTED
protected javax.servlet.ServletContext	servletContext NOT YET DOCUMENTED
protected XMLConversionService	xmlConversionService NOT YET DOCUMENTED

Constructor Summary

Constructors

Constructor and Description
MetadataWriter() Constructor for the MetadataWriter object
MetadataWriter(javax.servlet.ServletContext servletContext) Constructor for the MetadataWriter object

Method Summary

Modifier and Type	Method and Description
protected NdrRequest	addMetadataRequest(NdrRequest ndrRequest, java.lang.String resHandle) Augment provided NdrRequest to form an "addMetadataRequest" request to create a new NDR object.
protected CollectionConfig	getCollectionConfig(java.lang.String collection) Gets the collectionConfig attribute of the RepositoryWriterPlugin object
protected org.dom4j.Document	getItemRecord(java.lang.String recordXml) Gets the metadata record as a dom4j.Document, converting from recordXml if it is provided, or obtaining from the index (via docReader) otherwise.
protected MetaDataFramework	getMetaDataFramework(java.lang.String xmlFormat) Gets the metaDataFramework attribute of the MetadataWriter object
protected MetadataReader	getMetadataReader() Gets the metadataReader attribute of the MetadataWriter object
protected java.lang.String	getResourceHandle(java.lang.String resourceUrl) Obtain a resource handle from the NDR for the provided resourceURL.
protected java.lang.String	getResourceUrl(org.dom4j.Document itemRecord) Get and validate the URL using the urlPath configured for this framework (NOTE: url path must be configured for the framework of the record to be written).
protected java.lang.Object	getServletContextAttribute(java.lang.String attrName) Gets the requiredContextAttributeValue attribute of the MetadataWriterPlugin object
protected java.lang.String	getValueOrNull(java.lang.String s) Gets the valueOrNull attribute of the MetadataWriter object
protected NdrRequest	getWriteRequest(java.lang.String resourceUrl, java.lang.String resHandle) Returns NdrRequest to write metadata to NDR, either as a new metadata object or by updating an existing object.
protected void	init(java.lang.String recordXml) Initialize required values and services for the MetadataWriter.
protected NdrRequest	modifyMetadataRequest(NdrRequest ndrRequest, java.lang.String resHandle, org.dom4j.Element nsdl_dc_stream) Augment provided NdrRequest to form a "modifyMetadataRequest" request for updating an existing metadata object in the NDR.
void	setServletContext(javax.servlet.ServletContext servletContext) Sets the servletContext attribute of the MetadataWriter object
SyncReportEntry	write(java.lang.String recId, DcsDataRecord dcsDataRecord) Convenience method to write the metadata record identified by recId along with dcsDataRecord, to the NDR.
SyncReportEntry	write(java.lang.String recId, java.lang.String recordXml, DcsDataRecord dcsDataRecord) Writes metadata record to NDR using provided "recordXml" metadata if provided, or metadata obtained from from the index if recordXml is null.

Methods inherited from class java.lang.Object

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

Field Detail

servletContext

protected javax.servlet.ServletContext servletContext

NOT YET DOCUMENTED

mdReader

protected MetadataReader mdReader

NOT YET DOCUMENTED

rm

protected RepositoryManager rm

NOT YET DOCUMENTED

recId

protected java.lang.String recId

NOT YET DOCUMENTED

docReader

protected XMLDocReader docReader

NOT YET DOCUMENTED

dcsDataRecord

protected DcsDataRecord dcsDataRecord

NOT YET DOCUMENTED

collectionConfig

protected CollectionConfig collectionConfig

NOT YET DOCUMENTED

xmlConversionService

protected XMLConversionService xmlConversionService

NOT YET DOCUMENTED

itemRecord

protected org.dom4j.Document itemRecord

NOT YET DOCUMENTED

finalAndValid

protected boolean finalAndValid

Description of the Field

nsdlItemId

protected java.lang.String nsdlItemId

Constructor Detail

MetadataWriter

public MetadataWriter()

Constructor for the MetadataWriter object

MetadataWriter

public MetadataWriter(javax.servlet.ServletContext servletContext)
               throws java.lang.Exception

Constructor for the MetadataWriter object

Parameters:

servletContext - NOT YET DOCUMENTED

Throws:

java.lang.Exception - NOT YET DOCUMENTED

Method Detail

setServletContext

public void setServletContext(javax.servlet.ServletContext servletContext)

Sets the servletContext attribute of the MetadataWriter object

Parameters:

servletContext - The new servletContext value

init

protected void init(java.lang.String recordXml)
             throws java.lang.Exception

Initialize required values and services for the MetadataWriter.

RepositoryManager, docReader, itemRecord, xmlConversionService, collectionConfig.

Parameters:

recordXml - metadata, can be null.

Throws:

java.lang.Exception - NOT YET DOCUMENTED

write

public SyncReportEntry write(java.lang.String recId,
                             DcsDataRecord dcsDataRecord)
                      throws java.lang.Exception

Convenience method to write the metadata record identified by recId along with dcsDataRecord, to the NDR.

This method is called from OUTSIDE the metadata editor (e.g., Sync), when there is not access to the actual XML of the record.

Parameters:

recId - NOT YET DOCUMENTED

dcsDataRecord - NOT YET DOCUMENTED

Returns:

NOT YET DOCUMENTED

Throws:

java.lang.Exception - NOT YET DOCUMENTED

write

public SyncReportEntry write(java.lang.String recId,
                             java.lang.String recordXml,
                             DcsDataRecord dcsDataRecord)
                      throws java.lang.Exception

Writes metadata record to NDR using provided "recordXml" metadata if provided, or metadata obtained from from the index if recordXml is null.

Parameters:

recId - recordId, used to obtain metadata from index if necessary

recordXml - metadata as String (optionally provided)

dcsDataRecord - auxillary information about the metadata record

Returns:

NOT YET DOCUMENTED

Throws:

java.lang.Exception - NOT YET DOCUMENTED

getWriteRequest

protected NdrRequest getWriteRequest(java.lang.String resourceUrl,
                                     java.lang.String resHandle)
                              throws java.lang.Exception

Returns NdrRequest to write metadata to NDR, either as a new metadata object or by updating an existing object.

Parameters:

resHandle - resource object handle

resourceUrl - NOT YET DOCUMENTED

Returns:

report instance indicating success or failure

Throws:

java.lang.Exception - if unable to build ndr request

addMetadataRequest

protected NdrRequest addMetadataRequest(NdrRequest ndrRequest,
                                        java.lang.String resHandle)
                                 throws java.lang.Exception

Augment provided NdrRequest to form an "addMetadataRequest" request to create a new NDR object.

Parameters:

resHandle - resource object handle

ndrRequest - The feature to be added to the Metadata attribute

Returns:

report instance indicating success or failure

Throws:

java.lang.Exception - if unable to build ndr request

modifyMetadataRequest

protected NdrRequest modifyMetadataRequest(NdrRequest ndrRequest,
                                           java.lang.String resHandle,
                                           org.dom4j.Element nsdl_dc_stream)
                                    throws java.lang.Exception

Augment provided NdrRequest to form a "modifyMetadataRequest" request for updating an existing metadata object in the NDR.

Collection-level objects (AggHandle and MdpHandle) are non-null only if the metadata is a NSDL collection record (i.e., ncs_collect format).

Parameters:

resHandle - resource object handle

ndrRequest - NOT YET DOCUMENTED

nsdl_dc_stream - NOT YET DOCUMENTED

Returns:

report instance indicating success or failure

Throws:

java.lang.Exception - if unable to build ndr request

getMetadataReader

protected MetadataReader getMetadataReader()
                                    throws java.lang.Exception

Gets the metadataReader attribute of the MetadataWriter object

Returns:

The metadataReader value

Throws:

java.lang.Exception - NOT YET DOCUMENTED

getResourceHandle

protected java.lang.String getResourceHandle(java.lang.String resourceUrl)
                                      throws java.lang.Exception

Obtain a resource handle from the NDR for the provided resourceURL. A new resource is created if one does not already exist in the NDR. In either case, a memberOf relationship is created between the resource and the collection's aggregator.

Parameters:

resourceUrl - url for the resorce to be found or created

Returns:

The resourceHandle value

Throws:

java.lang.Exception - if a collection aggregator is not found, or if the resource cannot be created or modified.

getItemRecord

protected org.dom4j.Document getItemRecord(java.lang.String recordXml)
                                    throws java.lang.Exception

Gets the metadata record as a dom4j.Document, converting from recordXml if it is provided, or obtaining from the index (via docReader) otherwise.

Parameters:

recordXml - metadata record as XML String

Returns:

The itemRecord value

Throws:

java.lang.Exception - if provided recordXml is not well-formed.

getValueOrNull

protected java.lang.String getValueOrNull(java.lang.String s)

Gets the valueOrNull attribute of the MetadataWriter object

Parameters:

s - Description of the Parameter

Returns:

The valueOrNull value

getResourceUrl

protected java.lang.String getResourceUrl(org.dom4j.Document itemRecord)
                                   throws java.lang.Exception

Get and validate the URL using the urlPath configured for this framework (NOTE: url path must be configured for the framework of the record to be written). For single-namespace frameworks, url must be obtained from localized record.

Parameters:

itemRecord - NOT YET DOCUMENTED

Returns:

The resourceUrl value

Throws:

java.lang.Exception - if resourceUrl cannot be obtained

getServletContextAttribute

protected java.lang.Object getServletContextAttribute(java.lang.String attrName)
                                               throws java.lang.Exception

Gets the requiredContextAttributeValue attribute of the MetadataWriterPlugin object

Parameters:

attrName - NOT YET DOCUMENTED

Returns:

The requiredContextAttributeValue value

Throws:

java.lang.Exception - NOT YET DOCUMENTED

getCollectionConfig

protected CollectionConfig getCollectionConfig(java.lang.String collection)
                                        throws java.lang.Exception

Gets the collectionConfig attribute of the RepositoryWriterPlugin object

Parameters:

collection - NOT YET DOCUMENTED

Returns:

The collectionConfig value

Throws:

java.lang.Exception - NOT YET DOCUMENTED

getMetaDataFramework

protected MetaDataFramework getMetaDataFramework(java.lang.String xmlFormat)
                                          throws java.lang.Exception

Gets the metaDataFramework attribute of the MetadataWriter object

Parameters:

xmlFormat - NOT YET DOCUMENTED

Returns:

The metaDataFramework value

Throws:

java.lang.Exception - NOT YET DOCUMENTED