de.ipk_gatersleben.bit.bi.edal.primary_data.file

Class PrimaryDataEntity

java.lang.Object

de.ipk_gatersleben.bit.bi.edal.primary_data.file.PrimaryDataEntity

All Implemented Interfaces:

Comparable<PrimaryDataEntity>

Direct Known Subclasses:

PrimaryDataDirectory, PrimaryDataFile

public abstract class PrimaryDataEntity
extends Object
implements Comparable<PrimaryDataEntity>

Abstract PrimaryDataEntity class.

Super class for PrimaryDataDirectory and PrimaryDataFile.

Author:

lange, arendd

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	PrimaryDataEntity() Constructor for PrimaryDataEntity.
protected	PrimaryDataEntity(PrimaryDataDirectory path, String name) Construct a PrimaryDataEntity object.

Method Summary

Methods

Modifier and Type	Method and Description
void	addPublicReference(PersistentIdentifier identifierType) Add a public identifier to the currentVersion of this PrimaryDataEntity.
protected void	commitVersion(PrimaryDataEntityVersion version) Internal function to commit a PrimaryDataEntityVersion to the storage back-end.
int	compareTo(PrimaryDataEntity other) Compares PrimaryDataEntity based on toLowerCase(getName());
void	delete() Delete the PrimaryDataEntity object by generation of new PrimaryDataEntityVersion and set the isDeleted flag to true.
boolean	equals(Object obj)
PrimaryDataEntityVersion	getCurrentVersion() Getter for the current PrimaryDataEntityVersion.
String	getID() Getter for the ID of this PrimaryDataEntity.
protected ImplementationProvider	getImplementationProvider() Getter for the current ImplementationProvider.
MetaData	getMetaData() Getter for the MetaData object of the current PrimaryDataEntityVersion of this PrimaryDataEntity.
String	getName() Getter for the name of this PrimaryDataEntity .
PrimaryDataDirectory	getParentDirectory() Getter for the parent PrimaryDataDirectory of this PrimaryDataEntity .
String	getPath() Getter for the path of this PrimaryDataEntity as String.
Map<Principal,List<de.ipk_gatersleben.bit.bi.edal.primary_data.security.EdalPermission>>	getPermissions() Getter for a List containing all EdalPermission objects.
protected abstract Map<Principal,List<de.ipk_gatersleben.bit.bi.edal.primary_data.security.EdalPermission>>	getPermissionsImpl() Abstract function for implementation of getPermissions().
List<PublicReference>	getPublicReferences() Getter for a List of all stored PublicReferences of the current PrimaryDataEntityVersion of this PrimaryDataEntity.
protected Subject	getSubject() Getter for the current Subject.
PrimaryDataEntityVersion	getVersionByDate(Calendar date) Convenience function to get a PrimaryDataEntityVersion of this PrimaryDataEntity by the revision date.
PrimaryDataEntityVersion	getVersionByRevisionNumber(long revisionNumber) Convenience function to get a PrimaryDataEntityVersion of this PrimaryDataEntity by the revision number.
SortedSet<PrimaryDataEntityVersion>	getVersions() Getter for a SortedSet containing all PrimaryDataEntityVersion objects of this PrimaryDataEntity.
protected abstract SortedSet<PrimaryDataEntityVersion>	getVersionsImpl() Abstract function for implementation of getVersions().
void	grantPermission(Principal principal, GrantableMethods.Methods method) Grant a EdalPermission to a Principal and check before grant if the method exists.
int	hashCode()
boolean	isDirectory() Check if the PrimaryDataEntity is a PrimaryDataDirectory or not.
void	move(PrimaryDataDirectory destinationDirectory) Move this PrimaryDataEntity to another PrimaryDataDirectory.
protected abstract void	moveImpl(PrimaryDataDirectory destinationDirectory) Abstract function for implementation of move(PrimaryDataDirectory).
protected UntypedData	reloadOldDataType(EnumDublinCoreElements element) Internal function to reload a data type of the old MetaData for the current version, after the user set a wrong value.
void	rename(String name) Rename the current PrimaryDataEntity.
void	revokePermission(Principal principal, GrantableMethods.Methods method) Revoke a EdalPermission to a Principal and check before revoke if the method exists.
protected void	setCurrentVersion(PrimaryDataEntityVersion version) Setter for the current PrimaryDataEntityVersion.
protected void	setDefaultPermissions() Set initial and default EdalPermission for this PrimaryDataEntity.
protected void	setID(String id) Setter for the ID of the current PrimaryDataEntity
void	setMetaData(MetaData newMetadata) Setter for the MetaData object of this PrimaryDataEntity object.
protected void	setParentDirectory(PrimaryDataDirectory parentDirectory) Setter for the parent PrimaryDataDirectory of this PrimaryDataEntity.
protected abstract void	storeVersion(PrimaryDataEntityVersion newVersion) Abstract function for storing a new PrimaryDataEntityVersion for an PrimaryDataEntity object.
void	switchCurrentVersion(PrimaryDataEntityVersion version) Switch the current PrimaryDataEntityVersion with this PrimaryDataEntityVersion.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

PrimaryDataEntity

protected PrimaryDataEntity()

Constructor for PrimaryDataEntity.

PrimaryDataEntity

protected PrimaryDataEntity(PrimaryDataDirectory path,
                 String name)
                     throws PrimaryDataEntityVersionException,
                            PrimaryDataDirectoryException,
                            MetaDataException

Construct a PrimaryDataEntity object. Set the PrimaryDataEntityVersion to the latest one.

If it is an initial PrimaryDataEntityVersion , a new default MetaData object is instantiated

Parameters:

name - the name for this object

path - the parent PrimaryDataDirectory of this PrimaryDataEntity.

Throws:

PrimaryDataEntityVersionException - if unable to set current PrimaryDataEntityVersion.

PrimaryDataDirectoryException - if no parent PrimaryDataDirectory is found.

MetaDataException - if the MetaData object of the parent PrimaryDataDirectory is not clone-able.

Method Detail

addPublicReference

public void addPublicReference(PersistentIdentifier identifierType)
                        throws PrimaryDataEntityException

Add a public identifier to the currentVersion of this PrimaryDataEntity.

Parameters:

identifierType - the type of the new Identifier.

Throws:

PrimaryDataEntityException - if unable to add the PublicReference to this PrimaryDataEntity.

commitVersion

protected void commitVersion(PrimaryDataEntityVersion version)
                      throws PrimaryDataEntityVersionException

Internal function to commit a PrimaryDataEntityVersion to the storage back-end. Use the CREATED EdalDate of the current PrimaryDataEntityVersion and remove the UPDATED EdalDate to add a new one.

Parameters:

version - the PrimaryDataEntityVersion to store.

Throws:

PrimaryDataEntityVersionException - if unable to store the PrimaryDataEntityVersion.

compareTo

public int compareTo(PrimaryDataEntity other)

Compares PrimaryDataEntity based on toLowerCase(getName());

Specified by:

compareTo in interface Comparable<PrimaryDataEntity>

delete

public final void delete()
                  throws PrimaryDataEntityVersionException,
                         PrimaryDataDirectoryException

Delete the PrimaryDataEntity object by generation of new PrimaryDataEntityVersion and set the isDeleted flag to true.

NOTE: It is not allowed delete the root PrimaryDataDirectory!

NOTE: It is not allowed delete a non-current PrimaryDataEntityVersion!

Throws:

PrimaryDataEntityVersionException - if trying to delete the root PrimaryDataDirectory

PrimaryDataDirectoryException - if trying to delete a non-current PrimaryDataEntityVersion.

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

getCurrentVersion

public PrimaryDataEntityVersion getCurrentVersion()

Getter for the current PrimaryDataEntityVersion.

Returns:

the currently set PrimaryDataEntityVersion

getID

public String getID()

Getter for the ID of this PrimaryDataEntity.

Returns:

the ID of this PrimaryDataEntity

See Also:

UUID

getImplementationProvider

protected ImplementationProvider getImplementationProvider()

Getter for the current ImplementationProvider.

Returns:

the ImplementationProvider from current thread

getMetaData

public MetaData getMetaData()

Getter for the MetaData object of the current PrimaryDataEntityVersion of this PrimaryDataEntity.

Returns:

MetaData object of the current PrimaryDataEntityVersion of this PrimaryDataEntity.

getName

public final String getName()

Getter for the name of this PrimaryDataEntity .

Returns:

the file name as delegator to

 this.getMetaData().getElementValue(EnumDublinCoreElements.TITLE)
 

getParentDirectory

public PrimaryDataDirectory getParentDirectory()
                                        throws PrimaryDataDirectoryException

Getter for the parent PrimaryDataDirectory of this PrimaryDataEntity .

NOTE: It is not allowed to access the parent PrimaryDataDirectory of the root PrimaryDataDirectory!

Returns:

the parent PrimaryDataDirectory of this PrimaryDataEntity.

Throws:

PrimaryDataDirectoryException - if trying to access the parent PrimaryDataDirectory of the root PrimaryDataDirectory.

getPath

public String getPath()

Getter for the path of this PrimaryDataEntity as String.

Returns:

the complete path of the PrimaryDataEntity object as String

getPermissions

public Map<Principal,List<de.ipk_gatersleben.bit.bi.edal.primary_data.security.EdalPermission>> getPermissions()
                                                                                                        throws PrimaryDataEntityException

Getter for a List containing all EdalPermission objects.

Returns:

an unmodifiable List containing all EdalPermission

Throws:

PrimaryDataEntityException - if unable to load all permissions.

getPermissionsImpl

protected abstract Map<Principal,List<de.ipk_gatersleben.bit.bi.edal.primary_data.security.EdalPermission>> getPermissionsImpl()
                                                                                                                        throws PrimaryDataEntityException

Abstract function for implementation of getPermissions().

Returns:

an unmodifiable List containing all EdalPermission

Throws:

PrimaryDataEntityException - if unable to load all permissions.

getPublicReferences

public List<PublicReference> getPublicReferences()

Getter for a List of all stored PublicReferences of the current PrimaryDataEntityVersion of this PrimaryDataEntity.

Returns:

a List with all stored PublicReferences of the current PrimaryDataEntityVersion of this PrimaryDataEntity.

getSubject

protected Subject getSubject()

Getter for the current Subject.

Returns:

the Subject from current thread.

getVersionByDate

public PrimaryDataEntityVersion getVersionByDate(Calendar date)
                                          throws PrimaryDataEntityVersionException

Convenience function to get a PrimaryDataEntityVersion of this PrimaryDataEntity by the revision date.

Parameters:

date - the date of the PrimaryDataEntityVersion

Returns:

the specified PrimaryDataEntityVersion

Throws:

PrimaryDataEntityVersionException - if there are only older PrimaryDataEntityVersion stored for this PrimaryDataEntity

getVersionByRevisionNumber

public PrimaryDataEntityVersion getVersionByRevisionNumber(long revisionNumber)
                                                    throws PrimaryDataEntityVersionException

Convenience function to get a PrimaryDataEntityVersion of this PrimaryDataEntity by the revision number.

Parameters:

revisionNumber - the number of the PrimaryDataEntityVersion

Returns:

the specified PrimaryDataEntityVersion

Throws:

PrimaryDataEntityVersionException - if there is no PrimaryDataEntityVersion with this version stored.

getVersions

public SortedSet<PrimaryDataEntityVersion> getVersions()

Getter for a SortedSet containing all PrimaryDataEntityVersion objects of this PrimaryDataEntity.

Returns:

an unmodifiable SortedSet containing all PrimaryDataEntity

getVersionsImpl

protected abstract SortedSet<PrimaryDataEntityVersion> getVersionsImpl()

Abstract function for implementation of getVersions().

Returns:

an unmodifiable SortedSet containing all PrimaryDataEntity.

grantPermission

public void grantPermission(Principal principal,
                   GrantableMethods.Methods method)
                     throws PrimaryDataEntityException

Grant a EdalPermission to a Principal and check before grant if the method exists.

Parameters:

principal - to grant this method

method - Enum for a the method

Throws:

PrimaryDataEntityException - if can not found method to grant.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

isDirectory

public boolean isDirectory()

Check if the PrimaryDataEntity is a PrimaryDataDirectory or not.

Returns:

true when it is a PrimaryDataDirectory;
false otherwise.

move

public void move(PrimaryDataDirectory destinationDirectory)
          throws PrimaryDataDirectoryException

Move this PrimaryDataEntity to another PrimaryDataDirectory.

NOTE: It is not allowed to move the root PrimaryDataDirectory!

Parameters:

destinationDirectory - the new parent PrimaryDataDirectory for this PrimaryDataEntity.

Throws:

PrimaryDataDirectoryException - if trying to move the root PrimaryDataDirectory.

moveImpl

protected abstract void moveImpl(PrimaryDataDirectory destinationDirectory)

Abstract function for implementation of move(PrimaryDataDirectory).

Parameters:

destinationDirectory - the new PrimaryDataDirectory for this PrimaryDataEntity.

rename

public final void rename(String name)
                  throws PrimaryDataEntityVersionException,
                         PrimaryDataDirectoryException

Rename the current PrimaryDataEntity.

NOTE: Can not rename if another PrimaryDataEntity with this name already exists!

Parameters:

name - the new name for this PrimaryDataEntity.

Throws:

PrimaryDataEntityVersionException - if unable to set the new PrimaryDataEntityVersion.

PrimaryDataDirectoryException - if an PrimaryDataEntity with this name already exists.

revokePermission

public void revokePermission(Principal principal,
                    GrantableMethods.Methods method)
                      throws PrimaryDataEntityException

Revoke a EdalPermission to a Principal and check before revoke if the method exists.

NOTE: Can not revoke grantPermission(Principal, de.ipk_gatersleben.bit.bi.edal.aspectj.security.GrantableMethods.Methods) method for your own PrimaryDataEntity!

Parameters:

principal - to revoke this method.

method - Enum for a the method.

Throws:

PrimaryDataEntityException - if trying to revoke the EdalPermission for grantPermission(Principal, de.ipk_gatersleben.bit.bi.edal.aspectj.security.GrantableMethods.Methods) of your own PrimaryDataEntity.

setCurrentVersion

protected void setCurrentVersion(PrimaryDataEntityVersion version)

Setter for the current PrimaryDataEntityVersion.

Parameters:

version - the new current PrimaryDataEntityVersion object.

setDefaultPermissions

protected final void setDefaultPermissions()
                                    throws PrimaryDataEntityException

Set initial and default EdalPermission for this PrimaryDataEntity.

Throws:

PrimaryDataEntityException - if unable to set the permissions.

setID

protected void setID(String id)

Setter for the ID of the current PrimaryDataEntity

Parameters:

id - the ID to set

reloadOldDataType

protected UntypedData reloadOldDataType(EnumDublinCoreElements element)
                                 throws MetaDataException

Internal function to reload a data type of the old MetaData for the current version, after the user set a wrong value.

Parameters:

element - the Element to reload from the old MetaData

Returns:

the original value of the given element.

Throws:

MetaDataException - if unable to reload the old MetaData.

setMetaData

public void setMetaData(MetaData newMetadata)
                 throws PrimaryDataEntityVersionException,
                        MetaDataException

Setter for the MetaData object of this PrimaryDataEntity object. Create a new PrimaryDataEntityVersion with a new MetaData set.

Parameters:

newMetadata - the new MetaData object to set.

Throws:

PrimaryDataEntityVersionException - if unable to store PrimaryDataEntityVersion.

MetaDataException - if there are non valid value for element in the MetaData object.

setParentDirectory

protected void setParentDirectory(PrimaryDataDirectory parentDirectory)

Setter for the parent PrimaryDataDirectory of this PrimaryDataEntity.

Parameters:

parentDirectory - the parent PrimaryDataDirectory to set

storeVersion

protected abstract void storeVersion(PrimaryDataEntityVersion newVersion)
                              throws PrimaryDataEntityVersionException

Abstract function for storing a new PrimaryDataEntityVersion for an PrimaryDataEntity object.

Parameters:

newVersion - the new PrimaryDataEntityVersion to store.

Throws:

PrimaryDataEntityVersionException - if unable to store PrimaryDataEntityVersion.

switchCurrentVersion

public void switchCurrentVersion(PrimaryDataEntityVersion version)
                          throws PrimaryDataEntityVersionException

Switch the current PrimaryDataEntityVersion with this PrimaryDataEntityVersion.

NOTE: Can not switch when the current PrimaryDataEntityVersion is marked as deleted !

NOTE: Can not switch when the PrimaryDataEntityVersion not in the SortedSet of this PrimaryDataEntity !

Parameters:

version - the new PrimaryDataEntityVersion to set as current PrimaryDataEntityVersion.

Throws:

PrimaryDataEntityVersionException - if requested PrimaryDataEntityVersion is not available or marked as deleted.

toString

public String toString()

Overrides:

toString in class Object