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

Class PrimaryDataFileImplementation

java.lang.Object

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

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

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

All Implemented Interfaces:

java.lang.Comparable<PrimaryDataEntity>

@Entity
public class PrimaryDataFileImplementation
extends PrimaryDataFile

Implementation of PrimaryDataFile.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	PrimaryDataFileImplementation() Default constructor for PrimaryDataFileImplementation is necessary for PojoInstantiator of HIBERNATE.
	PrimaryDataFileImplementation(PrimaryDataDirectory path, java.lang.String name) Constructor for PrimaryDataFileImplementation.

Method Summary

Modifier and Type	Method and Description
protected boolean	existData() Abstract function to check if the current PrimaryDataEntityVersion of this PrimaryDataFile has stored data.
java.lang.String	getID() Getter for the ID of this PrimaryDataEntity.
PrimaryDataDirectoryImplementation	getParentDirectory() Getter for the parent PrimaryDataDirectory of this PrimaryDataEntity .
protected java.nio.file.Path	getPathToLocalFile(PrimaryDataEntityVersion version) Load the Path to the local stored file from the file system.
protected java.util.Map<java.security.Principal,java.util.List<EdalPermission>>	getPermissionsImpl() Abstract function for implementation of PrimaryDataEntity.getPermissions().
protected java.util.SortedSet<PrimaryDataEntityVersionImplementation>	getVersionList() Getter for the field versionList.
protected java.util.SortedSet<PrimaryDataEntityVersion>	getVersionsImpl() Abstract function for implementation of PrimaryDataEntity.getVersions().
protected void	moveImpl(PrimaryDataDirectory destinationDirectory) Abstract function for implementation of PrimaryDataEntity.move(PrimaryDataDirectory).
protected void	readImpl(java.io.OutputStream outputStream) Abstract function for implementation the PrimaryDataFile.read(OutputStream) function.
protected void	setVersionList(java.util.SortedSet<PrimaryDataEntityVersionImplementation> versionList) Setter for the field versionList.
protected void	storeImpl(java.io.InputStream inputStream, PrimaryDataEntityVersion currentVersion) Abstract function for implementation the PrimaryDataFile.store(InputStream) function.
protected void	storeVersion(PrimaryDataEntityVersion publicVersion) Abstract function for storing a new PrimaryDataEntityVersion for an PrimaryDataEntity object.

Methods inherited from class de.ipk_gatersleben.bit.bi.edal.primary_data.file.PrimaryDataFile

read, setMetaData, store

Methods inherited from class de.ipk_gatersleben.bit.bi.edal.primary_data.file.PrimaryDataEntity

addPublicReference, commitVersion, compareTo, delete, equals, getCurrentVersion, getImplementationProvider, getMetaData, getName, getPath, getPermissions, getPublicReferences, getSubject, getVersionByDate, getVersionByRevisionNumber, getVersions, grantPermission, hashCode, isDirectory, move, reloadOldDataType, rename, revokePermission, setCurrentVersion, setDefaultPermissions, setID, setParentDirectory, switchCurrentVersion, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

PrimaryDataFileImplementation

protected PrimaryDataFileImplementation()

Default constructor for PrimaryDataFileImplementation is necessary for PojoInstantiator of HIBERNATE.

PrimaryDataFileImplementation

public PrimaryDataFileImplementation(PrimaryDataDirectory path,
                                     java.lang.String name)
                              throws PrimaryDataFileException,
                                     PrimaryDataEntityVersionException,
                                     PrimaryDataDirectoryException,
                                     MetaDataException

Constructor for PrimaryDataFileImplementation.

Parameters:

path - a PrimaryDataDirectory object.

name - a String object.

Throws:

PrimaryDataFileException - if unable to set data type.

PrimaryDataEntityVersionException - if unable to store initial version.

PrimaryDataDirectoryException - if no parent PrimaryDataDirectory is found.

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

Method Detail

existData

protected boolean existData()

Abstract function to check if the current PrimaryDataEntityVersion of this PrimaryDataFile has stored data.

Specified by:

existData in class PrimaryDataFile

Returns:

true if the current PrimaryDataEntityVersion has stored data;false otherwise.

getID

public java.lang.String getID()

Getter for the ID of this PrimaryDataEntity.

HIBERNATE : constant length cause it is an UUID

Overrides:

getID in class PrimaryDataEntity

Returns:

the ID of this PrimaryDataEntity

See Also:

UUID

getParentDirectory

public PrimaryDataDirectoryImplementation 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!

HIBERNATE : FetchType.EAGER for getPath()

Overrides:

getParentDirectory in class PrimaryDataEntity

Returns:

the parent PrimaryDataDirectory of this PrimaryDataEntity.

Throws:

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

getPathToLocalFile

protected java.nio.file.Path getPathToLocalFile(PrimaryDataEntityVersion version)

Load the Path to the local stored file from the file system.

Parameters:

version - the version information to find the correct Path to the local stored File.

Returns:

the loaded File.

getPermissionsImpl

protected java.util.Map<java.security.Principal,java.util.List<EdalPermission>> getPermissionsImpl()
                                                                                            throws PrimaryDataEntityException

Abstract function for implementation of PrimaryDataEntity.getPermissions().

Specified by:

getPermissionsImpl in class PrimaryDataEntity

Returns:

an unmodifiable List containing all EdalPermission

Throws:

PrimaryDataEntityException - if unable to load all permissions.

getVersionList

protected java.util.SortedSet<PrimaryDataEntityVersionImplementation> getVersionList()

Getter for the field versionList.

Returns:

a SortedSet object.

getVersionsImpl

protected java.util.SortedSet<PrimaryDataEntityVersion> getVersionsImpl()

Abstract function for implementation of PrimaryDataEntity.getVersions().

Specified by:

getVersionsImpl in class PrimaryDataEntity

Returns:

an unmodifiable SortedSet containing all PrimaryDataEntity.

moveImpl

protected void moveImpl(PrimaryDataDirectory destinationDirectory)

Abstract function for implementation of PrimaryDataEntity.move(PrimaryDataDirectory).

Specified by:

moveImpl in class PrimaryDataEntity

Parameters:

destinationDirectory - the new PrimaryDataDirectory for this PrimaryDataEntity.

readImpl

protected void readImpl(java.io.OutputStream outputStream)
                 throws PrimaryDataFileException

Abstract function for implementation the PrimaryDataFile.read(OutputStream) function.

Specified by:

readImpl in class PrimaryDataFile

Parameters:

outputStream - the loaded data.

Throws:

PrimaryDataFileException - if no data is stored.

setVersionList

protected void setVersionList(java.util.SortedSet<PrimaryDataEntityVersionImplementation> versionList)

Setter for the field versionList.

Parameters:

versionList - a SortedSet object.

storeImpl

protected void storeImpl(java.io.InputStream inputStream,
                         PrimaryDataEntityVersion currentVersion)
                  throws PrimaryDataFileException

Abstract function for implementation the PrimaryDataFile.store(InputStream) function.

Specified by:

storeImpl in class PrimaryDataFile

Parameters:

inputStream - the data to store in this PrimaryDataEntityVersion

currentVersion - the new PrimaryDataEntityVersion to store

Throws:

PrimaryDataFileException - if storing of data fails

storeVersion

protected void storeVersion(PrimaryDataEntityVersion publicVersion)
                     throws PrimaryDataEntityVersionException

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

Specified by:

storeVersion in class PrimaryDataEntity

Parameters:

publicVersion - the new PrimaryDataEntityVersion to store.

Throws:

PrimaryDataEntityVersionException - if unable to store PrimaryDataEntityVersion.