pt.ua.dicoogle.sdk

Interface StorageInterface

All Superinterfaces:

DicooglePlugin

All Known Implementing Classes:

DefaultFileStoragePlugin

public interface StorageInterface
extends DicooglePlugin

Storage plugin interface. These types of plugins provide an abstraction to reading and writing from files or data blobs.

Method Summary

Modifier and Type	Method and Description
java.lang.Iterable<StorageInputStream>	at(java.net.URI location, java.lang.Object... parameters) Provides a means of iteration over existing objects at a specified location.
java.lang.String	getScheme() Gets the scheme URI of this storage plugin.
boolean	handles(java.net.URI location) Checks whether the file in the given path can be handled by this storage plugin.
void	remove(java.net.URI location) Removes an element at the given URI.
java.net.URI	store(DicomInputStream inputStream, java.lang.Object... parameters) Stores a new element into the storage.
java.net.URI	store(DicomObject dicomObject, java.lang.Object... parameters) Stores a DICOM object into the storage.

Methods inherited from interface pt.ua.dicoogle.sdk.DicooglePlugin

disable, enable, getName, getSettings, isEnabled, setSettings

Method Detail

getScheme

java.lang.String getScheme()

Gets the scheme URI of this storage plugin.

Returns:

a string denoting the scheme that this plugin associates to

See Also:

URI

handles

boolean handles(java.net.URI location)

Checks whether the file in the given path can be handled by this storage plugin.

Parameters:

location - a URI containing a scheme to be verified

Returns:

true if this storage plugin is in charge of URIs in the given form

at

java.lang.Iterable<StorageInputStream> at(java.net.URI location,
                                          java.lang.Object... parameters)

Provides a means of iteration over existing objects at a specified location. This method is particularly nice for use in for-each loops. The provided scheme is not relevant at this point, but the developer must avoid calling this method with a path of a different schema.

for(StorageInputStream dicomObj : storagePlugin.at("file://dataset/")){
      System.err.println(dicomObj.getURI());
 }

Parameters:

location - the location to read

parameters - a variable list of extra parameters for the retrieve

Returns:

an iterable of storage input streams

See Also:

StorageInputStream

store

java.net.URI store(DicomObject dicomObject,
                   java.lang.Object... parameters)

Stores a DICOM object into the storage.

Parameters:

dicomObject - Object to be Stored

parameters - a variable list of extra parameters for the retrieve

Returns:

The URI of the previously stored Object.

store

java.net.URI store(DicomInputStream inputStream,
                   java.lang.Object... parameters)
            throws java.io.IOException

Stores a new element into the storage.

Parameters:

inputStream - an input stream with the contents to be stored

parameters - a variable list of extra parameters for the retrieve

Returns:

the URI of the stored data

Throws:

java.io.IOException - if an I/O error occurs

remove

void remove(java.net.URI location)

Removes an element at the given URI.

Parameters:

location - the URI of the stored data