org.dlese.dpc.schemedit.repository

Class RepositoryWriter

java.lang.Object

org.dlese.dpc.schemedit.repository.RepositoryWriter

public class RepositoryWriter
extends java.lang.Object

The class includes methods to create, copy, and put Records to the main Repository, and RepositoryWriterPlugins if so configured.

Author:

ostwald

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	RepositoryWriter(javax.servlet.ServletContext servletContext) Constructor for the RepositoryWriter object

Method Summary

Modifier and Type	Method and Description
void	addPlugin(RepositoryWriterPlugin plugin) Register a RepositoryWriterPlugin.
protected boolean	deleteCollection(CollectionConfig config) Delete a collection from the local repository.
protected boolean	deleteRecord(java.lang.String recId, DcsDataRecord dcsDataRecord) Delete a record from the repository.
java.util.List	getPlugins() Gets the registered RepositoryWriterPlugins
protected void	init() NOT YET DOCUMENTED
void	removePlugin(RepositoryWriterPlugin plugin) Unregister a RepositoryWriterPlugin.
protected void	writeRecord(java.lang.String recordXml, java.lang.String xmlFormat, java.lang.String collection, java.lang.String id, DcsDataRecord dcsDataRecord) Writes provided metadata to the index and to other registered repositories, such as the NDR.
protected void	writeRecord(java.lang.String recId, java.lang.String recordXml, XMLDocReader docReader, DcsDataRecord dcsDataRecord) Convenience method for RepositoryServices calls that have the docReader handy, calls writeRecord after computing required params.

Methods inherited from class java.lang.Object

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

Constructor Detail

RepositoryWriter

protected RepositoryWriter(javax.servlet.ServletContext servletContext)

Constructor for the RepositoryWriter object

Parameters:

servletContext - NOT YET DOCUMENTED

Method Detail

addPlugin

public void addPlugin(RepositoryWriterPlugin plugin)

Register a RepositoryWriterPlugin.

Parameters:

plugin - the RepositoryWriterPlugin

removePlugin

public void removePlugin(RepositoryWriterPlugin plugin)

Unregister a RepositoryWriterPlugin.

Parameters:

plugin - the RepositoryWriterPlugin

getPlugins

public java.util.List getPlugins()

Gets the registered RepositoryWriterPlugins

Returns:

The plugins value

writeRecord

protected void writeRecord(java.lang.String recId,
                           java.lang.String recordXml,
                           XMLDocReader docReader,
                           DcsDataRecord dcsDataRecord)
                    throws RecordUpdateException,
                           java.lang.Exception

Convenience method for RepositoryServices calls that have the docReader handy, calls writeRecord after computing required params.

Parameters:

recId - metadata record id

recordXml - metadata record as xml string

docReader - docReader for metadata

dcsDataRecord - dcsDataRecord for metadata

Throws:

RecordUpdateException - if record cannot be written to index

java.lang.Exception - NOT YET DOCUMENTED

writeRecord

protected void writeRecord(java.lang.String recordXml,
                           java.lang.String xmlFormat,
                           java.lang.String collection,
                           java.lang.String id,
                           DcsDataRecord dcsDataRecord)
                    throws RecordUpdateException,
                           java.lang.Exception

Writes provided metadata to the index and to other registered repositories, such as the NDR.

First try to write to the external repository. This attempt may fail before the record has been indexed the first time, if a RepositoryWriterPlugin required the index (as the NDR plugin does). In this case, a syncError is registered in the index.

Parameters:

recordXml - metadata record as xml string

xmlFormat - format of metadata

collection - collection key of metadata record (e.g., "dcc")

id - metadata record id

dcsDataRecord - dcsDataRecord for metadata

Throws:

RecordUpdateException - if record cannot be written to index

java.lang.Exception - NOT YET DOCUMENTED

deleteRecord

protected boolean deleteRecord(java.lang.String recId,
                               DcsDataRecord dcsDataRecord)
                        throws java.lang.Exception

Delete a record from the repository.

Current plugin exception policy: If there is a pluginError, the record is NOT deleted, but instead it is re-indexed as a sync-error.

Parameters:

recId - NOT YET DOCUMENTED

dcsDataRecord - NOT YET DOCUMENTED

Returns:

NOT YET DOCUMENTED

Throws:

java.lang.Exception - NOT YET DOCUMENTED

deleteCollection

protected boolean deleteCollection(CollectionConfig config)
                            throws java.lang.Exception

Delete a collection from the local repository. Called by RepositoryService

Parameters:

config - NOT YET DOCUMENTED

Returns:

NOT YET DOCUMENTED

Throws:

java.lang.Exception - NOT YET DOCUMENTED

init

protected void init()
             throws java.lang.Exception

NOT YET DOCUMENTED

Throws:

java.lang.Exception - NOT YET DOCUMENTED