org.continuity.commons.storage

Class FileStorage<T>

java.lang.Object

org.continuity.commons.storage.FileStorage<T>

Type Parameters:

T - The type of the stored artifacts.

All Implemented Interfaces:

ArtifactStorage<T>

Direct Known Subclasses:

CsvFileStorage, JsonFileStorage

public abstract class FileStorage<T>
extends java.lang.Object
implements ArtifactStorage<T>

Stores artifacts in the file system.

Constructor Summary

Constructors

Constructor and Description
FileStorage(java.nio.file.Path storagePath, T emptyEntity)

Method Summary

Modifier and Type	Method and Description
T	get(java.lang.String id) Retrieves the model for the given id.
java.lang.String	getTagForId(java.lang.String id) Returns the tag that is part of the ID.
java.lang.String	put(T entity, java.lang.String tag) Adds a new entity and returns the automatically created id.
void	putToReserved(java.lang.String id, T entity) Adds a new entity to an already reserved slot.
protected abstract T	read(java.nio.file.Path dirPath, java.lang.String id) Reads an artifact.
protected abstract boolean	remove(java.nio.file.Path dirPath, java.lang.String id) Removes an artifact.
boolean	remove(java.lang.String id) Removes the model with the passed id and returns whether the id was present.
java.lang.String	reserve(java.lang.String tag) Reserves a slot in the storage.
protected abstract void	write(java.nio.file.Path dirPath, java.lang.String id, T entity) Writes the artifacts to the file system.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FileStorage

public FileStorage(java.nio.file.Path storagePath,
                   T emptyEntity)

Method Detail

write

protected abstract void write(java.nio.file.Path dirPath,
                              java.lang.String id,
                              T entity)
                       throws java.io.IOException

Writes the artifacts to the file system. Implementations should store files or directories that start with the passed IDs.

Parameters:

dirPath - The directory in which the artifact should be stored.

id - The ID of the artifact.

entity - The artifact to be stored.

Throws:

java.io.IOException - If writing fails.

read

protected abstract T read(java.nio.file.Path dirPath,
                          java.lang.String id)
                   throws java.io.IOException

Reads an artifact.

Parameters:

dirPath -

id -

Returns:

Throws:

java.io.IOException

remove

protected abstract boolean remove(java.nio.file.Path dirPath,
                                  java.lang.String id)
                           throws java.io.IOException

Removes an artifact.

Parameters:

dirPath -

id -

Returns:

true if the artifact existed and was removed successfully.

Throws:

java.io.IOException

reserve

public java.lang.String reserve(java.lang.String tag)

Description copied from interface: ArtifactStorage

Reserves a slot in the storage.

Specified by:

reserve in interface ArtifactStorage<T>

Parameters:

tag - The tag of the entity.

Returns:

An id for the slot.

putToReserved

public void putToReserved(java.lang.String id,
                          T entity)

Description copied from interface: ArtifactStorage

Adds a new entity to an already reserved slot.

Specified by:

putToReserved in interface ArtifactStorage<T>

Parameters:

id - The ID of the slot.

entity - The entity to be stored.

put

public java.lang.String put(T entity,
                            java.lang.String tag)

Description copied from interface: ArtifactStorage

Adds a new entity and returns the automatically created id.

Specified by:

put in interface ArtifactStorage<T>

Parameters:

entity - The entity to be stored.

tag - The tag of the entity.

Returns:

The created id.

get

public T get(java.lang.String id)

Description copied from interface: ArtifactStorage

Retrieves the model for the given id.

Specified by:

get in interface ArtifactStorage<T>

Parameters:

id - The id of the model.

Returns:

A WorkloadModel.

remove

public boolean remove(java.lang.String id)

Description copied from interface: ArtifactStorage

Removes the model with the passed id and returns whether the id was present.

Specified by:

remove in interface ArtifactStorage<T>

Parameters:

id - The id to be removed.

Returns:

true, if the passed id was present and successfully removed.

getTagForId

public java.lang.String getTagForId(java.lang.String id)

Description copied from interface: ArtifactStorage

Returns the tag that is part of the ID.

Specified by:

getTagForId in interface ArtifactStorage<T>

Parameters:

id - The ID containing the tag.

Returns:

The tag