DictionaryMembership.java

package org.openprovenance.prov.model;

import java.util.List;


/**
 * <p>Interface for PROV Dictionary Membership
 * 
 *  <p><a href="http://www.w3.org/TR/prov-dictionary/#term-dictionary-membership">A PROV Dictionary Definition for Membership</a>: 
 *  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. 
 * 
 * <p>
 * <p><span class="strong">Relevant Factory Methods:</span>
 * <ul>
 * <li> {@link ProvFactory#newDictionaryMembership(QualifiedName, List)}
 * <li> {@link ObjectFactory#createDictionaryMembership()}
 * </ul>
 * 
 * <p><span class="strong">Schema Definition:</span>
 * 
 * <p>The following schema fragment specifies the expected content contained within this class.
 * 
 * <pre>
 * <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>
 * </pre>
 * 
 * 
 * 
 * <p> 
 * @see <a href="http://www.w3.org/TR/prov-dictionary/#term-dictionary-membership">PROV-Dictionary Membership</a>
 * @see <a href="http://www.w3.org/TR/prov-dictionary/#hadDictionaryMember">PROV-O PROV-Dictionary Membership</a>
 * @see <a href="http://www.w3.org/TR/prov-dictionary/#expression-dictionary-membership">PROV-N PROV-Dictionary Membership</a>
 * @see <a href="http://www.w3.org/TR/prov-dictionary/#term-DictionaryMembership">PROV-XML PROV-Dictionary Membership</a>
 * 
 * 
 */
public interface DictionaryMembership extends Relation {

    /**
     * Get an identifier for the dictionary whose members are asserted.
     * @return {@link QualifiedName} of the dictionary
     * @see <a href="http://www.w3.org/TR/prov-dictionary/#membership-d.dictionary">membership dictionary</a>
     */
    QualifiedName getDictionary();
    
    /**
     * 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, {@link DictionaryMembership} allows for multiple pairs
     * to be asserted. 
     * @return a list of {@link Entry}
     * @see <a href="http://www.w3.org/TR/prov-dictionary/#membership-d.entity">membership entity</a>
     * @see <a href="http://www.w3.org/TR/prov-dictionary/#membership-d.key">membership key</a>
     */

    List<Entry> getKeyEntityPair();

    
    /**
     * Set an identifier for the dictionary whose members are asserted.
     * @param dictionary a {@link QualifiedName} of the dictionary
     * @see <a href="http://www.w3.org/TR/prov-dictionary/#membership-d.dictionary">membership dictionary</a>
     */
    void setDictionary(QualifiedName dictionary);

}