hep.dataforge.storage.commons

Class AbstractStorage

java.lang.Object

hep.dataforge.navigation.AbstractProvider

hep.dataforge.storage.commons.AbstractStorage

All Implemented Interfaces:

Named, Confined, Responder, Annotated, Provider, Storage, java.lang.AutoCloseable

Direct Known Subclasses:

DummyStorage, FileStorage

public abstract class AbstractStorage
extends AbstractProvider
implements Storage

Конфигурации загрузчиков хранятся в оперативной памяти. Те, что поставляются вместе с сервером загружаются в конструкторе, остальные загружаются только на время выполнения. Для того, чтобы сделать другой формат хранения, нужно переопредлить методы setupLoader и overrideLoader

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_EVENT_LOADER_NAME
protected java.util.Map<java.lang.String,Loader>	loaders
protected Storage	parent
protected java.util.Map<java.lang.String,Storage>	shelves
protected Meta	storageConfig

Constructor Summary

Constructors

Constructor and Description
AbstractStorage(Storage parent, java.lang.String name, Meta annotation)
AbstractStorage(java.lang.String name)
AbstractStorage(java.lang.String name, Meta annotation)

Method Summary

Modifier and Type	Method and Description
Loader	buildLoader(java.lang.String shelf, Meta loaderConfig) Build a loader on a specific shelf
Storage	buildShelf(java.lang.String shelfName) Create shelf with given name and inherited configuration.
void	close() Close the storage
Context	getContext() the context
EventLoader	getDefaultEventLoader() Get the default event loader for this storage
Loader	getLoader(java.lang.String name) Get the loader with given name if it is registered in this storage.
java.lang.String	getName() getName.
Storage	getParent() Get superStorage of this storage.
Storage	getShelf(java.lang.String name) Returns th shelf with given name.
boolean	hasLoader(java.lang.String name) Check if the loader with given name is registered.
boolean	hasShelf(java.lang.String name) Check if this storage has shelf with given name.
boolean	isRoot()
java.util.Map<java.lang.String,Loader>	loaders() return a copy of loader map
Meta	meta() Get the meta-data for this object.
void	open() Initialize this storage.
protected Loader	overrideLoader(Loader currentLoader, Meta newAnnotation) update an annotation of loader using overriding annotation
java.lang.Object	provide(Path path) If chainpath is presented than default target is "storage".
protected java.lang.Object	provide(java.lang.String target, Name name) Provide direct members only (no chain paths)
boolean	provides(Path path) provides.
protected boolean	provides(java.lang.String target, Name name) If chainpath is presented than default target is "storage".
void	refresh() Refresh the state of storage
Envelope	respond(Envelope message)
java.util.Map<java.lang.String,Storage>	shelves() A map of all shelfs in this storage and their annotations

Methods inherited from class hep.dataforge.navigation.AbstractProvider

provide, provides

Methods inherited from class java.lang.Object

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

Methods inherited from interface hep.dataforge.storage.api.Storage

buildLoader, buildShelf

Methods inherited from interface hep.dataforge.content.Named

isAnonimous

Methods inherited from interface hep.dataforge.navigation.Provider

provide, provide, provides

Field Detail

DEFAULT_EVENT_LOADER_NAME

public static final java.lang.String DEFAULT_EVENT_LOADER_NAME

See Also:

Constant Field Values

parent

protected Storage parent

storageConfig

protected Meta storageConfig

loaders

protected final java.util.Map<java.lang.String,Loader> loaders

shelves

protected final java.util.Map<java.lang.String,Storage> shelves

Constructor Detail

AbstractStorage

public AbstractStorage(Storage parent,
                       java.lang.String name,
                       Meta annotation)

AbstractStorage

public AbstractStorage(java.lang.String name,
                       Meta annotation)

AbstractStorage

public AbstractStorage(java.lang.String name)

Method Detail

open

public void open()
          throws StorageException

Initialize this storage.

Specified by:

open in interface Storage

Throws:

StorageException

refresh

public void refresh()
             throws StorageException

Refresh the state of storage

Specified by:

refresh in interface Storage

Throws:

StorageException

close

public void close()
           throws java.lang.Exception

Close the storage

Specified by:

close in interface Storage

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.lang.Exception

buildShelf

public Storage buildShelf(java.lang.String shelfName)
                   throws StorageException

Create shelf with given name and inherited configuration. By default is equivalent of buildShelf(shelfName, null)

Parameters:

shelfName -

Returns:

Throws:

StorageException

overrideLoader

protected Loader overrideLoader(Loader currentLoader,
                                Meta newAnnotation)
                         throws StorageException

update an annotation of loader using overriding annotation

Parameters:

currentLoader -

newAnnotation -

Returns:

Throws:

StorageException

provides

public boolean provides(Path path)

Description copied from interface: Provider

provides.

Specified by:

provides in interface Provider

Overrides:

provides in class AbstractProvider

Returns:

a boolean.

provide

public java.lang.Object provide(Path path)

If chainpath is presented than default target is "storage". For single path the default target is "loader"

Specified by:

provide in interface Provider

Overrides:

provide in class AbstractProvider

Parameters:

path -

Returns:

provides

protected boolean provides(java.lang.String target,
                           Name name)

If chainpath is presented than default target is "storage". For single path the default target is "loader"

Specified by:

provides in class AbstractProvider

Parameters:

target -

name -

Returns:

provide

protected java.lang.Object provide(java.lang.String target,
                                   Name name)

Description copied from class: AbstractProvider

Provide direct members only (no chain paths)

Specified by:

provide in class AbstractProvider

Returns:

meta

public Meta meta()

Description copied from interface: Annotated

Get the meta-data for this object. By convention null is not allowed. If there is no meta-data, empty meta is returned. The name of returned meta is currently not restricted.

Specified by:

meta in interface Annotated

Returns:

getName

public java.lang.String getName()

Description copied from interface: Named

getName.

Specified by:

getName in interface Named

Returns:

a String object.

hasLoader

public boolean hasLoader(java.lang.String name)

Description copied from interface: Storage

Check if the loader with given name is registered. Chain path not allowed.

Specified by:

hasLoader in interface Storage

Returns:

getLoader

public Loader getLoader(java.lang.String name)
                 throws StorageException

Description copied from interface: Storage

Get the loader with given name if it is registered in this storage. Chain path not allowed.

Specified by:

getLoader in interface Storage

Parameters:

name - name of the loader or data set. In general is the name of hierarchical root element for all data points

Returns:

Throws:

StorageException

hasShelf

public boolean hasShelf(java.lang.String name)

Description copied from interface: Storage

Check if this storage has shelf with given name. Chain path not allowed.

Specified by:

hasShelf in interface Storage

Returns:

getShelf

public Storage getShelf(java.lang.String name)
                 throws StorageException

Description copied from interface: Storage

Returns th shelf with given name. Chain path not allowed. Throws StorageException if shelf does not exist or not accessible.

Specified by:

getShelf in interface Storage

Returns:

Throws:

StorageException

loaders

public java.util.Map<java.lang.String,Loader> loaders()
                                               throws StorageException

return a copy of loader map

Specified by:

loaders in interface Storage

Returns:

Throws:

StorageException

shelves

public java.util.Map<java.lang.String,Storage> shelves()
                                                throws StorageException

Description copied from interface: Storage

A map of all shelfs in this storage and their annotations

Specified by:

shelves in interface Storage

Returns:

Throws:

StorageException

getParent

public Storage getParent()

Description copied from interface: Storage

Get superStorage of this storage. If null, than this storage is root

Specified by:

getParent in interface Storage

Returns:

the parent

buildLoader

public Loader buildLoader(java.lang.String shelf,
                          Meta loaderConfig)
                   throws StorageException

Build a loader on a specific shelf

Parameters:

shelf -

loaderConfig -

Returns:

Throws:

StorageException

isRoot

public boolean isRoot()

getContext

public Context getContext()

Description copied from interface: Confined

the context

Specified by:

getContext in interface Confined

Returns:

a Context object.

getDefaultEventLoader

public EventLoader getDefaultEventLoader()
                                  throws StorageException

Description copied from interface: Storage

Get the default event loader for this storage

Specified by:

getDefaultEventLoader in interface Storage

Returns:

Throws:

StorageException

respond

public Envelope respond(Envelope message)

Specified by:

respond in interface Responder