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

Class PrimaryDataDirectory

java.lang.Object

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

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

All Implemented Interfaces:

Comparable<PrimaryDataEntity>

public abstract class PrimaryDataDirectory
extends PrimaryDataEntity

Abstract PrimaryDataDirectory class.

Author:

lange, arendd

Field Summary

Fields

Modifier and Type	Field and Description
static String	PATH_SEPARATOR The standard path separator

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	PrimaryDataDirectory() Constructor for PrimaryDataDirectory.
protected	PrimaryDataDirectory(PrimaryDataDirectory path, String name) Constructor for PrimaryDataDirectory.

Method Summary

Methods

Modifier and Type	Method and Description
PrimaryDataDirectory	createPrimaryDataDirectory(String path) Create an new sub PrimaryDataDirectory in the current PrimaryDataDirectory .
PrimaryDataFile	createPrimaryDataFile(String name) Create an new PrimaryDataFile in the current PrimaryDataDirectory using the same implementation as this PrimaryDataDirectory .
boolean	exist(String path) Check if a PrimaryDataEntity exists with the same path in this PrimaryDataDirectory .
protected abstract boolean	existImpl(String path) Abstract function for implementation of exist(String)
List<PrimaryDataEntity>	getAllPublishedEntities() Convenience and free function to get only PrimaryDataEntitys with published PublicReference objects.
PrimaryDataEntity	getPrimaryDataEntity(String name) Get a specified PrimaryDataEntity in this PrimaryDataDirectory by name.
protected abstract PrimaryDataEntity	getPrimaryDataEntityImpl(String name) Abstract function for the implementation of getPrimaryDataEntity(String).
static PrimaryDataDirectory	getRootDirectory(List<Class<? extends Principal>> supportedPrincipals) The initial step to connect to a EDAL file service.
List<PrimaryDataEntity>	listPrimaryDataEntities() Get a List containing all PrimaryDataEntity objects in this PrimaryDataDirectory.
protected abstract List<PrimaryDataEntity>	listPrimaryDataEntitiesImpl(Calendar currentVersionDate, Calendar nextVersionDate) Abstract function for the implementation of listPrimaryDataEntities().
List<PrimaryDataEntity>	searchByDublinCoreElement(EnumDublinCoreElements element, UntypedData data, boolean fuzzy, boolean recursiveIntoSubdirectories) A convenience method for search only for a specific EnumDublinCoreElements and UntypedData in this PrimaryDataDirectory.
protected abstract List<PrimaryDataEntity>	searchByDublinCoreElementImpl(EnumDublinCoreElements element, UntypedData data, boolean fuzzy, boolean recursiveIntoSubdirectories) Abstract function for implementation of searchByDublinCoreElement(EnumDublinCoreElements, UntypedData, boolean, boolean) .
List<PrimaryDataEntity>	searchByKeyword(String keyword, boolean fuzzy, boolean recursiveIntoSubdirectories) Function to get all PrimaryDataEntitys containing the keyword.
protected abstract List<? extends PrimaryDataEntity>	searchByKeywordImpl(String keyword, boolean fuzzy, boolean recursiveIntoSubdirectories) Abstract function for the implementation of searchByKeyword(String, boolean, boolean)
List<PrimaryDataEntity>	searchByMetaData(MetaData query, boolean fuzzy, boolean recursiveIntoSubdirectories) The method search in the current PrimaryDataDirectory by MetaData.
protected abstract List<PrimaryDataEntity>	searchByMetaDataImpl(MetaData query, boolean fuzzy, boolean recursiveIntoSubdirectories) Abstract function for implementation of searchByMetaData(MetaData, boolean, boolean) .
List<PrimaryDataEntity>	searchByPublicationStatus(PublicationStatus publicationStatus) Function to get all PrimaryDataEntitys in this PrimaryDataDirectory, which have a PublicReference.
protected abstract List<? extends PrimaryDataEntity>	searchByPublicationStatusImpl(PublicationStatus publicationStatus) Abstract function for the implementation of searchByPublicationStatus(PublicationStatus) .
void	setMetaData(MetaData newMetadata) Setter for the MetaData object of this PrimaryDataEntity object.

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

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

Methods inherited from class java.lang.Object

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

Field Detail

PATH_SEPARATOR

public static final String PATH_SEPARATOR

The standard path separator

See Also:

Constant Field Values

Constructor Detail

PrimaryDataDirectory

protected PrimaryDataDirectory()

Constructor for PrimaryDataDirectory.

PrimaryDataDirectory

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

Constructor for PrimaryDataDirectory.

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 unable to set the MetaData object of the PrimaryDataDirectory.

Method Detail

getRootDirectory

public static PrimaryDataDirectory getRootDirectory(List<Class<? extends Principal>> supportedPrincipals)
                                             throws PrimaryDataDirectoryException

The initial step to connect to a EDAL file service.

NOTE: no PrimaryDataObject can be accessed outside a root directory object !

Returns:

the root EDAL PrimaryDataDirectory object, which is a container for access all managed PrimaryDataEntity objects

Throws:

PrimaryDataDirectoryException - if unable to mount system.

createPrimaryDataDirectory

public PrimaryDataDirectory createPrimaryDataDirectory(String path)
                                                throws PrimaryDataDirectoryException

Create an new sub PrimaryDataDirectory in the current PrimaryDataDirectory .

NOTE: It is not allowed to create a new sub PrimaryDataDirectory when the currentVersion of this PrimaryDataDirectory is marked as deleted !

NOTE: It is not allowed to create a new sub PrimaryDataDirectory when there is already a PrimaryDataEntity with the same name !

Parameters:

path - the name of the new PrimaryDataDirectory.

Returns:

the new PrimaryDataDirectory object.
null if failed

Throws:

PrimaryDataDirectoryException - if the current PrimaryDataEntityVersion of this PrimaryDataDirectory is marked as deleted or if there is already a PrimaryDataEntity with the same name.

createPrimaryDataFile

public PrimaryDataFile createPrimaryDataFile(String name)
                                      throws PrimaryDataDirectoryException

Create an new PrimaryDataFile in the current PrimaryDataDirectory using the same implementation as this PrimaryDataDirectory .

NOTE: It is not allowed to create a new PrimaryDataFile when the currentVersion of this PrimaryDataDirectory is marked as deleted !

NOTE: It is not allowed to create a new PrimaryDataFile when there is already a PrimaryDataEntity with the same name !

Parameters:

name - of the new PrimaryDataFile object.

Returns:

the new PrimaryDataFile.
null if failed

Throws:

PrimaryDataDirectoryException - if the current PrimaryDataEntityVersion of this PrimaryDataDirectory is marked as deleted or if there is already a PrimaryDataEntity with the same name.

exist

public boolean exist(String path)
              throws PrimaryDataDirectoryException

Check if a PrimaryDataEntity exists with the same path in this 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.

existImpl

protected abstract boolean existImpl(String path)
                              throws PrimaryDataDirectoryException

Abstract function for implementation of exist(String)

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.

getAllPublishedEntities

public List<PrimaryDataEntity> getAllPublishedEntities()
                                                throws PrimaryDataDirectoryException

Convenience and free function to get only PrimaryDataEntitys with published PublicReference objects.

Returns:

a List of all PrimaryDataEntity with a PublicReference.

Throws:

PrimaryDataDirectoryException - if unable to load objcts.

getPrimaryDataEntity

public PrimaryDataEntity getPrimaryDataEntity(String name)
                                       throws PrimaryDataDirectoryException

Get a specified PrimaryDataEntity in this PrimaryDataDirectory by name.

Parameters:

name - name of the PrimaryDataEntity in this PrimaryDataDirectory.

Returns:

the found PrimaryDataEntity object.

Throws:

PrimaryDataDirectoryException - if no such PrimaryDataEntity exists.

getPrimaryDataEntityImpl

protected abstract PrimaryDataEntity getPrimaryDataEntityImpl(String name)
                                                       throws PrimaryDataDirectoryException

Abstract function for the implementation of getPrimaryDataEntity(String).

Parameters:

name - name of the PrimaryDataEntity in this PrimaryDataDirectory.

Returns:

the found PrimaryDataEntity object.

Throws:

PrimaryDataDirectoryException - if no such PrimaryDataEntity exists.

listPrimaryDataEntities

public List<PrimaryDataEntity> listPrimaryDataEntities()
                                                throws PrimaryDataDirectoryException

Get a List containing all PrimaryDataEntity objects in this PrimaryDataDirectory.

Returns:

a List containing all PrimaryDataEntity

Throws:

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

listPrimaryDataEntitiesImpl

protected abstract List<PrimaryDataEntity> listPrimaryDataEntitiesImpl(Calendar currentVersionDate,
                                                  Calendar nextVersionDate)
                                                                throws PrimaryDataDirectoryException

Abstract function for the implementation of listPrimaryDataEntities().

Parameters:

currentVersionDate -

nextVersionDate -

Returns:

a List containing all PrimaryDataEntity

Throws:

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

searchByDublinCoreElement

public List<PrimaryDataEntity> searchByDublinCoreElement(EnumDublinCoreElements element,
                                                UntypedData data,
                                                boolean fuzzy,
                                                boolean recursiveIntoSubdirectories)
                                                  throws PrimaryDataDirectoryException

A convenience method for search only for a specific EnumDublinCoreElements and UntypedData in this PrimaryDataDirectory. The caller function ensure that the result is an unmodifiable List containing all found PrimaryDataEntity objects

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.

searchByDublinCoreElementImpl

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

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

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.

searchByMetaData

public final List<PrimaryDataEntity> searchByMetaData(MetaData query,
                                       boolean fuzzy,
                                       boolean recursiveIntoSubdirectories)
                                               throws PrimaryDataDirectoryException,
                                                      MetaDataException

The method search in the current PrimaryDataDirectory by MetaData.

Parameters:

query - a MetaData object for query.

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.

searchByMetaDataImpl

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

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

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.

searchByPublicationStatus

public List<PrimaryDataEntity> searchByPublicationStatus(PublicationStatus publicationStatus)
                                                  throws PrimaryDataDirectoryException

Function to get all PrimaryDataEntitys in this PrimaryDataDirectory, which have a PublicReference. Filtered by the PublicationStatus.

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

searchByPublicationStatusImpl

protected abstract List<? extends PrimaryDataEntity> searchByPublicationStatusImpl(PublicationStatus publicationStatus)
                                                                            throws PrimaryDataDirectoryException

Abstract function for the implementation of searchByPublicationStatus(PublicationStatus) .

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

searchByKeyword

public List<PrimaryDataEntity> searchByKeyword(String keyword,
                                      boolean fuzzy,
                                      boolean recursiveIntoSubdirectories)
                                        throws PrimaryDataDirectoryException

Function to get all PrimaryDataEntitys containing the keyword.

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.

searchByKeywordImpl

protected abstract List<? extends PrimaryDataEntity> searchByKeywordImpl(String keyword,
                                                    boolean fuzzy,
                                                    boolean recursiveIntoSubdirectories)
                                                                  throws PrimaryDataDirectoryException

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

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.

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.

Check before if the EnumDublinCoreElements.TYPE is a MetaData.DIRECTORY object.

Check before if the EnumDublinCoreElements.FORMAT is a MetaData.EMPTY object.

Overrides:

setMetaData in class PrimaryDataEntity

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.