org.apache.clerezza.platform.documentation

Class DocumentationProvider

java.lang.Object

org.apache.clerezza.platform.documentation.DocumentationProvider

All Implemented Interfaces:

EventListener, org.apache.clerezza.rdf.core.access.TcProvider, org.apache.clerezza.rdf.core.access.WeightedTcProvider, org.osgi.framework.BundleListener

@Services(value={@Service(value=org.apache.clerezza.rdf.core.access.WeightedTcProvider.class),@Service(value=DocumentationProvider.class)})
@Property(name="weight",
          intValue=30)
public class DocumentationProvider
extends Object
implements org.apache.clerezza.rdf.core.access.WeightedTcProvider, org.osgi.framework.BundleListener

The DocumentationProvider gathers the documentations of bundles and provides a graph containing all documentations. It is an implementation of WeightedTcProvider with the default weight 30.

Author:

mir, hasan

Field Summary

Fields

Modifier and Type	Field and Description
static org.apache.clerezza.rdf.core.UriRef	DOCUMENTATION_GRAPH_URI The URI of the graph containing the documentations

Constructor Summary

Constructors

Constructor and Description
DocumentationProvider()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	activate(org.osgi.service.component.ComponentContext componentContext)
void	bundleChanged(org.osgi.framework.BundleEvent event)
org.apache.clerezza.rdf.core.Graph	createGraph(org.apache.clerezza.rdf.core.UriRef name, org.apache.clerezza.rdf.core.TripleCollection triples)
org.apache.clerezza.rdf.core.MGraph	createMGraph(org.apache.clerezza.rdf.core.UriRef name)
protected void	deactivate(org.osgi.service.component.ComponentContext componentContext)
void	deleteTripleCollection(org.apache.clerezza.rdf.core.UriRef name)
org.apache.clerezza.rdf.core.Graph	getGraph(org.apache.clerezza.rdf.core.UriRef name)
org.apache.clerezza.rdf.core.MGraph	getMGraph(org.apache.clerezza.rdf.core.UriRef name)
Set<org.apache.clerezza.rdf.core.UriRef>	getNames(org.apache.clerezza.rdf.core.Graph graph)
org.apache.clerezza.rdf.core.TripleCollection	getTriples(org.apache.clerezza.rdf.core.UriRef name)
int	getWeight()
Set<org.apache.clerezza.rdf.core.UriRef>	listGraphs()
Set<org.apache.clerezza.rdf.core.UriRef>	listMGraphs()
Set<org.apache.clerezza.rdf.core.UriRef>	listTripleCollections()

Methods inherited from class java.lang.Object

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

Field Detail

DOCUMENTATION_GRAPH_URI

public static final org.apache.clerezza.rdf.core.UriRef DOCUMENTATION_GRAPH_URI

The URI of the graph containing the documentations

Constructor Detail

DocumentationProvider

public DocumentationProvider()

Method Detail

getWeight

public int getWeight()

Specified by:

getWeight in interface org.apache.clerezza.rdf.core.access.WeightedTcProvider

getGraph

public org.apache.clerezza.rdf.core.Graph getGraph(org.apache.clerezza.rdf.core.UriRef name)
                                            throws org.apache.clerezza.rdf.core.access.NoSuchEntityException

Specified by:

getGraph in interface org.apache.clerezza.rdf.core.access.TcProvider

Throws:

org.apache.clerezza.rdf.core.access.NoSuchEntityException

getMGraph

public org.apache.clerezza.rdf.core.MGraph getMGraph(org.apache.clerezza.rdf.core.UriRef name)
                                              throws org.apache.clerezza.rdf.core.access.NoSuchEntityException

Specified by:

getMGraph in interface org.apache.clerezza.rdf.core.access.TcProvider

Throws:

org.apache.clerezza.rdf.core.access.NoSuchEntityException

getTriples

public org.apache.clerezza.rdf.core.TripleCollection getTriples(org.apache.clerezza.rdf.core.UriRef name)
                                                         throws org.apache.clerezza.rdf.core.access.NoSuchEntityException

Specified by:

getTriples in interface org.apache.clerezza.rdf.core.access.TcProvider

Throws:

org.apache.clerezza.rdf.core.access.NoSuchEntityException

listGraphs

public Set<org.apache.clerezza.rdf.core.UriRef> listGraphs()

Specified by:

listGraphs in interface org.apache.clerezza.rdf.core.access.TcProvider

listMGraphs

public Set<org.apache.clerezza.rdf.core.UriRef> listMGraphs()

Specified by:

listMGraphs in interface org.apache.clerezza.rdf.core.access.TcProvider

listTripleCollections

public Set<org.apache.clerezza.rdf.core.UriRef> listTripleCollections()

Specified by:

listTripleCollections in interface org.apache.clerezza.rdf.core.access.TcProvider

createMGraph

public org.apache.clerezza.rdf.core.MGraph createMGraph(org.apache.clerezza.rdf.core.UriRef name)
                                                 throws UnsupportedOperationException,
                                                        org.apache.clerezza.rdf.core.access.EntityAlreadyExistsException

Specified by:

createMGraph in interface org.apache.clerezza.rdf.core.access.TcProvider

Throws:

UnsupportedOperationException

org.apache.clerezza.rdf.core.access.EntityAlreadyExistsException

createGraph

public org.apache.clerezza.rdf.core.Graph createGraph(org.apache.clerezza.rdf.core.UriRef name,
                                             org.apache.clerezza.rdf.core.TripleCollection triples)
                                               throws UnsupportedOperationException,
                                                      org.apache.clerezza.rdf.core.access.EntityAlreadyExistsException

Specified by:

createGraph in interface org.apache.clerezza.rdf.core.access.TcProvider

Throws:

UnsupportedOperationException

org.apache.clerezza.rdf.core.access.EntityAlreadyExistsException

deleteTripleCollection

public void deleteTripleCollection(org.apache.clerezza.rdf.core.UriRef name)
                            throws UnsupportedOperationException,
                                   org.apache.clerezza.rdf.core.access.NoSuchEntityException,
                                   org.apache.clerezza.rdf.core.access.EntityUndeletableException

Specified by:

deleteTripleCollection in interface org.apache.clerezza.rdf.core.access.TcProvider

Throws:

UnsupportedOperationException

org.apache.clerezza.rdf.core.access.NoSuchEntityException

org.apache.clerezza.rdf.core.access.EntityUndeletableException

getNames

public Set<org.apache.clerezza.rdf.core.UriRef> getNames(org.apache.clerezza.rdf.core.Graph graph)

Specified by:

getNames in interface org.apache.clerezza.rdf.core.access.TcProvider

bundleChanged

public void bundleChanged(org.osgi.framework.BundleEvent event)

Specified by:

bundleChanged in interface org.osgi.framework.BundleListener

activate

protected void activate(org.osgi.service.component.ComponentContext componentContext)

deactivate

protected void deactivate(org.osgi.service.component.ComponentContext componentContext)