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

Class PrimaryDataDirectoryImplementation

java.lang.Object

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

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

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

All Implemented Interfaces:

java.lang.Comparable<PrimaryDataEntity>

@Entity
public class PrimaryDataDirectoryImplementation
extends PrimaryDataDirectory

Implementation of PrimaryDataDirectory.

Field Summary

Fields inherited from class de.ipk_gatersleben.bit.bi.edal.primary_data.file.PrimaryDataDirectory

PATH_SEPARATOR

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
boolean	existImpl(java.lang.String path) Abstract function for implementation of PrimaryDataDirectory.exist(String)
java.lang.String	getID() Getter for the ID of this PrimaryDataEntity.
PrimaryDataDirectoryImplementation	getParentDirectory() Getter for the parent PrimaryDataDirectory of this PrimaryDataEntity .
protected java.util.Map<java.security.Principal,java.util.List<EdalPermission>>	getPermissionsImpl() Abstract function for implementation of PrimaryDataEntity.getPermissions().
protected PrimaryDataEntity	getPrimaryDataEntityImpl(java.lang.String name) Abstract function for the implementation of PrimaryDataDirectory.getPrimaryDataEntity(String).
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 java.util.List<PrimaryDataEntity>	listPrimaryDataEntitiesImpl(java.util.Calendar currentVersionDate, java.util.Calendar nextVersionDate) Abstract function for the implementation of PrimaryDataDirectory.listPrimaryDataEntities().
protected void	moveImpl(PrimaryDataDirectory destinationDirectory) Abstract function for implementation of PrimaryDataEntity.move(PrimaryDataDirectory).
protected java.util.List<PrimaryDataEntity>	searchByDublinCoreElementImpl(EnumDublinCoreElements element, UntypedData data, boolean fuzzy, boolean recursiveIntoSubdirectories) Abstract function for implementation of PrimaryDataDirectory.searchByDublinCoreElement(EnumDublinCoreElements, UntypedData, boolean, boolean) .
protected java.util.List<? extends PrimaryDataEntity>	searchByKeywordImpl(java.lang.String keyword, boolean fuzzy, boolean recursiveIntoSubdirectories) Abstract function for the implementation of PrimaryDataDirectory.searchByKeyword(String, boolean, boolean)
protected java.util.List<PrimaryDataEntity>	searchByMetaDataImpl(MetaData query, boolean fuzzy, boolean recursiveIntoSubdirectories) Abstract function for implementation of PrimaryDataDirectory.searchByMetaData(MetaData, boolean, boolean) .
protected java.util.List<? extends PrimaryDataEntity>	searchByPublicationStatusImpl(PublicationStatus publicationStatus) Abstract function for the implementation of PrimaryDataDirectory.searchByPublicationStatus(PublicationStatus) .
protected void	setVersionList(java.util.SortedSet<PrimaryDataEntityVersionImplementation> versionList) Setter for the field versionList.
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.PrimaryDataDirectory

createPrimaryDataDirectory, createPrimaryDataFile, exist, getAllPublishedEntities, getPrimaryDataEntity, getRootDirectory, listPrimaryDataEntities, searchByDublinCoreElement, searchByKeyword, searchByMetaData, searchByPublicationStatus, setMetaData

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

PrimaryDataDirectoryImplementation

protected PrimaryDataDirectoryImplementation()

Default constructor for PrimaryDataDirectoryImplementation is necessary for PojoInstantiator of HIBERNATE.

PrimaryDataDirectoryImplementation

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

Constructor for PrimaryDataDirectoryImplementation.

Parameters:

path - a PrimaryDataDirectory object.

name - a String object.

Throws:

PrimaryDataEntityVersionException - if can not 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

existImpl

public boolean existImpl(java.lang.String path)
                  throws PrimaryDataDirectoryException

Abstract function for implementation of PrimaryDataDirectory.exist(String)

Specified by:

existImpl in class PrimaryDataDirectory

Parameters:

path - the name of the PrimaryDataEntity to check.

Returns:

true if there is already a PrimartyDataEntity with the same path;
false otherwise

Throws:

PrimaryDataDirectoryException - if unable to load all PrimaryDataEntity objects in this PrimaryDataDirectory to check if the name already exists.

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()

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.

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.

getPrimaryDataEntityImpl

protected PrimaryDataEntity getPrimaryDataEntityImpl(java.lang.String name)
                                              throws PrimaryDataDirectoryException

Abstract function for the implementation of PrimaryDataDirectory.getPrimaryDataEntity(String).

Specified by:

getPrimaryDataEntityImpl in class PrimaryDataDirectory

Parameters:

name - name of the PrimaryDataEntity in this PrimaryDataDirectory.

Returns:

the found PrimaryDataEntity object.

Throws:

PrimaryDataDirectoryException - if no such PrimaryDataEntity exists.

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.

listPrimaryDataEntitiesImpl

protected java.util.List<PrimaryDataEntity> listPrimaryDataEntitiesImpl(java.util.Calendar currentVersionDate,
                                                                        java.util.Calendar nextVersionDate)
                                                                 throws PrimaryDataDirectoryException

Abstract function for the implementation of PrimaryDataDirectory.listPrimaryDataEntities().

Specified by:

listPrimaryDataEntitiesImpl in class PrimaryDataDirectory

Parameters:

currentVersionDate - the date of the current PrimaryDataEntityVersion

nextVersionDate - the date of the next PrimaryDataEntityVersion

Returns:

a List containing all PrimaryDataEntity

Throws:

PrimaryDataDirectoryException - if unable to load all PrimaryDataEntity objects in this PrimaryDataDirectory.

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.

searchByDublinCoreElementImpl

protected java.util.List<PrimaryDataEntity> searchByDublinCoreElementImpl(EnumDublinCoreElements element,
                                                                          UntypedData data,
                                                                          boolean fuzzy,
                                                                          boolean recursiveIntoSubdirectories)
                                                                   throws PrimaryDataDirectoryException

Abstract function for implementation of PrimaryDataDirectory.searchByDublinCoreElement(EnumDublinCoreElements, UntypedData, boolean, boolean) .

Specified by:

searchByDublinCoreElementImpl in class PrimaryDataDirectory

Parameters:

element - the EnumDublinCoreElements for query

data - UntypedData parameter for search

fuzzy - true: exact search; false: fuzzy search

recursiveIntoSubdirectories - true: include also all sub directories recursively; false: search only in the current PrimaryDataDirectory object

Returns:

an unmodifiable List of PrimaryDataEntity that match the parameter

Throws:

PrimaryDataDirectoryException - if unable to find PrimaryDataEntity object or if there are too much results.

searchByKeywordImpl

protected java.util.List<? extends PrimaryDataEntity> searchByKeywordImpl(java.lang.String keyword,
                                                                          boolean fuzzy,
                                                                          boolean recursiveIntoSubdirectories)
                                                                   throws PrimaryDataDirectoryException

Description copied from class: PrimaryDataDirectory

Abstract function for the implementation of PrimaryDataDirectory.searchByKeyword(String, boolean, boolean)

Specified by:

searchByKeywordImpl in class PrimaryDataDirectory

Parameters:

keyword - the term to search over all elements.

fuzzy - true: fuzzy search; false: exact search

recursiveIntoSubdirectories - true: include also all sub PrimaryDataDirectory recursively; false search only in the current PrimaryDataDirectory object

Returns:

a unmodifiable List of PrimaryDataEntity that match the keyword.

Throws:

PrimaryDataDirectoryException - if unable to search for the keyword.

searchByMetaDataImpl

protected java.util.List<PrimaryDataEntity> searchByMetaDataImpl(MetaData query,
                                                                 boolean fuzzy,
                                                                 boolean recursiveIntoSubdirectories)
                                                          throws PrimaryDataDirectoryException,
                                                                 MetaDataException

Abstract function for implementation of PrimaryDataDirectory.searchByMetaData(MetaData, boolean, boolean) .

Specified by:

searchByMetaDataImpl in class PrimaryDataDirectory

Parameters:

query - a MetaData object.

fuzzy - true: fuzzy search; false: exact search

recursiveIntoSubdirectories - true: include also all sub PrimaryDataDirectory recursively; false search only in the current PrimaryDataDirectory object

Returns:

a unmodifiable List of PrimaryDataEntity that match the MetaData parameter

Throws:

PrimaryDataDirectoryException - if unable to find PrimaryDataEntity object or if there are too much results.

MetaDataException - if there are non valid values for some MetaData elements.

searchByPublicationStatusImpl

protected java.util.List<? extends PrimaryDataEntity> searchByPublicationStatusImpl(PublicationStatus publicationStatus)
                                                                             throws PrimaryDataDirectoryException

Abstract function for the implementation of PrimaryDataDirectory.searchByPublicationStatus(PublicationStatus) .

Specified by:

searchByPublicationStatusImpl in class PrimaryDataDirectory

Parameters:

publicationStatus - the PublicationStatus of the searched PrimaryDataEntity.

Returns:

a List of all PrimaryDataEntity with a PublicReference.

Throws:

PrimaryDataDirectoryException - if unable to search for PublicationStatus

setVersionList

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

Setter for the field versionList.

Parameters:

versionList - a SortedSet object.

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.