Index (The Tree Manager Framework 3.0.1-SNAPSHOT API)

A B C D E F G H I L N O P R S T U V W

A

AbstractReader - Class in org.gcube.data.tmf.impl: Partial implementation of SourceReader.
AbstractReader() - Constructor for class org.gcube.data.tmf.impl.AbstractReader
AbstractSource - Class in org.gcube.data.tmf.impl: A partial implementation of Source.
AbstractSource(String) - Constructor for class org.gcube.data.tmf.impl.AbstractSource: Creates an instance with a given identifier.
AbstractWriter - Class in org.gcube.data.tmf.impl: Partial implementation of SourceWriter.
AbstractWriter() - Constructor for class org.gcube.data.tmf.impl.AbstractWriter
add(Tree) - Method in interface org.gcube.data.tmf.api.SourceWriter: Adds a tree to the source.
add(Stream<Tree>) - Method in interface org.gcube.data.tmf.api.SourceWriter: Adds many trees at once to the source.
add(Stream<Tree>) - Method in class org.gcube.data.tmf.impl.AbstractWriter: Default implementation of SourceWriter.add(Stream) based on repeated delegation to SourceWriter.add(Tree).

B

bind(Element) - Method in interface org.gcube.data.tmf.api.SourceBinder: Binds one or more data sources in response to client requests, returning Source models of the bound sources to the service.
binder() - Method in interface org.gcube.data.tmf.api.Plugin: Returns the SourceBinder of the plugin.

C

cardinality() - Method in interface org.gcube.data.tmf.api.Source: Returns the cardinality of the source.
cardinality() - Method in class org.gcube.data.tmf.impl.AbstractSource: Returns the cardinality of the source.
CHANGE - Static variable in interface org.gcube.data.tmf.api.SourceEvent: Signals a change in the data source.
Constants - Class in org.gcube.data.tmf.api: Library-wide constants.
Constants() - Constructor for class org.gcube.data.tmf.api.Constants
creationTime() - Method in interface org.gcube.data.tmf.api.Source: Returns the creation time of the source.
creationTime() - Method in class org.gcube.data.tmf.impl.AbstractSource: Returns the creation time of the source.

D

description() - Method in interface org.gcube.data.tmf.api.Plugin: Returns the plugin description
description() - Method in class org.gcube.data.tmf.api.Property: Return the property description.
description() - Method in interface org.gcube.data.tmf.api.Source: Returns the free-form description of the source.
description() - Method in class org.gcube.data.tmf.impl.AbstractSource: Returns the free-form description of the source.

E

Environment - Interface in org.gcube.data.tmf.api: An abstraction over the deployment environment of the plugin.
environment() - Method in interface org.gcube.data.tmf.api.Source: Returns the local Environment of the plugin.
environment() - Method in class org.gcube.data.tmf.impl.AbstractSource: Returns the local Environment of the plugin.
equals(Object) - Method in class org.gcube.data.tmf.impl.AbstractSource

F

file(String) - Method in interface org.gcube.data.tmf.api.Environment: Returns a File in an area of the file system reserved to the service.

G

get(String, Pattern) - Method in interface org.gcube.data.tmf.api.SourceReader: Returns a tree in the source with a given identifier, after pruning it with a given pattern.
get(Stream<String>, Pattern) - Method in interface org.gcube.data.tmf.api.SourceReader: Returns trees in the source with given identifiers, after pruning them with a given pattern.
get(Pattern) - Method in interface org.gcube.data.tmf.api.SourceReader: Returns all the trees in the source which match a given pattern, after pruning them with it.
get(Stream<String>, Pattern) - Method in class org.gcube.data.tmf.impl.AbstractReader: Default implementation of SourceReader.get(Stream, Pattern) based on repeated delegation to SourceReader.get(String,Pattern).
getNode(String...) - Method in interface org.gcube.data.tmf.api.SourceReader: Returns a tree node in the source from the path of identifiers which connects it to the root of the tree.
getNode(String...) - Method in class org.gcube.data.tmf.impl.AbstractReader: Default implementation of SourceReader.getNodes(Stream) based on delegation to SourceReader.get(String,Pattern).
getNodes(Stream<Path>) - Method in interface org.gcube.data.tmf.api.SourceReader: Returns tree nodes in the source from the paths of identifiers which connect them to the roots of the trees.
getNodes(Stream<Path>) - Method in class org.gcube.data.tmf.impl.AbstractReader: Default implementation of SourceReader.getNodes(Stream) based on repeated delegation to SourceReader.getNode(String...).

H

hashCode() - Method in class org.gcube.data.tmf.impl.AbstractSource

I

id() - Method in interface org.gcube.data.tmf.api.Source: Returns the identifier of the source.
id() - Method in class org.gcube.data.tmf.impl.AbstractSource: Returns the identifier of the source.
ids() - Method in class org.gcube.data.tmf.api.Path: Returns the node identifiers of the path.
init() - Method in interface org.gcube.data.tmf.api.SourceLifecycle: Tells the plugin to start managing the data source.
init() - Method in class org.gcube.data.tmf.impl.LifecycleAdapter: Tells the plugin to start managing the data source.
InvalidRequestException - Exception in org.gcube.data.tmf.api.exceptions: A RuntimeException raised when client requests are invalid for services.
InvalidRequestException() - Constructor for exception org.gcube.data.tmf.api.exceptions.InvalidRequestException: Creates an instance.
InvalidRequestException(String) - Constructor for exception org.gcube.data.tmf.api.exceptions.InvalidRequestException: Creates an instance with a given message.
InvalidRequestException(Throwable) - Constructor for exception org.gcube.data.tmf.api.exceptions.InvalidRequestException: Creates an instance from an underlying cause.
InvalidRequestException(String, Throwable) - Constructor for exception org.gcube.data.tmf.api.exceptions.InvalidRequestException: Creates an instance with a given message and an underlying cause.
InvalidTreeException - Exception in org.gcube.data.tmf.api.exceptions: Raised when trees do not match expectations.
InvalidTreeException() - Constructor for exception org.gcube.data.tmf.api.exceptions.InvalidTreeException: Creates an instance.
InvalidTreeException(String) - Constructor for exception org.gcube.data.tmf.api.exceptions.InvalidTreeException: Creates an instance with given message.
InvalidTreeException(String, Throwable) - Constructor for exception org.gcube.data.tmf.api.exceptions.InvalidTreeException: Creates an instance with a given message and cause.
InvalidTreeException(Throwable) - Constructor for exception org.gcube.data.tmf.api.exceptions.InvalidTreeException
isAnchored() - Method in interface org.gcube.data.tmf.api.Plugin: Returns true if the plugin does not support replication across services.
isUser() - Method in interface org.gcube.data.tmf.api.Source: Returns true if the source is a user-level source, false if it is instead system-level source.
isUser() - Method in class org.gcube.data.tmf.impl.AbstractSource: Returns true if the source is a user-level source, false if it is instead system-level source.

L

lastUpdate() - Method in interface org.gcube.data.tmf.api.Source: Returns the time in which the source was last modified.
lastUpdate() - Method in class org.gcube.data.tmf.impl.AbstractSource: Returns the time in which the source was last modified.
lifecycle() - Method in interface org.gcube.data.tmf.api.Source: Returns the SourceLifecycle.
lifecycle() - Method in class org.gcube.data.tmf.impl.AbstractSource: Returns the SourceLifecycle.
LifecycleAdapter - Class in org.gcube.data.tmf.impl: No-op implementation of SourceLifecycle for selective overriding in subclasses.
LifecycleAdapter() - Constructor for class org.gcube.data.tmf.impl.LifecycleAdapter

N

name() - Method in interface org.gcube.data.tmf.api.Plugin: Returns the plugin name
name() - Method in class org.gcube.data.tmf.api.Property: Returns the property name.
name() - Method in interface org.gcube.data.tmf.api.Source: Returns the name of the source.
name() - Method in class org.gcube.data.tmf.impl.AbstractSource: Returns the name of the source.
notifier() - Method in interface org.gcube.data.tmf.api.Source: Returns the SourceNotifier.
notifier() - Method in class org.gcube.data.tmf.impl.AbstractSource: Returns the SourceNotifier.
notify(SourceEvent) - Method in interface org.gcube.data.tmf.api.SourceNotifier: Notifies subscribers of a SourceEvent event.
NS - Static variable in class org.gcube.data.tmf.api.Constants: Namespace.

O

onEvent(SourceEvent...) - Method in interface org.gcube.data.tmf.api.SourceConsumer: Callback on notification of SourceEvents.
org.gcube.data.tmf.api - package org.gcube.data.tmf.api
org.gcube.data.tmf.api.exceptions - package org.gcube.data.tmf.api.exceptions
org.gcube.data.tmf.impl - package org.gcube.data.tmf.impl

P

Path - Class in org.gcube.data.tmf.api: A path of identifiers to a tree node.
Path(String...) - Constructor for class org.gcube.data.tmf.api.Path: Creates an instance with given node identifiers
Plugin - Interface in org.gcube.data.tmf.api: Entry-point to the information and components of the plugin.
PluginLifecycle - Interface in org.gcube.data.tmf.api: A Plugin extension with callbacks made by the service at key points of its lifecycle.
properties() - Method in interface org.gcube.data.tmf.api.Plugin: Return the descriptive properties of the plugin
properties() - Method in interface org.gcube.data.tmf.api.Source: Returns the properties of the source.
Property - Class in org.gcube.data.tmf.api: A plugin property.
Property(String, String, String) - Constructor for class org.gcube.data.tmf.api.Property

R

reader() - Method in interface org.gcube.data.tmf.api.Source: Returns the SourceReader.
reader() - Method in class org.gcube.data.tmf.impl.AbstractSource: Returns the SourceReader.
reconfigure(Element) - Method in interface org.gcube.data.tmf.api.SourceLifecycle: Gives the plugin a client request with which it can refine its management of the data source.
reconfigure(Element) - Method in class org.gcube.data.tmf.impl.LifecycleAdapter: Gives the plugin a client request with which it can refine its management of the data source.
REMOVE - Static variable in interface org.gcube.data.tmf.api.SourceEvent: Signals that the data source is no longer accessible to the plugin.
requestSchemas() - Method in interface org.gcube.data.tmf.api.Plugin: Returns schemas for the requests accepted by the plugin.
resume() - Method in interface org.gcube.data.tmf.api.SourceLifecycle: Tells the plugin to resume its management of the data source.
resume() - Method in class org.gcube.data.tmf.impl.LifecycleAdapter: Tells the plugin to resume its management of the data source.

S

setCardinality(Long) - Method in class org.gcube.data.tmf.impl.AbstractSource: Sets the cardinality of the source, changing automatically the time of last modification of the source.
setCreationTime(Calendar) - Method in class org.gcube.data.tmf.impl.AbstractSource: Sets the creation time of the source.
setDescription(String) - Method in class org.gcube.data.tmf.impl.AbstractSource: Sets a free-form description for the source.
setEnvironment(Environment) - Method in interface org.gcube.data.tmf.api.Source: Sets the local Environment of the plugin.
setEnvironment(Environment) - Method in class org.gcube.data.tmf.impl.AbstractSource: Sets the local Environment of the plugin.
setLastUpdate(Calendar) - Method in class org.gcube.data.tmf.impl.AbstractSource: Sets the time in which the source was last modified.
setLifecycle(SourceLifecycle) - Method in class org.gcube.data.tmf.impl.AbstractSource: Sets the SourceLifecycle.
setName(String) - Method in class org.gcube.data.tmf.impl.AbstractSource: Sets the name of the source.
setNotifier(SourceNotifier) - Method in interface org.gcube.data.tmf.api.Source: Returns the SourceNotifier.
setNotifier(SourceNotifier) - Method in class org.gcube.data.tmf.impl.AbstractSource: Returns the SourceNotifier.
setReader(SourceReader) - Method in class org.gcube.data.tmf.impl.AbstractSource: Sets the SourceReader
setUser(boolean) - Method in class org.gcube.data.tmf.impl.AbstractSource: Marks the source as a user or as a system source.
setWriter(SourceWriter) - Method in class org.gcube.data.tmf.impl.AbstractSource: Sets the SourceWriter
Source - Interface in org.gcube.data.tmf.api: A model of a data source managed by the plugin.
SourceBinder - Interface in org.gcube.data.tmf.api: Binds the plugin to data sources in response to client requests.
SourceConsumer - Interface in org.gcube.data.tmf.api: A consumer of SourceEvents.
SourceEvent - Interface in org.gcube.data.tmf.api: An event in the lifetime of a Source.
SourceLifecycle - Interface in org.gcube.data.tmf.api: A set of callbacks made by the service to the plugin at key points in the lifecycle of a Source, i.e.
SourceNotifier - Interface in org.gcube.data.tmf.api: Manages subscriptions for and notifications of SourceEvents.
SourceReader - Interface in org.gcube.data.tmf.api: Returns trees and node from a data source.
SourceWriter - Interface in org.gcube.data.tmf.api: Writes, changes, or deletes trees in a data source.
start(Environment) - Method in interface org.gcube.data.tmf.api.PluginLifecycle: Invoked by the service when plugin is first loaded.
stop(Environment) - Method in interface org.gcube.data.tmf.api.PluginLifecycle: Invoked by the service when the plugin, or the service, are stopped.
stop() - Method in interface org.gcube.data.tmf.api.SourceLifecycle: Tells the plugin to stop its management of the data source until further notice.
stop() - Method in class org.gcube.data.tmf.impl.LifecycleAdapter: Tells the plugin to stop its management of the data source until further notice.
subscribe(SourceConsumer, SourceEvent...) - Method in interface org.gcube.data.tmf.api.SourceNotifier: Subscribes a SourceConsumer to one or more SourceEvents.

T

terminate() - Method in interface org.gcube.data.tmf.api.SourceLifecycle: Tells the plugin to stop its management of the data source for good.
terminate() - Method in class org.gcube.data.tmf.impl.LifecycleAdapter: Tells the plugin to stop its management of the data source for good.
toString() - Method in class org.gcube.data.tmf.impl.AbstractSource
TREE_TYPE - Static variable in interface org.gcube.data.tmf.api.Source
types() - Method in interface org.gcube.data.tmf.api.Source: Returns the tree types of the source.

U

UnknownPathException - Exception in org.gcube.data.tmf.api.exceptions: Raised when paths fail to identify nodes in a given context.
UnknownPathException() - Constructor for exception org.gcube.data.tmf.api.exceptions.UnknownPathException: Creates an instance.
UnknownPathException(String) - Constructor for exception org.gcube.data.tmf.api.exceptions.UnknownPathException: Creates an instance with given message.
UnknownPathException(String, Throwable) - Constructor for exception org.gcube.data.tmf.api.exceptions.UnknownPathException: Creates an instance with a given message and cause.
UnknownPathException(Throwable) - Constructor for exception org.gcube.data.tmf.api.exceptions.UnknownPathException: Creates an instance with a given cause.
UnknownTreeException - Exception in org.gcube.data.tmf.api.exceptions: Raised when identifiers do not identify trees.
UnknownTreeException() - Constructor for exception org.gcube.data.tmf.api.exceptions.UnknownTreeException: Creates an instance.
UnknownTreeException(String) - Constructor for exception org.gcube.data.tmf.api.exceptions.UnknownTreeException: Creates an instance with given message.
UnknownTreeException(String, Throwable) - Constructor for exception org.gcube.data.tmf.api.exceptions.UnknownTreeException: Creates an instance with a given message and cause.
UnknownTreeException(Throwable) - Constructor for exception org.gcube.data.tmf.api.exceptions.UnknownTreeException: Creates an instance with a given cause.
UnsupportedOperationException - Exception in org.gcube.data.tmf.api.exceptions: Raised with requests to service operations that are not supported.
UnsupportedOperationException() - Constructor for exception org.gcube.data.tmf.api.exceptions.UnsupportedOperationException: Creates an instance.
UnsupportedOperationException(String) - Constructor for exception org.gcube.data.tmf.api.exceptions.UnsupportedOperationException: Creates an instance with a message.
UnsupportedRequestException - Exception in org.gcube.data.tmf.api.exceptions: Raised with requests to services which are not supported by the target plugin.
UnsupportedRequestException() - Constructor for exception org.gcube.data.tmf.api.exceptions.UnsupportedRequestException: Creates an instance.
UnsupportedRequestException(String) - Constructor for exception org.gcube.data.tmf.api.exceptions.UnsupportedRequestException: Creates an instance with a message.
UnsupportedRequestException(String, Throwable) - Constructor for exception org.gcube.data.tmf.api.exceptions.UnsupportedRequestException: Creates an instance with a message and a cause.
UnsupportedRequestException(Throwable) - Constructor for exception org.gcube.data.tmf.api.exceptions.UnsupportedRequestException: Creates an instance with a cause.
update(Tree) - Method in interface org.gcube.data.tmf.api.SourceWriter: Updates a tree in the source with the delta tree that captures the changes.
update(Stream<Tree>) - Method in interface org.gcube.data.tmf.api.SourceWriter: Updates many trees at once in the source with the delta trees that capture their changes.
update(Stream<Tree>) - Method in class org.gcube.data.tmf.impl.AbstractWriter: Default implementation of SourceWriter.update(Stream) based on repeated delegation to SourceWriter.update(Tree).

V

value() - Method in class org.gcube.data.tmf.api.Property: Returns the property value.

W

writer() - Method in interface org.gcube.data.tmf.api.Source: Returns the SourceWriter.
writer() - Method in class org.gcube.data.tmf.impl.AbstractSource: Returns the SourceWriter.

A B C D E F G H I L N O P R S T U V W