Package org.mycore.pi

Class MCRPIGenerator<T extends MCRPersistentIdentifier>

java.lang.Object

org.mycore.pi.MCRPIGenerator<T>

Direct Known Subclasses:

MCRCreateDateDOIGenerator, MCRDNBURNGenerator, MCRGenericPIGenerator, MCRIDPURLGenerator, MCRMapObjectIDDOIGenerator, MCRStaticDOIGenerator, MCRUUIDDOIGenerator

public abstract class MCRPIGenerator<T extends MCRPersistentIdentifier>
extends Object

Constructor Summary

Constructors

Constructor	Description
MCRPIGenerator()

Method Summary

Modifier and Type	Method	Description
protected void	checkPropertyExists(String propertyName)	checks if the property exists and throws a exception if not.
abstract T	generate(MCRBase mcrBase, String additional)	generates a MCRPersistentIdentifier
String	getGeneratorID()
final Map<String,String>	getProperties()
void	init(String property)
void	setProperties(Map<String,String> properties)

Methods inherited from class java.lang.Object

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

Constructor Details

MCRPIGenerator

public MCRPIGenerator()

Method Details

getProperties

public final Map<String,String> getProperties()

init

public void init(String property)

setProperties

public void setProperties(Map<String,String> properties)

generate

public abstract T generate(MCRBase mcrBase,
 String additional)
                    throws MCRPersistentIdentifierException

generates a MCRPersistentIdentifier

Parameters:

mcrBase - the mycore object for which the identifier is generated

additional - additional information dedicated to the object like a mcrpath

Returns:

a unique persistence identifier

Throws:

MCRPersistentIdentifierException - if something goes wrong while generating

checkPropertyExists

protected void checkPropertyExists(String propertyName)
                            throws MCRConfigurationException

checks if the property exists and throws a exception if not.

Parameters:

propertyName - to check

Throws:

MCRConfigurationException - if property does not exist

getGeneratorID

public String getGeneratorID()