Package org.openprovenance.prov.model

Interface WasStartedBy

All Superinterfaces:

HasLabel, HasLocation, HasOther, HasRole, HasTime, HasType, Identifiable, Influence, QualifiedRelation, Relation, Statement, StatementOrBundle

All Known Implementing Classes:

WasStartedBy

public interface WasStartedBy
extends Identifiable, HasLabel, HasTime, HasType, HasRole, HasLocation, HasOther, Influence

Interface for PROV Start association.

PROV-DM Definition for Start: Start is when an activity is deemed to have been started by an entity, known as trigger. The activity did not exist before its start. Any usage, generation, or invalidation involving an activity follows the activity's start. A start may refer to a trigger entity that set off the activity, or to an activity, known as starter, that generated the trigger.

The constructor method ProvFactory.newWasStartedBy(QualifiedName, QualifiedName, QualifiedName, QualifiedName) can be used to create an instance of Start. The following code snippet creates a new start statement, with a role attribute, and current time. The instance of start is given an identifier myId.

 QualifiedName myId= ... ;  // some qualified name
 QualifiedName activityId= ... ;  // some activity qualified name
 QualifiedName triggerId= ... ;    // some trigger qualified name
 WasStartedBy myWasStartedBy=provFactory.newWasStartedBy(myId,activityId,triggerId,null);
 myWasStartedBy.getRole().add(provFactory.newRole("trigger"));
 myWasStartedBy.setTime(provFactory.newTimeNow())
 

Relevant Factory Methods:

• ProvFactory.newWasStartedBy(QualifiedName, QualifiedName, QualifiedName, QualifiedName)
• ProvFactory.newWasStartedBy(QualifiedName, QualifiedName, QualifiedName, QualifiedName, javax.xml.datatype.XMLGregorianCalendar, java.util.Collection)
• ObjectFactory.createWasStartedBy()

Schema Definition:

The following schema fragment specifies the expected content contained within this class.

 <complexType name="Start">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element name="activity" type="{http://www.w3.org/ns/prov#}IDRef"/>
         <element name="trigger" type="{http://www.w3.org/ns/prov#}IDRef" minOccurs="0"/>
         <element name="starter" type="{http://www.w3.org/ns/prov#}IDRef" minOccurs="0"/>
         <element name="time" type="{http://www.w3.org/2001/XMLSchema}dateTime" minOccurs="0"/>
         <element ref="{http://www.w3.org/ns/prov#}label" maxOccurs="unbounded" minOccurs="0"/>
         <element ref="{http://www.w3.org/ns/prov#}location" maxOccurs="unbounded" minOccurs="0"/>
         <element ref="{http://www.w3.org/ns/prov#}role" maxOccurs="unbounded" minOccurs="0"/>
         <element ref="{http://www.w3.org/ns/prov#}type" maxOccurs="unbounded" minOccurs="0"/>
         <any namespace='##other' maxOccurs="unbounded" minOccurs="0"/>
       </sequence>
       <attribute ref="{http://www.w3.org/ns/prov#}id"/>
     </restriction>
   </complexContent>
 </complexType>
 

See Also:

PROV-DM Start, PROV-O Start, PROV-N Start, PROV-XML Start, PROV-JSON Start

Nested Class Summary

Nested classes/interfaces inherited from interface org.openprovenance.prov.model.StatementOrBundle

StatementOrBundle.Kind

Method Summary

Modifier and Type	Method	Description
QualifiedName	getActivity()
QualifiedName	getStarter()
QualifiedName	getTrigger()
void	setActivity(QualifiedName aid)
void	setStarter(QualifiedName sid)
void	setTrigger(QualifiedName eid)

Methods inherited from interface org.openprovenance.prov.model.HasLabel

getLabel

Methods inherited from interface org.openprovenance.prov.model.HasLocation

getLocation

Methods inherited from interface org.openprovenance.prov.model.HasOther

getOther

Methods inherited from interface org.openprovenance.prov.model.HasRole

getRole

Methods inherited from interface org.openprovenance.prov.model.HasTime

getTime, setTime

Methods inherited from interface org.openprovenance.prov.model.HasType

getType

Methods inherited from interface org.openprovenance.prov.model.Identifiable

getId, setId

Methods inherited from interface org.openprovenance.prov.model.StatementOrBundle

getKind

Method Detail

getActivity

QualifiedName getActivity()

setActivity

void setActivity(QualifiedName aid)

getStarter

QualifiedName getStarter()

getTrigger

QualifiedName getTrigger()

setStarter

void setStarter(QualifiedName sid)

setTrigger

void setTrigger(QualifiedName eid)