org.openprovenance.prov.model

Interface WasEndedBy

All Superinterfaces:

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

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

Interface for PROV End association.

PROV-DM Definition for End: End is when an activity is deemed to have been ended by an entity, known as trigger. The activity no longer exists after its end. Any usage, generation, or invalidation involving an activity precedes the activity's end. An end may refer to a trigger entity that terminated the activity, or to an activity, known as ender that generated the trigger.

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

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

Relevant Factory Methods:

• ProvFactory.newWasEndedBy(QualifiedName, QualifiedName, QualifiedName, QualifiedName)
• ProvFactory.newWasEndedBy(QualifiedName, QualifiedName, QualifiedName, QualifiedName, javax.xml.datatype.XMLGregorianCalendar, java.util.Collection)
• ObjectFactory.createWasEndedBy()

Schema Definition:

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

 <complexType name="End">
   <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="ender" 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 End, PROV-O End, PROV-N End, PROV-XML End, PROV-JSON End

Nested Class Summary

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

StatementOrBundle.Kind

Method Summary

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

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

getTime, setTime

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

getRole

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

getLocation

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

getId, setId

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

getLabel

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

getType

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

getOther

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

getKind

Method Detail

setActivity

void setActivity(QualifiedName aid)

setTrigger

void setTrigger(QualifiedName eid)

setEnder

void setEnder(QualifiedName sid)

getActivity

QualifiedName getActivity()

getTrigger

QualifiedName getTrigger()

getEnder

QualifiedName getEnder()