ExternalizingProvider (Clerezza - Reactor build (root) 0.3-SNAPSHOT API)

java.lang.Object
- org.apache.clerezza.rdf.storage.externalizer.ExternalizingProvider

All Implemented Interfaces:

TcProvider, WeightedTcProvider
```
@Service(value=WeightedTcProvider.class)
@Property(name="weight",
          intValue=500)
@Reference(name="weightedTcProvider",
           policy=DYNAMIC,
           referenceInterface=WeightedTcProvider.class,
           cardinality=MANDATORY_MULTIPLE)
public class ExternalizingProvider
extends Object
implements WeightedTcProvider
```
A WeightedTcProvider storing large literals to the file system and the triples (with references instead of the literals) to another TcProvider.
As this provider is not currently included in any clerezza launcher, the way to install it is as follows:
- start clerezza
- install the bundle and set its startlevel to 3
- shutdown clerezza
- delete the MGraphs that shall use the externalizer from the felix cache
- start clerezza again

Author:

reto

Constructor Summary

Constructors
Constructor and Description

ExternalizingProvider()

Constructors
Constructor and Description
`ExternalizingProvider()`

Method Summary

Methods
Modifier and Type	Method and Description
`protected void`	`activate(org.osgi.service.component.ComponentContext cCtx)`
`protected void`	`bindWeightedTcProvider(WeightedTcProvider provider)` Register a provider
`Graph`	`createGraph(UriRef name, TripleCollection triples)` Creates a `Graph` with a specified name
`MGraph`	`createMGraph(UriRef name)` Creates an initially empty `MGraph` with a specified name
`protected void`	`deactivate(org.osgi.service.component.ComponentContext cCtx)`
`protected static void`	`delete(File file)` Deletes the specified file or directory.
`void`	`deleteTripleCollection(UriRef name)` Deletes the `Graph` or `MGraph` of a specified name.
`Graph`	`getGraph(UriRef name)` we don't do graphs
`MGraph`	`getMGraph(UriRef name)` Get an `MGraph` by its name.
`Set<UriRef>`	`getNames(Graph graph)` get a set of the names of a `Graph`
`TripleCollection`	`getTriples(UriRef name)` This method is used to get a `TripleCollection` indifferently whether it's a Graph or an MGraph.
`int`	`getWeight()` Get the weight of this provider.
`Set<UriRef>`	`listGraphs()` Lists the name of the `Graph`s available through this `TcProvider`, implementations may take into account the security context and omit `Graph`s for which access is not allowed.
`Set<UriRef>`	`listMGraphs()` Lists the name of the `MGraph`s available through this `TcProvider`, implementations may take into account the security context and omit `MGraph`s for which access is not allowed.
`Set<UriRef>`	`listTripleCollections()` Lists the name of the `TripleCollection`s available through this `TcProvider` indifferently whether they are Graphs or an MGraphs, implementations may take into account the security context and omit `TripleCollection`s for which access is not allowed.
`protected void`	`unbindWeightedTcProvider(WeightedTcProvider provider)` Deregister a provider

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ExternalizingProvider
```
public ExternalizingProvider()
```
- Method Detail
  - activate
```
protected void activate(org.osgi.service.component.ComponentContext cCtx)
```
  - deactivate
```
protected void deactivate(org.osgi.service.component.ComponentContext cCtx)
```
  - getWeight
```
public int getWeight()
```
    Description copied from interface: WeightedTcProvider
    
    Get the weight of this provider. TcManager will prioritize TcProviders with greater weight.
    
    Specified by:
    
    getWeight in interface WeightedTcProvider
    
    Returns:
    a positive number indicating the weight of the provider
  - getGraph
```
public Graph getGraph(UriRef name)
               throws NoSuchEntityException
```
    we don't do graphs
    
    Specified by:
    
    getGraph in interface TcProvider
    
    Parameters:
    name -
    
    Returns:
    
    Throws:
    
    NoSuchEntityException
  - getMGraph
```
public MGraph getMGraph(UriRef name)
                 throws NoSuchEntityException
```
    Description copied from interface: TcProvider
    
    Get an MGraph by its name. The instances returned in different invocations are equals.
    
    Specified by:
    
    getMGraph in interface TcProvider
    
    Returns:
    name the MGraph with the specified name
    
    Throws:
    
    NoSuchEntityException - if there is no MGraph with the specified name
  - getTriples
```
public TripleCollection getTriples(UriRef name)
                            throws NoSuchEntityException
```
    Description copied from interface: TcProvider
    
    This method is used to get a TripleCollection indifferently whether it's a Graph or an MGraph. If the name names an MGraph the result is the same as when invoking getMGraph with that argument, analogously for GraphS the method returns an instance equals to what getGraph would return.
    
    Specified by:
    
    getTriples in interface TcProvider
    
    Parameters:
    name - the name of the Graph or MGraph
    
    Returns:
    the Graph or MGraph
    
    Throws:
    
    NoSuchEntityException - if there is no Graph or MGraph with the specified name
  - createMGraph
```
public MGraph createMGraph(UriRef name)
                    throws UnsupportedOperationException,
                           EntityAlreadyExistsException
```
    Description copied from interface: TcProvider
    
    Creates an initially empty MGraph with a specified name
    
    Specified by:
    
    createMGraph in interface TcProvider
    
    Parameters:
    name - names the new MGraph
    
    Returns:
    the newly created MGraph
    
    Throws:
    
    UnsupportedOperationException - if this provider doesn't support creating MGraphS
    
    EntityAlreadyExistsException - if an MGraph with the specified name already exists
  - createGraph
```
public Graph createGraph(UriRef name,
                TripleCollection triples)
                  throws UnsupportedOperationException,
                         EntityAlreadyExistsException
```
    Description copied from interface: TcProvider
    
    Creates a Graph with a specified name
    
    Specified by:
    
    createGraph in interface TcProvider
    
    Parameters:
    name - the name of the Graph to be created
    triples - the triples of the new Graph
    
    Returns:
    the newly created Graph
    
    Throws:
    
    UnsupportedOperationException - if this provider doesn't support creating GraphS
    
    EntityAlreadyExistsException - if a Graph with the specified name already exists
  - deleteTripleCollection
```
public void deleteTripleCollection(UriRef name)
                            throws UnsupportedOperationException,
                                   NoSuchEntityException,
                                   EntityUndeletableException
```
    Description copied from interface: TcProvider
    
    Deletes the Graph or MGraph of a specified name. If name references a Graph and the graph has other names, it will still be available with those other names.
    
    Specified by:
    
    deleteTripleCollection in interface TcProvider
    
    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 Graph or an MGraph.
    
    EntityUndeletableException - if the specified Graph is undeletable
  - delete
```
protected static void delete(File file)
```
    Deletes the specified file or directory.
    
    Parameters:
    file - Abstract path denoting the file or directory to clean.
  - getNames
```
public Set<UriRef> getNames(Graph graph)
```
    Description copied from interface: TcProvider
    
    get a set of the names of a Graph
    
    Specified by:
    
    getNames in interface TcProvider
    
    Returns:
    the set names of Graph, the set is empty if Graph is unknown
  - listTripleCollections
```
public Set<UriRef> listTripleCollections()
```
    Description copied from interface: TcProvider
    
    Lists the name of the TripleCollections available through this TcProvider indifferently whether they are Graphs or an MGraphs, implementations may take into account the security context and omit TripleCollections for which access is not allowed.
    
    Specified by:
    
    listTripleCollections in interface TcProvider
    
    Returns:
    the list of TripleCollections
  - listGraphs
```
public Set<UriRef> listGraphs()
```
    Description copied from interface: TcProvider
    
    Lists the name of the Graphs available through this TcProvider, implementations may take into account the security context and omit Graphs for which access is not allowed.
    
    Specified by:
    
    listGraphs in interface TcProvider
    
    Returns:
    the list of Graphs
  - listMGraphs
```
public Set<UriRef> listMGraphs()
```
    Description copied from interface: TcProvider
    
    Lists the name of the MGraphs available through this TcProvider, implementations may take into account the security context and omit MGraphs for which access is not allowed.
    
    Specified by:
    
    listMGraphs in interface TcProvider
    
    Returns:
    the list of MGraphs
  - bindWeightedTcProvider
```
protected void bindWeightedTcProvider(WeightedTcProvider provider)
```
    Register a provider
    
    Parameters:
    provider - the provider to be registered
  - unbindWeightedTcProvider
```
protected void unbindWeightedTcProvider(WeightedTcProvider provider)
```
    Deregister a provider
    
    Parameters:
    provider - the provider to be deregistered

Class ExternalizingProvider

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ExternalizingProvider

Method Detail

activate

deactivate

getWeight

getGraph

getMGraph

getTriples

createMGraph

createGraph

deleteTripleCollection

delete

getNames

listTripleCollections

listGraphs

listMGraphs

bindWeightedTcProvider

unbindWeightedTcProvider