org.openprovenance.prov.model

Interface ModelConstructor

All Known Implementing Classes:

ProvFactory

public interface ModelConstructor

Interface for constructing concrete representations of the PROV data model

Method Summary

Modifier and Type	Method and Description
ActedOnBehalfOf	newActedOnBehalfOf(QualifiedName id, QualifiedName delegate, QualifiedName responsible, QualifiedName activity, Collection<Attribute> attributes) A factory method to create an instance of a delegation ActedOnBehalfOf
Activity	newActivity(QualifiedName id, XMLGregorianCalendar startTime, XMLGregorianCalendar endTime, Collection<Attribute> attributes)
Agent	newAgent(QualifiedName id, Collection<Attribute> attributes)
AlternateOf	newAlternateOf(QualifiedName e2, QualifiedName e1)
DerivedByInsertionFrom	newDerivedByInsertionFrom(QualifiedName id, QualifiedName after, QualifiedName before, List<Entry> keyEntitySet, Collection<Attribute> attributes)
DerivedByRemovalFrom	newDerivedByRemovalFrom(QualifiedName id, QualifiedName after, QualifiedName before, List<Key> keys, Collection<Attribute> attributes)
DictionaryMembership	newDictionaryMembership(QualifiedName dict, List<Entry> keyEntitySet)
Document	newDocument(Namespace namespace, Collection<Statement> statements, Collection<Bundle> bundles) A factory method to create an instance of a Document
Entity	newEntity(QualifiedName id, Collection<Attribute> attributes)
HadMember	newHadMember(QualifiedName c, Collection<QualifiedName> e)
MentionOf	newMentionOf(QualifiedName e2, QualifiedName e1, QualifiedName b)
Bundle	newNamedBundle(QualifiedName id, Namespace namespace, Collection<Statement> statements) A factory method to create an instance of a Bundle Bundle
QualifiedName	newQualifiedName(String namespace, String local, String prefix) A factory method for QualifiedName.
QualifiedName	newQualifiedName(String namespace, String local, String prefix, ProvUtilities.BuildFlag flag) A factory method for QualifiedName.
SpecializationOf	newSpecializationOf(QualifiedName e2, QualifiedName e1)
Used	newUsed(QualifiedName id, QualifiedName activity, QualifiedName entity, XMLGregorianCalendar time, Collection<Attribute> attributes) A factory method to create an instance of a Usage Used
WasAssociatedWith	newWasAssociatedWith(QualifiedName id, QualifiedName activity, QualifiedName agent, QualifiedName plan, Collection<Attribute> attributes) A factory method to create an instance of an Association WasAssociatedWith
WasAttributedTo	newWasAttributedTo(QualifiedName id, QualifiedName entity, QualifiedName agent, Collection<Attribute> attributes) A factory method to create an instance of an attribution WasAttributedTo
WasDerivedFrom	newWasDerivedFrom(QualifiedName id, QualifiedName e2, QualifiedName e1, QualifiedName activity, QualifiedName generation, QualifiedName usage, Collection<Attribute> attributes) A factory method to create an instance of a derivation WasDerivedFrom
WasEndedBy	newWasEndedBy(QualifiedName id, QualifiedName activity, QualifiedName trigger, QualifiedName ender, XMLGregorianCalendar time, Collection<Attribute> attributes) A factory method to create an instance of an end WasEndedBy
WasGeneratedBy	newWasGeneratedBy(QualifiedName id, QualifiedName entity, QualifiedName activity, XMLGregorianCalendar time, Collection<Attribute> attributes) A factory method to create an instance of a generation WasGeneratedBy
WasInfluencedBy	newWasInfluencedBy(QualifiedName id, QualifiedName influencee, QualifiedName influencer, Collection<Attribute> attributes) A factory method to create an instance of an influence WasInfluencedBy
WasInformedBy	newWasInformedBy(QualifiedName id, QualifiedName informed, QualifiedName informant, Collection<Attribute> attributes) A factory method to create an instance of an communication WasInformedBy
WasInvalidatedBy	newWasInvalidatedBy(QualifiedName id, QualifiedName entity, QualifiedName activity, XMLGregorianCalendar time, Collection<Attribute> attributes) A factory method to create an instance of an invalidation WasInvalidatedBy
WasStartedBy	newWasStartedBy(QualifiedName id, QualifiedName activity, QualifiedName trigger, QualifiedName starter, XMLGregorianCalendar time, Collection<Attribute> attributes) A factory method to create an instance of a start WasStartedBy
void	startBundle(QualifiedName bundleId, Namespace namespace)
void	startDocument(Namespace namespace)

Method Detail

newActedOnBehalfOf

ActedOnBehalfOf newActedOnBehalfOf(QualifiedName id,
                                   QualifiedName delegate,
                                   QualifiedName responsible,
                                   QualifiedName activity,
                                   Collection<Attribute> attributes)

A factory method to create an instance of a delegation ActedOnBehalfOf

Parameters:

id - identifier for the delegation association between delegate and responsible

delegate - identifier for the agent associated with an activity, acting on behalf of the responsible agent

responsible - identifier for the agent, on behalf of which the delegate agent acted

activity - optional identifier of an activity for which the delegation association holds

attributes - optional set of attributes representing additional information about this delegation association

Returns:

an instance of ActedOnBehalfOf

newActivity

Activity newActivity(QualifiedName id,
                     XMLGregorianCalendar startTime,
                     XMLGregorianCalendar endTime,
                     Collection<Attribute> attributes)

newAgent

Agent newAgent(QualifiedName id,
               Collection<Attribute> attributes)

newAlternateOf

AlternateOf newAlternateOf(QualifiedName e2,
                           QualifiedName e1)

newDerivedByInsertionFrom

DerivedByInsertionFrom newDerivedByInsertionFrom(QualifiedName id,
                                                 QualifiedName after,
                                                 QualifiedName before,
                                                 List<Entry> keyEntitySet,
                                                 Collection<Attribute> attributes)

newDerivedByRemovalFrom

DerivedByRemovalFrom newDerivedByRemovalFrom(QualifiedName id,
                                             QualifiedName after,
                                             QualifiedName before,
                                             List<Key> keys,
                                             Collection<Attribute> attributes)

newDictionaryMembership

DictionaryMembership newDictionaryMembership(QualifiedName dict,
                                             List<Entry> keyEntitySet)

newDocument

Document newDocument(Namespace namespace,
                     Collection<Statement> statements,
                     Collection<Bundle> bundles)

A factory method to create an instance of a Document

Parameters:

namespace - the prefix namespace mapping for the current document

statements - a collection of statements

bundles - a collection of bundles

Returns:

an instance of Document, with this prefix-namespace mapping, statements, and bundles

newEntity

Entity newEntity(QualifiedName id,
                 Collection<Attribute> attributes)

newHadMember

HadMember newHadMember(QualifiedName c,
                       Collection<QualifiedName> e)

newMentionOf

MentionOf newMentionOf(QualifiedName e2,
                       QualifiedName e1,
                       QualifiedName b)

newNamedBundle

Bundle newNamedBundle(QualifiedName id,
                      Namespace namespace,
                      Collection<Statement> statements)

A factory method to create an instance of a Bundle Bundle

Parameters:

id - an identifier for the bundle

namespace - a Namespace object mapping prefix to namespace URIs

statements - a set of provenance descriptions

Returns:

Bundle

newQualifiedName

QualifiedName newQualifiedName(String namespace,
                               String local,
                               String prefix)

A factory method for QualifiedName. A qualified name consists of a namespace, denoted by an optional prefix, and a local name.

Parameters:

namespace - a URI for the namespace

local - a local name

prefix - a string, which can be null.

Returns:

an instance of QualifiedName

newQualifiedName

QualifiedName newQualifiedName(String namespace,
                               String local,
                               String prefix,
                               ProvUtilities.BuildFlag flag)

A factory method for QualifiedName. A qualified name consists of a namespace, denoted by an optional prefix, and a local name.

Parameters:

namespace - a URI for the namespace

local - a local name

prefix - a string, which can be null

build - flag.

Returns:

an instance of QualifiedName

newSpecializationOf

SpecializationOf newSpecializationOf(QualifiedName e2,
                                     QualifiedName e1)

newUsed

Used newUsed(QualifiedName id,
             QualifiedName activity,
             QualifiedName entity,
             XMLGregorianCalendar time,
             Collection<Attribute> attributes)

A factory method to create an instance of a Usage Used

Parameters:

id - an optional identifier for a usage

activity - the identifier of the activity that used an entity

entity - an optional identifier for the entity being used

time - an optional "usage time", the time at which the entity started to be used

attributes - an optional set of attribute-value pairs representing additional information about this usage

Returns:

an instance of Used

newWasAssociatedWith

WasAssociatedWith newWasAssociatedWith(QualifiedName id,
                                       QualifiedName activity,
                                       QualifiedName agent,
                                       QualifiedName plan,
                                       Collection<Attribute> attributes)

A factory method to create an instance of an Association WasAssociatedWith

Parameters:

id - an optional identifier for the association between an activity and an agent

activity - an identifier for the activity

agent - an optional identifier for the agent associated with the activity

plan - an optional identifier for the plan the agent relied on in the context of this activity

attributes - an optional set of attribute-value pairs representing additional information about this association of this activity with this agent.

Returns:

an instance of WasAssociatedWith

newWasAttributedTo

WasAttributedTo newWasAttributedTo(QualifiedName id,
                                   QualifiedName entity,
                                   QualifiedName agent,
                                   Collection<Attribute> attributes)

A factory method to create an instance of an attribution WasAttributedTo

Parameters:

id - an optional identifier for the relation

entity - an entity identifier

agent - the identifier of the agent whom the entity is ascribed to, and therefore bears some responsibility for its existence

attributes - an optional set of attribute-value pairs representing additional information about this attribution.

Returns:

an instance of WasAttributedTo

newWasDerivedFrom

WasDerivedFrom newWasDerivedFrom(QualifiedName id,
                                 QualifiedName e2,
                                 QualifiedName e1,
                                 QualifiedName activity,
                                 QualifiedName generation,
                                 QualifiedName usage,
                                 Collection<Attribute> attributes)

A factory method to create an instance of a derivation WasDerivedFrom

Parameters:

id - an optional identifier for a derivation

e2 - the identifier of the entity generated by the derivation

e1 - the identifier of the entity used by the derivation

activity -

generation -

usage -

attributes -

Returns:

an instance of WasDerivedFrom

newWasEndedBy

WasEndedBy newWasEndedBy(QualifiedName id,
                         QualifiedName activity,
                         QualifiedName trigger,
                         QualifiedName ender,
                         XMLGregorianCalendar time,
                         Collection<Attribute> attributes)

A factory method to create an instance of an end WasEndedBy

Parameters:

id -

activity - an identifier for the ended activity

trigger - an optional identifier for the entity triggering the activity ending

ender - an optional identifier for the activity that generated the (possibly unspecified) entity

time - the optional time at which the activity was ended

attributes - an optional set of attribute-value pairs representing additional information about this activity end

Returns:

an instance of WasStartedBy

newWasGeneratedBy

WasGeneratedBy newWasGeneratedBy(QualifiedName id,
                                 QualifiedName entity,
                                 QualifiedName activity,
                                 XMLGregorianCalendar time,
                                 Collection<Attribute> attributes)

A factory method to create an instance of a generation WasGeneratedBy

Parameters:

id - an optional identifier for a usage

entity - an identifier for the created entity

activity - an optional identifier for the activity that creates the entity

time - an optional "generation time", the time at which the entity was completely created

attributes - an optional set of attribute-value pairs representing additional information about this generation

Returns:

an instance of WasGeneratedBy

newWasInfluencedBy

WasInfluencedBy newWasInfluencedBy(QualifiedName id,
                                   QualifiedName influencee,
                                   QualifiedName influencer,
                                   Collection<Attribute> attributes)

A factory method to create an instance of an influence WasInfluencedBy

Parameters:

id - optional identifier identifying the association

influencee - an identifier for an entity, activity, or agent

influencer - an identifier for an ancestor entity, activity, or agent that the former depends on

attributes - an optional set of attribute-value pairs representing additional information about this association

Returns:

an instance of WasInfluencedBy

newWasInformedBy

WasInformedBy newWasInformedBy(QualifiedName id,
                               QualifiedName informed,
                               QualifiedName informant,
                               Collection<Attribute> attributes)

A factory method to create an instance of an communication WasInformedBy

Parameters:

id - an optional identifier identifying the association;

informed - the identifier of the informed activity;

informant - the identifier of the informant activity;

attributes - an optional set of attribute-value pairs representing additional information about this communication.

Returns:

an instance of WasInformedBy

newWasInvalidatedBy

WasInvalidatedBy newWasInvalidatedBy(QualifiedName id,
                                     QualifiedName entity,
                                     QualifiedName activity,
                                     XMLGregorianCalendar time,
                                     Collection<Attribute> attributes)

A factory method to create an instance of an invalidation WasInvalidatedBy

Parameters:

id - an optional identifier for a usage

entity - an identifier for the created entity

activity - an optional identifier for the activity that creates the entity

time - an optional "invalidation time", the time at which the entity was completely created

attributes - an optional set of attribute-value pairs representing additional information about this invalidation

Returns:

an instance of WasInvalidatedBy

newWasStartedBy

WasStartedBy newWasStartedBy(QualifiedName id,
                             QualifiedName activity,
                             QualifiedName trigger,
                             QualifiedName starter,
                             XMLGregorianCalendar time,
                             Collection<Attribute> attributes)

A factory method to create an instance of a start WasStartedBy

Parameters:

id -

activity - an identifier for the started activity

trigger - an optional identifier for the entity triggering the activity

starter - an optional identifier for the activity that generated the (possibly unspecified) entity

time - the optional time at which the activity was started

attributes - an optional set of attribute-value pairs representing additional information about this activity start

Returns:

an instance of WasStartedBy

startBundle

void startBundle(QualifiedName bundleId,
                 Namespace namespace)

startDocument

void startDocument(Namespace namespace)