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

Class PrimaryDataFile

java.lang.Object

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

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

All Implemented Interfaces:

Comparable<PrimaryDataEntity>

public abstract class PrimaryDataFile
extends PrimaryDataEntity

Abstract PrimaryDataFile class.

Author:

lange, arendd

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	PrimaryDataFile() Default constructor create a PrimaryDataFile
	PrimaryDataFile(PrimaryDataDirectory path, String name) Construct a PrimaryDataFile and set the file version to the latest one

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract boolean	existData() Abstract function to check if the current PrimaryDataEntityVersion of this PrimaryDataFile has stored data.
void	read(OutputStream dataOutputStream) Load the data of the latest PrimaryDataEntityVersion of this PrimaryDataFile as stream.
protected abstract void	readImpl(OutputStream dataOutputStream) Abstract function for implementation the read(OutputStream) function.
void	setMetaData(MetaData newMetadata) Setter for the MetaData object of this PrimaryDataEntity object.
void	store(InputStream dataInputStream) Store data and generate a new PrimaryDataEntityVersion for this PrimaryDataFile.
protected abstract void	storeImpl(InputStream dataInputStream, PrimaryDataEntityVersion newFileVersion) Abstract function for implementation the store(InputStream) function.

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

Constructor Detail

PrimaryDataFile

protected PrimaryDataFile()

Default constructor create a PrimaryDataFile

PrimaryDataFile

public PrimaryDataFile(PrimaryDataDirectory path,
               String name)
                throws PrimaryDataFileException,
                       PrimaryDataEntityVersionException,
                       PrimaryDataDirectoryException,
                       MetaDataException

Construct a PrimaryDataFile and set the file version to the latest one

Parameters:

path - the directory of the file

name - the file name

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 abstract boolean existData()

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

Returns:

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

read

public void read(OutputStream dataOutputStream)
          throws PrimaryDataFileException

Load the data of the latest PrimaryDataEntityVersion of this PrimaryDataFile as stream.

Parameters:

dataOutputStream - the loaded data.

Throws:

PrimaryDataFileException - if no data is stored.

readImpl

protected abstract void readImpl(OutputStream dataOutputStream)
                          throws PrimaryDataFileException

Abstract function for implementation the read(OutputStream) function.

Parameters:

dataOutputStream - the loaded data.

Throws:

PrimaryDataFileException - if no data is stored.

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 not a MetaData.DIRECTORY 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.

store

public void store(InputStream dataInputStream)
           throws PrimaryDataFileException,
                  PrimaryDataEntityVersionException

Store data and generate a new PrimaryDataEntityVersion for this PrimaryDataFile.

Parameters:

dataInputStream - the date to store in this PrimaryDataEntityVersion.

Throws:

PrimaryDataFileException - if storing of data fails.

PrimaryDataEntityVersionException - if provided version conflicts with existing versions.

storeImpl

protected abstract void storeImpl(InputStream dataInputStream,
             PrimaryDataEntityVersion newFileVersion)
                           throws PrimaryDataFileException

Abstract function for implementation the store(InputStream) function.

Parameters:

dataInputStream - the date to store in this PrimaryDataEntityVersion

Throws:

PrimaryDataFileException - if storing of data fails

PrimaryDataEntityVersionException - if provided version conflicts with existing versions