Module prov.model

Package org.openprovenance.prov.vanilla

Class ModelConstructor

java.lang.Object

org.openprovenance.prov.vanilla.ModelConstructor

All Implemented Interfaces:

AtomConstructor, ModelConstructor

public final class ModelConstructor
extends Object
implements ModelConstructor, AtomConstructor

Constructor Summary

Constructors

Constructor	Description
ModelConstructor()

Method Summary

Modifier and Type	Method	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 e1, QualifiedName e2)
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)
DictionaryMembership	newDictionaryMembership(QualifiedName id, QualifiedName dict, List<Entry> keyEntitySet, Collection<Attribute> attributes)
Document	newDocument(Namespace namespace, Collection<Statement> statements, Collection<Bundle> bundles)	A factory method to create an instance of a Document
Document	newDocument(Namespace namespace, List<StatementOrBundle> statementsOrBundles)	A factory method to create an instance of a Document
Entity	newEntity(QualifiedName id, Collection<Attribute> attributes)
HadMember	newHadMember(QualifiedName c, Collection<QualifiedName> e)
LangString	newInternationalizedString(String s)
LangString	newInternationalizedString(String s, String lang)
Label	newLabel(Object value, QualifiedName type)
Location	newLocation(Object value, QualifiedName type)
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
Other	newOther(QualifiedName elementName, Object value, QualifiedName type)
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.
Role	newRole(Object value, QualifiedName type)
SpecializationOf	newSpecializationOf(QualifiedName e2, QualifiedName e1)
Type	newType(Object value, QualifiedName type)
Used	newUsed(QualifiedName id, QualifiedName activity, QualifiedName entity, XMLGregorianCalendar time, Collection<Attribute> attributes)	A factory method to create an instance of a Usage Used
Value	newValue(Object value, QualifiedName type)
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)

Methods inherited from class java.lang.Object

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

Constructor Details

ModelConstructor

public ModelConstructor()

Method Details

newActedOnBehalfOf

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

A factory method to create an instance of a delegation ActedOnBehalfOf

Specified by:

newActedOnBehalfOf in interface ModelConstructor

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

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

Specified by:

newActivity in interface ModelConstructor

newAgent

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

Specified by:

newAgent in interface ModelConstructor

newAlternateOf

public AlternateOf newAlternateOf(QualifiedName e1,
 QualifiedName e2)

Specified by:

newAlternateOf in interface ModelConstructor

newDerivedByInsertionFrom

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

Specified by:

newDerivedByInsertionFrom in interface ModelConstructor

newDerivedByRemovalFrom

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

Specified by:

newDerivedByRemovalFrom in interface ModelConstructor

newDictionaryMembership

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

Specified by:

newDictionaryMembership in interface ModelConstructor

newDictionaryMembership

public DictionaryMembership newDictionaryMembership(QualifiedName id,
 QualifiedName dict,
 List<Entry> keyEntitySet,
 Collection<Attribute> attributes)

Specified by:

newDictionaryMembership in interface ModelConstructor

newDocument

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

A factory method to create an instance of a Document

Specified by:

newDocument in interface ModelConstructor

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

newDocument

public Document newDocument(Namespace namespace,
 List<StatementOrBundle> statementsOrBundles)

Description copied from interface: ModelConstructor

A factory method to create an instance of a Document

Specified by:

newDocument in interface ModelConstructor

Parameters:

namespace - the prefix namespace mapping for the current document

statementsOrBundles - a list of statements or bundles

Returns:

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

newEntity

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

Specified by:

newEntity in interface ModelConstructor

newHadMember

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

Specified by:

newHadMember in interface ModelConstructor

newMentionOf

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

Specified by:

newMentionOf in interface ModelConstructor

newNamedBundle

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

A factory method to create an instance of a Bundle Bundle

Specified by:

newNamedBundle in interface ModelConstructor

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

public 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.

Specified by:

newQualifiedName in interface ModelConstructor

Parameters:

namespace - a URI for the namespace

local - a local name

prefix - a string, which can be null.

Returns:

an instance of QualifiedName

newQualifiedName

public 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.

Specified by:

newQualifiedName in interface ModelConstructor

Parameters:

namespace - a URI for the namespace

local - a local name

prefix - a string, which can be null

flag - build flag.

Returns:

an instance of QualifiedName

newSpecializationOf

public SpecializationOf newSpecializationOf(QualifiedName e2,
 QualifiedName e1)

Specified by:

newSpecializationOf in interface ModelConstructor

newUsed

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

A factory method to create an instance of a Usage Used

Specified by:

newUsed in interface ModelConstructor

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

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

A factory method to create an instance of an Association WasAssociatedWith

Specified by:

newWasAssociatedWith in interface ModelConstructor

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

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

A factory method to create an instance of an attribution WasAttributedTo

Specified by:

newWasAttributedTo in interface ModelConstructor

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

public 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

Specified by:

newWasDerivedFrom in interface ModelConstructor

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 - an identifier for the activity underpinning the derivation

generation - an identifier for the generation associated with the derivation

usage - an identifier for the usage associated with the derivation

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

Returns:

an instance of WasDerivedFrom

newWasEndedBy

public 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

Specified by:

newWasEndedBy in interface ModelConstructor

Parameters:

id - an optional identifier for a end

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

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

A factory method to create an instance of a generation WasGeneratedBy

Specified by:

newWasGeneratedBy in interface ModelConstructor

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

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

A factory method to create an instance of an influence WasInfluencedBy

Specified by:

newWasInfluencedBy in interface ModelConstructor

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

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

A factory method to create an instance of an communication WasInformedBy

Specified by:

newWasInformedBy in interface ModelConstructor

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

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

A factory method to create an instance of an invalidation WasInvalidatedBy

Specified by:

newWasInvalidatedBy in interface ModelConstructor

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

public 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

Specified by:

newWasStartedBy in interface ModelConstructor

Parameters:

id - an optional identifier for a start

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

public void startBundle(QualifiedName bundleId,
 Namespace namespace)

Specified by:

startBundle in interface ModelConstructor

startDocument

public void startDocument(Namespace namespace)

Specified by:

startDocument in interface ModelConstructor

newRole

public Role newRole(Object value,
 QualifiedName type)

Specified by:

newRole in interface AtomConstructor

newLocation

public Location newLocation(Object value,
 QualifiedName type)

Specified by:

newLocation in interface AtomConstructor

newType

public Type newType(Object value,
 QualifiedName type)

Specified by:

newType in interface AtomConstructor

newLabel

public Label newLabel(Object value,
 QualifiedName type)

Specified by:

newLabel in interface AtomConstructor

newInternationalizedString

public LangString newInternationalizedString(String s,
 String lang)

Specified by:

newInternationalizedString in interface AtomConstructor

newValue

public Value newValue(Object value,
 QualifiedName type)

Specified by:

newValue in interface AtomConstructor

newOther

public Other newOther(QualifiedName elementName,
 Object value,
 QualifiedName type)

Specified by:

newOther in interface AtomConstructor

newInternationalizedString

public LangString newInternationalizedString(String s)

Specified by:

newInternationalizedString in interface AtomConstructor