org.openprovenance.prov.model

Interface WasDerivedFrom

All Superinterfaces:

HasLabel, HasOther, HasType, Identifiable, Influence, QualifiedRelation, Relation, Statement, StatementOrBundle

public interface WasDerivedFrom
extends Identifiable, HasLabel, HasType, HasOther, Influence

Interface for PROV Derivation association.

PROV-DM Definition for Derivation: A derivation is a transformation of an entity into another, an update of an entity resulting in a new one, or the construction of a new entity based on a pre-existing entity.

The constructor method ProvFactory.newWasDerivedFrom(QualifiedName, QualifiedName, QualifiedName) can be used to create an instance of WasDerivedFrom. The following code snippet creates a new derivation statement, with a type attribute. The instance of derivation is given an identifier myId.

 QualifiedName myId= ... ;  // some qualified name
 QualifiedName effectId= ... ;  // some qualified name
 QualifiedName causeId= ... ;   // some qualified name
 WasDerivedFrom myWasDerivedFrom=provFactory.newWasDerivedFrom(myId,effectId,causeId)
 myWasDerivedFrom.getType().add(provFactory.newType(Name.PROV_REVISION))
 

Relevant Factory Methods:

• ProvFactory.newWasDerivedFrom(QualifiedName, QualifiedName, QualifiedName)
• ObjectFactory.createWasDerivedFrom()

Schema Definition:

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

 <complexType name="Derivation">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element name="generatedEntity" type="{http://www.w3.org/ns/prov#}IDRef"/>
         <element name="usedEntity" type="{http://www.w3.org/ns/prov#}IDRef"/>
         <element name="activity" type="{http://www.w3.org/ns/prov#}IDRef" minOccurs="0"/>
         <element name="generation" type="{http://www.w3.org/ns/prov#}IDRef" minOccurs="0"/>
         <element name="usage" type="{http://www.w3.org/ns/prov#}IDRef" minOccurs="0"/>
         <element ref="{http://www.w3.org/ns/prov#}label" 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 Derivation, PROV-O Derivation, PROV-N Derivation, PROV-XML Derivation, PROV-JSON Derivation

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	getGeneratedEntity()
QualifiedName	getGeneration()
QualifiedName	getUsage()
QualifiedName	getUsedEntity()
void	setActivity(QualifiedName aid)
void	setGeneratedEntity(QualifiedName aid1)
void	setGeneration(QualifiedName did1)
void	setUsage(QualifiedName did2)
void	setUsedEntity(QualifiedName aid2)

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

setUsedEntity

void setUsedEntity(QualifiedName aid2)

setGeneratedEntity

void setGeneratedEntity(QualifiedName aid1)

setActivity

void setActivity(QualifiedName aid)

setGeneration

void setGeneration(QualifiedName did1)

setUsage

void setUsage(QualifiedName did2)

getGeneratedEntity

QualifiedName getGeneratedEntity()

getGeneration

QualifiedName getGeneration()

getUsedEntity

QualifiedName getUsedEntity()

getUsage

QualifiedName getUsage()

getActivity

QualifiedName getActivity()