Package org.mycore.datamodel.metadata

Class MCRMetadataManager

java.lang.Object

org.mycore.datamodel.metadata.MCRMetadataManager

public final class MCRMetadataManager
extends Object

Delivers persistence operations for MCRObject and MCRDerivate .

Since:

2.0.92

Author:

Thomas Scheffler (yagee)

Method Summary

Modifier and Type	Method	Description
static boolean	addOrUpdateDerivateToObject(MCRObjectID id, MCRMetaEnrichedLinkID link)	Adds or updates a derivate MCRMetaLinkID to the structure part and updates the object with the ID in the data store.
static void	create(MCRDerivate mcrDerivate)	Stores the derivate.
static void	create(MCRObject mcrObject)	Stores the object.
static void	delete(MCRDerivate mcrDerivate)	Deletes MCRDerivate.
static void	delete(MCRObject mcrObject)	Deletes MCRObject.
static void	deleteMCRDerivate(MCRObjectID id)	Delete the derivate.
static void	deleteMCRObject(MCRObjectID id)	Deletes the object.
static boolean	exists(MCRObjectID id)	Tells if the object or derivate with id exists.
static void	fireRepairEvent(MCRBase mcrBaseObj)	Fires MCREvent.EventType.REPAIR for given object.
static void	fireRepairEvent(MCRDerivate mcrDerivate)	Fires MCREvent.EventType.REPAIR for given derivate.
static void	fireRepairEvent(MCRObject mcrObject)	Fires MCREvent.EventType.REPAIR for given object.
static void	fireUpdateEvent(MCRObject mcrObject)	Fires MCREvent.EventType.UPDATE for given object.
static List<MCRObjectID>	getDerivateIds(MCRObjectID objectId, long expire, TimeUnit unit)	Returns a list of MCRObjectID of the derivates contained in the object with the given ID.
static MCRObjectID	getObjectId(MCRObjectID derivateID, long expire, TimeUnit unit)	Returns the MCRObjectID of the object containing derivate with the given ID.
static boolean	removeDerivateFromObject(MCRObjectID objectID, MCRObjectID derivateID)
static MCRBase	retrieve(MCRObjectID id)	Retrieves an instance of MCRObject or MCRDerivate depending on MCRObjectID.getTypeId()
static MCRDerivate	retrieveMCRDerivate(MCRObjectID id)	Retrieves instance of MCRDerivate with the given MCRObjectID
static MCRObject	retrieveMCRObject(MCRObjectID id)	Retrieves an instance of MCRObject with the given MCRObjectID
static void	update(MCRBase base)	Updates the MCRObject or MCRDerivate.
static void	update(MCRDerivate mcrDerivate)	Updates the derivate or creates it if it does not exist yet.
static void	update(MCRObject mcrObject)	Updates the object or creates it if it does not exist yet.

Methods inherited from class java.lang.Object

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

Method Details

getObjectId

public static MCRObjectID getObjectId(MCRObjectID derivateID,
 long expire,
 TimeUnit unit)

Returns the MCRObjectID of the object containing derivate with the given ID.

Parameters:

derivateID - derivateID

expire - when should lastModified information expire

Returns:

null if derivateID has no object referenced

See Also:

• getDerivateIds(MCRObjectID, long, TimeUnit)

getDerivateIds

public static List<MCRObjectID> getDerivateIds(MCRObjectID objectId,
 long expire,
 TimeUnit unit)

Returns a list of MCRObjectID of the derivates contained in the object with the given ID.

Parameters:

objectId - objectId

expire - when should lastModified information expire

Returns:

null if object with objectId does not exist

See Also:

• getObjectId(MCRObjectID, long, TimeUnit)

create

public static void create(MCRDerivate mcrDerivate)
                   throws MCRPersistenceException,
MCRAccessException

Stores the derivate.

Parameters:

mcrDerivate - derivate instance to store

Throws:

MCRPersistenceException - if a persistence problem is occurred

MCRAccessException - if write permission to object is missing

create

public static void create(MCRObject mcrObject)
                   throws MCRPersistenceException,
MCRAccessException

Stores the object.

Parameters:

mcrObject - object instance to store

Throws:

MCRPersistenceException - if a persistence problem is occured

MCRAccessException - if "create-{objectType}" privilege is missing

delete

public static void delete(MCRDerivate mcrDerivate)
                   throws MCRPersistenceException,
MCRAccessException

Deletes MCRDerivate.

Parameters:

mcrDerivate - to be deleted

Throws:

MCRPersistenceException - if persistence problem occurs

MCRAccessException - if delete permission is missing

delete

public static void delete(MCRObject mcrObject)
                   throws MCRPersistenceException,
MCRActiveLinkException,
MCRAccessException

Deletes MCRObject.

Parameters:

mcrObject - to be deleted

Throws:

MCRActiveLinkException - cannot be deleted cause its still linked

MCRPersistenceException - if persistence problem occurs

MCRAccessException - if delete permission is missing

deleteMCRDerivate

public static void deleteMCRDerivate(MCRObjectID id)
                              throws MCRPersistenceException,
MCRAccessException

Delete the derivate. The order of delete steps is:

• remove link in object metadata
• remove all files from IFS
• remove derivate

Parameters:

id - the object ID

Throws:

MCRPersistenceException - if a persistence problem is occurred

MCRAccessException - if delete permission is missing

deleteMCRObject

public static void deleteMCRObject(MCRObjectID id)
                            throws MCRPersistenceException,
MCRActiveLinkException,
MCRAccessException

Deletes the object.

Throws:

MCRPersistenceException - if a persistence problem is occurred

MCRActiveLinkException - if object is referenced by other objects

MCRAccessException - if delete permission is missing

exists

public static boolean exists(MCRObjectID id)
                      throws MCRPersistenceException

Tells if the object or derivate with id exists.

Parameters:

id - the object ID

Throws:

MCRPersistenceException - the xml couldn't be read

fireRepairEvent

public static void fireRepairEvent(MCRDerivate mcrDerivate)
                            throws MCRPersistenceException

Fires MCREvent.EventType.REPAIR for given derivate.

Throws:

MCRPersistenceException

fireRepairEvent

public static void fireRepairEvent(MCRBase mcrBaseObj)
                            throws MCRPersistenceException

Fires MCREvent.EventType.REPAIR for given object.

Throws:

MCRPersistenceException

fireRepairEvent

public static void fireRepairEvent(MCRObject mcrObject)
                            throws MCRPersistenceException

Fires MCREvent.EventType.REPAIR for given object.

Throws:

MCRPersistenceException

fireUpdateEvent

public static void fireUpdateEvent(MCRObject mcrObject)
                            throws MCRPersistenceException

Fires MCREvent.EventType.UPDATE for given object. If MCRBase.isImportMode() modifydate will not be updated.

Parameters:

mcrObject - mycore object which is updated

Throws:

MCRPersistenceException

retrieveMCRDerivate

public static MCRDerivate retrieveMCRDerivate(MCRObjectID id)
                                       throws MCRPersistenceException

Retrieves instance of MCRDerivate with the given MCRObjectID

Parameters:

id - the derivate ID

Throws:

MCRPersistenceException - if a persistence problem is occurred

retrieveMCRObject

public static MCRObject retrieveMCRObject(MCRObjectID id)
                                   throws MCRPersistenceException

Retrieves an instance of MCRObject with the given MCRObjectID

Parameters:

id - the object ID

Throws:

MCRPersistenceException - if a persistence problem is occurred

retrieve

public static MCRBase retrieve(MCRObjectID id)
                        throws MCRPersistenceException

Retrieves an instance of MCRObject or MCRDerivate depending on MCRObjectID.getTypeId()

Parameters:

id - derivate or object id

Throws:

MCRPersistenceException - if a persistence problem is occurred

update

public static void update(MCRBase base)
                   throws MCRPersistenceException,
MCRAccessException

Updates the MCRObject or MCRDerivate.

Parameters:

base - the object to update

Throws:

MCRPersistenceException - if a persistence problem is occurred

MCRAccessException - if write permission is missing or see create(MCRObject)

update

public static void update(MCRDerivate mcrDerivate)
                   throws MCRPersistenceException,
MCRAccessException

Updates the derivate or creates it if it does not exist yet.

Throws:

MCRPersistenceException - if a persistence problem is occurred

MCRAccessException - if write permission to object or derivate is missing

update

public static void update(MCRObject mcrObject)
                   throws MCRPersistenceException,
MCRAccessException

Updates the object or creates it if it does not exist yet.

Throws:

MCRPersistenceException - if a persistence problem is occurred

MCRAccessException - if write permission is missing or see create(MCRObject)

addOrUpdateDerivateToObject

public static boolean addOrUpdateDerivateToObject(MCRObjectID id,
 MCRMetaEnrichedLinkID link)
                                           throws MCRPersistenceException

Adds or updates a derivate MCRMetaLinkID to the structure part and updates the object with the ID in the data store.

Parameters:

id - the object ID

link - a link to a derivate as MCRMetaLinkID

Returns:

True if the link is added or updated, false if nothing changed.

Throws:

MCRPersistenceException - if a persistence problem is occurred

removeDerivateFromObject

public static boolean removeDerivateFromObject(MCRObjectID objectID,
 MCRObjectID derivateID)
                                        throws MCRPersistenceException

Throws:

MCRPersistenceException