org.apache.clerezza.dataset

Interface TcProvider

All Known Subinterfaces:

QueryableTcProvider, WeightedTcProvider

All Known Implementing Classes:

SimpleTcProvider, TcManager, TcProviderMultiplexer

public interface TcProvider

A TC (Graph) Provider allows access to and optionally creation of named ImmutableGraphs and Graphs (mutable graphs)

Author:

reto

Method Summary

Modifier and Type	Method and Description
Graph	createGraph(IRI name) Creates an initially empty Graph with a specified name
ImmutableGraph	createImmutableGraph(IRI name, Graph triples) Creates a ImmutableGraph with a specified name
void	deleteGraph(IRI name) Deletes the ImmutableGraph or Graph of a specified name.
Graph	getGraph(IRI name) This method is used to get a Graph indifferently whether it's a ImmutableGraph or not.
ImmutableGraph	getImmutableGraph(IRI name) Get a ImmutableGraph by its name
Graph	getMGraph(IRI name) Get an Graph taht is not ImmutableGrah.
Set<IRI>	getNames(ImmutableGraph immutableGraph) get a set of the names of a ImmutableGraph
Set<IRI>	listGraphs() Lists the name of the Graphs available through this TcProvider indifferently whether they are mutables or immutables, implementations may take into account the security context and omit Graphs for which access is not allowed.
Set<IRI>	listImmutableGraphs() Lists the name of the ImmutableGraphs available through this TcProvider, implementations may take into account the security context and omit ImmutableGraphs for which access is not allowed.
Set<IRI>	listMGraphs() Lists the name of the Graphs available through this TcProvider that are not ImmutableGraph, implementations may take into account the security context and omit Graphs for which access is not allowed.

Method Detail

getImmutableGraph

ImmutableGraph getImmutableGraph(IRI name)
                          throws NoSuchEntityException

Get a ImmutableGraph by its name

Parameters:

name - the name of the ImmutableGraph

Returns:

the ImmutableGraph with the specified name

Throws:

NoSuchEntityException - if there is no ImmutableGraph with the specified name

getMGraph

Graph getMGraph(IRI name)
         throws NoSuchEntityException

Get an Graph taht is not ImmutableGrah. The instances returned in different invocations are equals.

Parameters:

name - the name of the Graph

Returns:

Graph with the specified name

Throws:

NoSuchEntityException - if there is no Graph with the specified name

getGraph

Graph getGraph(IRI name)
        throws NoSuchEntityException

This method is used to get a Graph indifferently whether it's a ImmutableGraph or not. If the name names an Graph the result is the same as when invoking getMGraph with that argument, analogously for ImmutableGraphS the method returns an instance equals to what getImmutableGraph would return.

Parameters:

name - the name of the ImmutableGraph or Graph

Returns:

the ImmutableGraph or Graph

Throws:

NoSuchEntityException - if there is no ImmutableGraph or Graph with the specified name

listImmutableGraphs

Set<IRI> listImmutableGraphs()

Lists the name of the ImmutableGraphs available through this TcProvider, implementations may take into account the security context and omit ImmutableGraphs for which access is not allowed.

Returns:

the list of ImmutableGraphs

listMGraphs

Set<IRI> listMGraphs()

Lists the name of the Graphs available through this TcProvider that are not ImmutableGraph, implementations may take into account the security context and omit Graphs for which access is not allowed.

Returns:

the list of Graphs

listGraphs

Set<IRI> listGraphs()

Lists the name of the Graphs available through this TcProvider indifferently whether they are mutables or immutables, implementations may take into account the security context and omit Graphs for which access is not allowed.

Returns:

the list of Graphs

createGraph

Graph createGraph(IRI name)
           throws UnsupportedOperationException,
                  EntityAlreadyExistsException

Creates an initially empty Graph with a specified name

Parameters:

name - names the new Graph

Returns:

the newly created Graph

Throws:

UnsupportedOperationException - if this provider doesn't support creating GraphS

EntityAlreadyExistsException - if an Graph with the specified name already exists

createImmutableGraph

ImmutableGraph createImmutableGraph(IRI name,
                                    Graph triples)
                             throws UnsupportedOperationException,
                                    EntityAlreadyExistsException

Creates a ImmutableGraph with a specified name

Parameters:

name - the name of the ImmutableGraph to be created

triples - the triples of the new ImmutableGraph

Returns:

the newly created ImmutableGraph

Throws:

UnsupportedOperationException - if this provider doesn't support creating ImmutableGraphS

EntityAlreadyExistsException - if a ImmutableGraph with the specified name already exists

deleteGraph

void deleteGraph(IRI name)
          throws UnsupportedOperationException,
                 NoSuchEntityException,
                 EntityUndeletableException

Deletes the ImmutableGraph or Graph of a specified name. If name references a ImmutableGraph and the ImmutableGraph has other names, it will still be available with those other names.

Parameters:

name - the entity to be removed

Throws:

UnsupportedOperationException - if this provider doesn't support entities deletion.

NoSuchEntityException - if name doesn't refer to a ImmutableGraph or an Graph.

EntityUndeletableException - if the specified ImmutableGraph is undeletable

getNames

Set<IRI> getNames(ImmutableGraph immutableGraph)

get a set of the names of a ImmutableGraph

Parameters:

immutableGraph -

Returns:

the set names of ImmutableGraph, the set is empty if ImmutableGraph is unknown