org.openprovenance.prov.model

Interface DictionaryMembership

All Superinterfaces:

Relation, Statement, StatementOrBundle

public interface DictionaryMembership
extends Relation

Interface for PROV Dictionary Membership

A PROV Dictionary Definition for Membership: Similar to the collection membership relation, the dictionary membership allows stating the members of a Dictionary. However, it provides additional structure. Note that dictionary membership implies collection membership, but not vice versa.

Relevant Factory Methods:

• ProvFactory.newDictionaryMembership(QualifiedName, List)
• ObjectFactory.createDictionaryMembership()

Schema Definition:

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

 <complexType name="DictionaryMembership">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element name="dictionary" type="{http://www.w3.org/ns/prov#}IDRef"/>
         <element name="keyEntityPair" type="{http://www.w3.org/ns/prov#}KeyEntityPair" maxOccurs="unbounded"/>
       </sequence>
     </restriction>
   </complexContent>
 </complexType>
 

See Also:

PROV-Dictionary Membership, PROV-O PROV-Dictionary Membership, PROV-N PROV-Dictionary Membership, PROV-XML PROV-Dictionary Membership

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	getDictionary() Get an identifier for the dictionary whose members are asserted.
List<Entry>	getKeyEntityPair() A list of entries (key-entity pairs) that are members of the dictionary.
void	setDictionary(QualifiedName dictionary) Set an identifier for the dictionary whose members are asserted.

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

getKind

Method Detail

getDictionary

QualifiedName getDictionary()

Get an identifier for the dictionary whose members are asserted.

Returns:

QualifiedName of the dictionary

See Also:

membership dictionary

getKeyEntityPair

List<Entry> getKeyEntityPair()

A list of entries (key-entity pairs) that are members of the dictionary. Note that while the conceptual models allows for one key-entity pair to be asserted at the time, DictionaryMembership allows for multiple pairs to be asserted.

Returns:

a list of Entry

See Also:

membership entity, membership key

setDictionary

void setDictionary(QualifiedName dictionary)

Set an identifier for the dictionary whose members are asserted.

Parameters:

dictionary - a QualifiedName of the dictionary

See Also:

membership dictionary