org.gcube.data.figis.tmplugin.repository
Interface Repository

All Superinterfaces:

Serializable

All Known Implementing Classes:

BaseRepository

public interface Repository
extends Serializable

A local interface to a remote OAI repository.

Author:

"Valentina Marioli valentina.marioli@isti.cnr.it"

Method Summary

String	description() Returns the description of the repository.
org.gcube.data.trees.data.Tree	get(String id) Retrieves a Tree with a given identifier
org.gcube.data.streams.Stream<org.gcube.data.trees.data.Tree>	getRecords() Retrieves all trees
String	name() Returns the name of the repository.
Summary	summary() Returns a Summary of a number of sets of the repository.

Method Detail

name

String name()

Returns the name of the repository.

Returns:

the name

description

String description()

Returns the description of the repository.

Returns:

the description

get

org.gcube.data.trees.data.Tree get(String id)
                                   throws org.gcube.data.tmf.api.exceptions.UnknownTreeException,
                                          Exception

Retrieves a Tree with a given identifier

Parameters:

id - the identifier

Returns:

the tree

Throws:

org.gcube.data.tmf.api.exceptions.UnknownTreeException - if there is no tree in the sets with the given identifier

Exception - if the operation fails for any other error

getRecords

org.gcube.data.streams.Stream<org.gcube.data.trees.data.Tree> getRecords()
                                                                         throws org.gcube.data.tmf.api.exceptions.UnknownTreeException,
                                                                                Exception

Retrieves all trees

Returns:

the trees

Throws:

Exception

org.gcube.data.tmf.api.exceptions.UnknownTreeException

summary

Summary summary()
                throws Exception

Returns a Summary of a number of sets of the repository.

Parameters:

sets - the sets

Returns:

the summary

Throws:

Exception - if the summary cannot be returned