eu.transformproject.provenance.service

Interface ProvenanceStorageInterface

All Known Subinterfaces:

ProvenanceServerInterface

All Known Implementing Classes:

ProvenancePersistenceManager, ProvenanceServer, ProvenanceServerRemote, ProvenanceServerWebService

public interface ProvenanceStorageInterface

Provides methods for provenance data annotation: entities creation, causal dependence definition, and provenance annotation inclusion.

Author:

Roxana Ma. Danger Mercaderes

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	addAnnotation(java.lang.String uriEntityOrDependence, java.lang.String owl_prop, java.lang.String value) Adds an annotation to an entity or a dependence, owl_prop is the property to annotate which must appear in the ontology profile (or set of domain-user ontologies) associated to the server, the value associated to the property is value.
java.lang.String[]	addAnnotations(java.lang.String uriEntityOrDependence, AnnotationSet annotations)
java.lang.String	addCausalDependence(java.lang.String uriEntityCause, java.lang.String uriEntityDest) As the previous method but the causal dependences to create must correspond with one of the five defined in \cite{Moreau2010}.
java.lang.String	addCausalDependence(java.lang.String uriEntityCause, java.lang.String opmo_dependenceClass, java.lang.String uriEntityDest) Defines a causal dependence from the entity uriEntityDest to uriEntityCause in the graph idGraph.
void	associateToAccount(java.lang.String uriEntity, java.lang.String uriAccount) Specify an account for which an specific OPM entity can be viewed.
AnnotationSet	composeAnnotation(java.lang.String owl_prop, java.lang.String value) Create an AnnotationSet object, initialising it with the annotation defined by the pair: owl_prop, value.
void	endProcess(java.lang.String processUri) Allows to store the date-time in which a process has finalised.
void	endProcessWithStatus(java.lang.String processUri, java.lang.String processStatus) Allows to store the date-time in which a process has finalised together with its status.
java.lang.Object	flushAndRefresh(java.lang.Object object)
OPMGraph	getCurrGraph()
java.lang.String	getEntityURI(java.lang.String owl_opm_Class, AnnotationSet annotations) Generate or retrieve an URI associated to the given parameters.
OPMEntity	getOPMEntity(java.lang.String entityURI) Recover an OPMEntity given its URI.
java.lang.String	getOPMGraphForProject(java.lang.String projectName) If it exists a graph associated to this project name, this method returns it, otherwise, it creates a new graph, and adds to it an annotation associating it with a project.
java.util.Date	getSyncTime()
java.lang.String	newGraph() Adds a new graph in the provenance store.
void	setCurrentGraph(java.lang.String idGraph) Specify that all the new entity definitions belong to the OPM graph with URI idGraph.
void	setProcessEndAt(java.lang.String processUri, java.util.Date timeEnd)
void	setProcessStartAt(java.lang.String processUri, java.util.Date timeStart)
void	setProcessStatus(java.lang.String processUri, java.lang.String processStatus) Allows to set the status of a process.

Method Detail

getSyncTime

java.util.Date getSyncTime()
                           throws java.lang.Exception

Returns:

Returns the date/time as in the time server

Throws:

java.lang.Exception

newGraph

java.lang.String newGraph()
                          throws java.lang.Exception

Adds a new graph in the provenance store. Returns the URI of the inserted graph.

Returns:

Returns the URI of a new OPM graph to be inserted in the provenance store.

Throws:

java.lang.Exception

getOPMGraphForProject

java.lang.String getOPMGraphForProject(java.lang.String projectName)
                                       throws java.lang.Exception

If it exists a graph associated to this project name, this method returns it, otherwise, it creates a new graph, and adds to it an annotation associating it with a project.

Parameters:

projectName - name of the project described by the created graph.

Returns:

Throws:

java.lang.Exception

getOPMEntity

OPMEntity getOPMEntity(java.lang.String entityURI)
                       throws java.lang.Exception

Recover an OPMEntity given its URI.

Parameters:

entityURI - URI of the entity to recover.

Returns:

Throws:

java.lang.Exception

flushAndRefresh

java.lang.Object flushAndRefresh(java.lang.Object object)
                                 throws java.lang.Exception

Throws:

java.lang.Exception

setCurrentGraph

void setCurrentGraph(java.lang.String idGraph)
                     throws java.lang.Exception

Specify that all the new entity definitions belong to the OPM graph with URI idGraph.

Parameters:

idGraph - URI of the graph for all new declared entities.

Throws:

java.lang.Exception

getEntityURI

java.lang.String getEntityURI(java.lang.String owl_opm_Class,
                            AnnotationSet annotations)
                              throws java.lang.Exception

Generate or retrieve an URI associated to the given parameters. Given an owl_opm_class from the ontology profile (or set of domain-user ontologies) associated to the server, and a set of annotations that characterise the current entity. This method will retrieve a stored OPM entity with such features, or create a new one. The URI of the generated/created instance will be returned.

Parameters:

owl_opm_Class - class to which the opm entity belongs

annotations - annotations associated to the entity to create/retrieve

Returns:

The URI of the retrieved/created instance.

Throws:

java.lang.Exception

endProcess

void endProcess(java.lang.String processUri)
                throws java.lang.Exception

Allows to store the date-time in which a process has finalised.

Parameters:

processUri - the process that has finished

Throws:

java.lang.Exception

endProcessWithStatus

void endProcessWithStatus(java.lang.String processUri,
                        java.lang.String processStatus)
                          throws java.lang.Exception

Allows to store the date-time in which a process has finalised together with its status.

Parameters:

processUri - the process that has finished

processStatus - status of the process that has finished

Throws:

java.lang.Exception

setProcessStatus

void setProcessStatus(java.lang.String processUri,
                    java.lang.String processStatus)
                      throws java.lang.Exception

Allows to set the status of a process.

Parameters:

processStatus - string representing the status of a process. Only the current status of a process is maintained. In future versions, other status annotations would be maintained at different times.

Throws:

java.lang.Exception

setProcessStartAt

void setProcessStartAt(java.lang.String processUri,
                     java.util.Date timeStart)
                       throws java.lang.Exception

Throws:

java.lang.Exception

setProcessEndAt

void setProcessEndAt(java.lang.String processUri,
                   java.util.Date timeEnd)
                     throws java.lang.Exception

Throws:

java.lang.Exception

associateToAccount

void associateToAccount(java.lang.String uriEntity,
                      java.lang.String uriAccount)
                        throws java.lang.Exception

Specify an account for which an specific OPM entity can be viewed.

Parameters:

uriEntity - OPM entity URI of the entity to associate to the account

uriAccount - OPM Account URI for the OPM entity.

Throws:

java.lang.Exception

addCausalDependence

java.lang.String addCausalDependence(java.lang.String uriEntityCause,
                                   java.lang.String opmo_dependenceClass,
                                   java.lang.String uriEntityDest)
                                     throws java.lang.Exception

Defines a causal dependence from the entity uriEntityDest to uriEntityCause in the graph idGraph. opmo_dependenceClass should correspond with a class derived from opmo:Edge, defined in the ontology profile (or set of domain-user ontologies) associated to the server.

Parameters:

uriEntityCause -

opmo_dependenceClass -

uriEntityDest -

Returns:

Throws:

java.lang.Exception

addCausalDependence

java.lang.String addCausalDependence(java.lang.String uriEntityCause,
                                   java.lang.String uriEntityDest)
                                     throws java.lang.Exception

As the previous method but the causal dependences to create must correspond with one of the five defined in \cite{Moreau2010}.

Parameters:

uriEntityCause -

uriEntityDest -

Returns:

Throws:

java.lang.Exception

addAnnotation

java.lang.String addAnnotation(java.lang.String uriEntityOrDependence,
                             java.lang.String owl_prop,
                             java.lang.String value)
                               throws java.lang.Exception

Adds an annotation to an entity or a dependence, owl_prop is the property to annotate which must appear in the ontology profile (or set of domain-user ontologies) associated to the server, the value associated to the property is value.

Parameters:

uriEntityOrDependence -

owl_prop -

value -

Returns:

Throws:

java.lang.Exception

addAnnotations

java.lang.String[] addAnnotations(java.lang.String uriEntityOrDependence,
                                AnnotationSet annotations)
                                  throws java.lang.Exception

Throws:

java.lang.Exception

composeAnnotation

AnnotationSet composeAnnotation(java.lang.String owl_prop,
                              java.lang.String value)
                                throws java.lang.Exception

Create an AnnotationSet object, initialising it with the annotation defined by the pair: owl_prop, value.

Parameters:

owl_prop -

value -

Returns:

Throws:

java.lang.Exception

getCurrGraph

OPMGraph getCurrGraph()
                      throws java.lang.Exception

Throws:

java.lang.Exception