pt.ua.dicoogle.plugins

Class DefaultFileStoragePlugin

java.lang.Object

pt.ua.dicoogle.sdk.PluginBase

pt.ua.dicoogle.plugins.DefaultFileStoragePlugin

All Implemented Interfaces:

PlatformCommunicatorInterface, DicooglePlugin, PluginSet, StorageInterface

public class DefaultFileStoragePlugin
extends PluginBase
implements StorageInterface

Field Summary

Fields inherited from class pt.ua.dicoogle.sdk.PluginBase

graphicPlugins, indexPlugins, jettyPlugins, platform, queryPlugins, services, settings, storagePlugins

Constructor Summary

Constructors

Constructor and Description
DefaultFileStoragePlugin()

Method Summary

Modifier and Type	Method and Description
java.lang.Iterable<StorageInputStream>	at(java.net.URI location, java.lang.Object... args) Provides a means of iteration over existing objects at a specified location.
boolean	disable() Issues the plugin to become disabled.
boolean	enable() Issues the plugin to become enabled.
java.lang.String	getName() Gets the plugin's name.
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.
boolean	isEnabled() Verifies if the plugin is enabled.
void	remove(java.net.URI location) Removes an element at the given URI.
java.net.URI	store(DicomInputStream inputStream, java.lang.Object... args) Stores a DICOM object into the storage.
java.net.URI	store(DicomObject dicomObject, java.lang.Object... args) Stores a DICOM object into the storage.

Methods inherited from class pt.ua.dicoogle.sdk.PluginBase

getGraphicalPlugins, getIndexPlugins, getJettyPlugins, getQueryPlugins, getRestPlugins, getSettings, getStoragePlugins, setPlatformProxy, setSettings, shutdown

Methods inherited from class java.lang.Object

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

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

getSettings, setSettings

Constructor Detail

DefaultFileStoragePlugin

public DefaultFileStoragePlugin()

Method Detail

enable

public boolean enable()

Description copied from interface: DicooglePlugin

Issues the plugin to become enabled. It is expected that an enabled plugin, once configured, is ready to perform its main tasks.

Specified by:

enable in interface DicooglePlugin

Returns:

whether the plugin was successfully enabled

disable

public boolean disable()

Description copied from interface: DicooglePlugin

Issues the plugin to become disabled. When called, the plugin is responsible for stopping all services that the plugin is running.

Specified by:

disable in interface DicooglePlugin

Returns:

whether the plugin was successfully disabled

isEnabled

public boolean isEnabled()

Description copied from interface: DicooglePlugin

Verifies if the plugin is enabled.

Specified by:

isEnabled in interface DicooglePlugin

Returns:

whether the plugin is enabled

getScheme

public java.lang.String getScheme()

Description copied from interface: StorageInterface

Gets the scheme URI of this storage plugin.

Specified by:

getScheme in interface StorageInterface

Returns:

a string denoting the scheme that this plugin associates to

See Also:

URI

handles

public boolean handles(java.net.URI location)

Description copied from interface: StorageInterface

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

Specified by:

handles in interface StorageInterface

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

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

Description copied from interface: StorageInterface

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

Specified by:

at in interface StorageInterface

Parameters:

location - the location to read

args - a variable list of extra parameters for the retrieve

Returns:

an iterable of storage input streams

See Also:

StorageInputStream

store

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

Description copied from interface: StorageInterface

Stores a DICOM object into the storage.

Specified by:

store in interface StorageInterface

Parameters:

dicomObject - Object to be Stored

args - a variable list of extra parameters for the retrieve

Returns:

The URI of the previously stored Object.

store

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

Description copied from interface: StorageInterface

Stores a DICOM object into the storage.

Specified by:

store in interface StorageInterface

Parameters:

inputStream - Object to be Stored

args - a variable list of extra parameters for the retrieve

Returns:

The URI of the previously stored Object.

Throws:

java.io.IOException

remove

public void remove(java.net.URI location)

Description copied from interface: StorageInterface

Removes an element at the given URI.

Specified by:

remove in interface StorageInterface

Parameters:

location - the URI of the stored data

getName

public java.lang.String getName()

Description copied from interface: PluginSet

Gets the plugin's name. This name will be used for identifying index/query/storage providers, and should be unique among the total plugin sets installed.

Specified by:

getName in interface DicooglePlugin

Specified by:

getName in interface PluginSet

Specified by:

getName in class PluginBase

Returns:

the name of the plugin, never changes