Package org.mycore.datamodel.common

Class MCRXMLMetadataManager

java.lang.Object

org.mycore.datamodel.common.MCRXMLMetadataManager

public class MCRXMLMetadataManager
extends Object

Provides an adapter to communicate with the configured MCRXMLMetadataManagerAdapter implementation.

Author:

Christoph Neidahl (OPNA2608)

Constructor Summary

Constructors

Constructor	Description
MCRXMLMetadataManager()

Method Summary

Modifier and Type	Method	Description
void	create(MCRObjectID mcrid, byte[] xml, Date lastModified)	Stores metadata of a new MCRObject in the persistent store.
void	create(MCRObjectID mcrid, Document xml, Date lastModified)	Stores metadata of a new MCRObject in the persistent store.
void	create(MCRObjectID mcrid, MCRContent xml, Date lastModified)	Delegation, see linked method for relevant documentation.
void	createOrUpdate(MCRObjectID mcrid, Document xml, Date lastModified)	Creates or updates metadata of a MCRObject in the persistent store.
void	delete(String mcrid)
void	delete(MCRObjectID mcrid)	Delegation, see linked method for relevant documentation.
boolean	exists(MCRObjectID mcrid)	Delegation, see linked method for relevant documentation.
int	getHighestStoredID(String project, String type)	Delegation, see linked method for relevant documentation.
long	getLastModified()	Returns the time the store's content was last modified
long	getLastModified(MCRObjectID id)	Delegation, see linked method for relevant documentation.
MCRCache.ModifiedHandle	getLastModifiedHandle(MCRObjectID id, long expire, TimeUnit unit)	Delegation, see linked method for relevant documentation.
Collection<String>	getObjectBaseIds()	Delegation, see linked method for relevant documentation.
Collection<String>	getObjectTypes()	Delegation, see linked method for relevant documentation.
static MCRXMLMetadataManager	instance()	Reads the MCR.Metadata.Manager.Class to instantiate and return the configured xml metadata manager.
List<String>	listIDs()	Delegation, see linked method for relevant documentation.
List<String>	listIDsForBase(String base)	Delegation, see linked method for relevant documentation.
List<String>	listIDsOfType(String type)	Delegation, see linked method for relevant documentation.
List<MCRObjectIDDate>	listObjectDates()	Lists all objects with their last modification dates.
List<MCRObjectIDDate>	listObjectDates(String type)	Lists all objects of the specified type and their last modified date.
List<? extends MCRAbstractMetadataVersion<?>>	listRevisions(MCRObjectID id)	Delegation, see linked method for relevant documentation.
void	reload()	Delegation, see linked method for relevant documentation.
byte[]	retrieveBLOB(MCRObjectID mcrid)	Retrieves stored metadata xml as byte[] BLOB.
MCRContent	retrieveContent(MCRObjectID mcrid)	Delegation, see linked method for relevant documentation.
MCRContent	retrieveContent(MCRObjectID mcrid, String revision)	Delegation, see linked method for relevant documentation.
List<MCRObjectIDDate>	retrieveObjectDates(List<String> ids)	Delegation, see linked method for relevant documentation.
Document	retrieveXML(MCRObjectID mcrid)	Retrieves stored metadata xml as JDOM document
void	update(MCRObjectID mcrid, byte[] xml, Date lastModified)	Updates metadata of existing MCRObject in the persistent store.
void	update(MCRObjectID mcrid, Document xml, Date lastModified)	Updates metadata of existing MCRObject in the persistent store.
void	update(MCRObjectID mcrid, MCRContent xml, Date lastModified)	Delegation, see linked method for relevant documentation.
void	verifyStore(String base)	Delegation, see linked method for relevant documentation.

Methods inherited from class java.lang.Object

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

Constructor Details

MCRXMLMetadataManager

public MCRXMLMetadataManager()

Method Details

instance

public static MCRXMLMetadataManager instance()

Reads the MCR.Metadata.Manager.Class to instantiate and return the configured xml metadata manager. If MCR.Metadata.Manager.Class is not set, an instance of MCRDefaultXMLMetadataManager is returned.

Returns:

an instance of the configured xml metadata manager if any is set, or MCRDefaultXMLMetadataManager

reload

public void reload()

Delegation, see linked method for relevant documentation.

See Also:

• MCRXMLMetadataManagerAdapter.reload()

verifyStore

public void verifyStore(String base)

Delegation, see linked method for relevant documentation.

Parameters:

base -

See Also:

• MCRXMLMetadataManagerAdapter.verifyStore(String)

create

public void create(MCRObjectID mcrid,
 MCRContent xml,
 Date lastModified)
            throws MCRPersistenceException

Delegation, see linked method for relevant documentation.

Parameters:

mcrid -

xml -

lastModified -

Throws:

MCRPersistenceException

See Also:

• MCRXMLMetadataManagerAdapter.create(MCRObjectID, MCRContent, Date)

delete

public void delete(MCRObjectID mcrid)
            throws MCRPersistenceException

Delegation, see linked method for relevant documentation.

Parameters:

mcrid -

Throws:

MCRPersistenceException

See Also:

• MCRXMLMetadataManagerAdapter.delete(MCRObjectID)

update

public void update(MCRObjectID mcrid,
 MCRContent xml,
 Date lastModified)
            throws MCRPersistenceException

Delegation, see linked method for relevant documentation.

Parameters:

mcrid -

xml -

lastModified -

Throws:

MCRPersistenceException

See Also:

• MCRXMLMetadataManagerAdapter.update(MCRObjectID, MCRContent, Date)

retrieveContent

public MCRContent retrieveContent(MCRObjectID mcrid)
                           throws IOException

Delegation, see linked method for relevant documentation.

Parameters:

mcrid -

Returns:

Throws:

IOException

See Also:

• MCRXMLMetadataManagerAdapter.retrieveContent(MCRObjectID)

retrieveContent

public MCRContent retrieveContent(MCRObjectID mcrid,
 String revision)
                           throws IOException

Delegation, see linked method for relevant documentation.

Parameters:

mcrid -

revision -

Returns:

Throws:

IOException

See Also:

• MCRXMLMetadataManagerAdapter.retrieveContent(MCRObjectID, String)

listRevisions

public List<? extends MCRAbstractMetadataVersion<?>> listRevisions(MCRObjectID id)
                                                            throws IOException

Delegation, see linked method for relevant documentation.

Parameters:

id -

Returns:

Throws:

IOException

See Also:

• MCRXMLMetadataManagerAdapter.listRevisions(MCRObjectID)

getHighestStoredID

public int getHighestStoredID(String project,
 String type)

Delegation, see linked method for relevant documentation.

Parameters:

project -

type -

Returns:

Throws:

MCRPersistenceException

See Also:

• MCRXMLMetadataManagerAdapter.getHighestStoredID(String, String)

exists

public boolean exists(MCRObjectID mcrid)
               throws MCRPersistenceException

Delegation, see linked method for relevant documentation.

Parameters:

mcrid -

Returns:

Throws:

MCRPersistenceException

See Also:

• MCRXMLMetadataManagerAdapter.exists(MCRObjectID)

listIDsForBase

public List<String> listIDsForBase(String base)

Delegation, see linked method for relevant documentation.

Parameters:

base -

Returns:

See Also:

• MCRXMLMetadataManagerAdapter.listIDsForBase(String)

listIDsOfType

public List<String> listIDsOfType(String type)

Delegation, see linked method for relevant documentation.

Parameters:

type -

Returns:

See Also:

• MCRXMLMetadataManagerAdapter.listIDsOfType(String)

listIDs

public List<String> listIDs()

Delegation, see linked method for relevant documentation.

Returns:

See Also:

• MCRXMLMetadataManagerAdapter.listIDs()

getObjectTypes

public Collection<String> getObjectTypes()

Delegation, see linked method for relevant documentation.

Returns:

See Also:

• MCRXMLMetadataManagerAdapter.getObjectTypes()

getObjectBaseIds

public Collection<String> getObjectBaseIds()

Delegation, see linked method for relevant documentation.

Returns:

See Also:

• MCRXMLMetadataManagerAdapter.getObjectBaseIds()

retrieveObjectDates

public List<MCRObjectIDDate> retrieveObjectDates(List<String> ids)
                                          throws IOException

Delegation, see linked method for relevant documentation.

Parameters:

ids -

Throws:

IOException

See Also:

• MCRXMLMetadataManagerAdapter.retrieveObjectDates(List)

getLastModified

public long getLastModified(MCRObjectID id)
                     throws IOException

Delegation, see linked method for relevant documentation.

Parameters:

id -

Returns:

Throws:

IOException

See Also:

• MCRXMLMetadataManagerAdapter.getLastModified(MCRObjectID)

getLastModifiedHandle

public MCRCache.ModifiedHandle getLastModifiedHandle(MCRObjectID id,
 long expire,
 TimeUnit unit)

Delegation, see linked method for relevant documentation.

Parameters:

id -

expire -

unit -

Returns:

See Also:

• MCRXMLMetadataManagerAdapter.getLastModifiedHandle(MCRObjectID, long, TimeUnit)

create

public void create(MCRObjectID mcrid,
 Document xml,
 Date lastModified)
            throws MCRPersistenceException

Stores metadata of a new MCRObject in the persistent store.

Parameters:

mcrid - the MCRObjectID

xml - the xml metadata of the MCRObject

lastModified - the date of last modification to set

Throws:

MCRPersistenceException - the object couldn't be created due persistence problems

create

public void create(MCRObjectID mcrid,
 byte[] xml,
 Date lastModified)
            throws MCRPersistenceException

Stores metadata of a new MCRObject in the persistent store.

Parameters:

mcrid - the MCRObjectID

xml - the xml metadata of the MCRObject

lastModified - the date of last modification to set

Throws:

MCRPersistenceException - the object couldn't be created due persistence problems

delete

public void delete(String mcrid)
            throws MCRPersistenceException

Throws:

MCRPersistenceException

update

public void update(MCRObjectID mcrid,
 Document xml,
 Date lastModified)
            throws MCRPersistenceException

Updates metadata of existing MCRObject in the persistent store.

Parameters:

mcrid - the MCRObjectID

xml - the xml metadata of the MCRObject

lastModified - the date of last modification to set

Throws:

MCRPersistenceException - the object couldn't be updated due persistence problems

createOrUpdate

public void createOrUpdate(MCRObjectID mcrid,
 Document xml,
 Date lastModified)
                    throws MCRPersistenceException

Creates or updates metadata of a MCRObject in the persistent store.

Parameters:

mcrid - the MCRObjectID

xml - the xml metadata of the MCRObject

lastModified - the date of last modification to set

Throws:

MCRPersistenceException - the object couldn't be created or updated due persistence problems

update

public void update(MCRObjectID mcrid,
 byte[] xml,
 Date lastModified)
            throws MCRPersistenceException

Updates metadata of existing MCRObject in the persistent store.

Parameters:

mcrid - the MCRObjectID

xml - the xml metadata of the MCRObject

lastModified - the date of last modification to set

Throws:

MCRPersistenceException - the object couldn't be updated due persistence problems

retrieveXML

public Document retrieveXML(MCRObjectID mcrid)
                     throws IOException,
JDOMException,
SAXException

Retrieves stored metadata xml as JDOM document

Parameters:

mcrid - the MCRObjectID

Returns:

null if metadata is not present

Throws:

IOException

JDOMException

SAXException

retrieveBLOB

public byte[] retrieveBLOB(MCRObjectID mcrid)
                    throws IOException

Retrieves stored metadata xml as byte[] BLOB.

Parameters:

mcrid - the MCRObjectID

Returns:

null if metadata is not present

Throws:

IOException

listObjectDates

public List<MCRObjectIDDate> listObjectDates()
                                      throws IOException

Lists all objects with their last modification dates.

Returns:

List of MCRObjectIDDate

Throws:

IOException

listObjectDates

public List<MCRObjectIDDate> listObjectDates(String type)
                                      throws IOException

Lists all objects of the specified type and their last modified date.

Parameters:

type - type of object

Throws:

IOException

getLastModified

public long getLastModified()

Returns the time the store's content was last modified

Returns:

Last modification date of the MyCoRe system