Module prov.model

Package org.openprovenance.prov.vanilla

Class DictionaryMembership

java.lang.Object

org.openprovenance.prov.vanilla.DictionaryMembership

All Implemented Interfaces:

DictionaryMembership, HasLabel, HasOther, HasType, Identifiable, Relation, Statement, StatementOrBundle

public class DictionaryMembership
extends Object
implements DictionaryMembership, Identifiable, HasType, HasLabel, HasOther

Nested Class Summary

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

StatementOrBundle.Kind

Constructor Summary

Constructors

Constructor	Description
DictionaryMembership(QualifiedName id, QualifiedName dictionary, List<Entry> keyEntityPair, Collection<Attribute> attributes)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object object)
void	equals(Object object, org.openprovenance.apache.commons.lang.builder.EqualsBuilder equalsBuilder)
QualifiedName	getDictionary()	Get an identifier for the dictionary whose members are asserted.
QualifiedName	getId()	Gets the value of the id property.
List<Entry>	getKeyEntityPair()	A list of entries (key-entity pairs) that are members of the dictionary.
StatementOrBundle.Kind	getKind()	Gets the type of a provenance statement
List<LangString>	getLabel()	Gets the value of the label property.
List<Other>	getOther()	Gets the list of non-PROV attributes.
List<Type>	getType()	Gets the value of the prov:type property.
int	hashCode()
void	hashCode(org.openprovenance.apache.commons.lang.builder.HashCodeBuilder hashCodeBuilder)
void	setDictionary(QualifiedName dictionary)	Set an identifier for the dictionary whose members are asserted.
void	setId(QualifiedName id)	Sets the value of the id property.
String	toString()
void	toString(org.openprovenance.apache.commons.lang.builder.ToStringBuilder toStringBuilder)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

DictionaryMembership

public DictionaryMembership(QualifiedName id,
 QualifiedName dictionary,
 List<Entry> keyEntityPair,
 Collection<Attribute> attributes)

Method Details

getDictionary

public QualifiedName getDictionary()

Description copied from interface: DictionaryMembership

Get an identifier for the dictionary whose members are asserted.

Specified by:

getDictionary in interface DictionaryMembership

Returns:

QualifiedName of the dictionary

See Also:

• membership dictionary

getKeyEntityPair

public List<Entry> getKeyEntityPair()

Description copied from interface: DictionaryMembership

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.

Specified by:

getKeyEntityPair in interface DictionaryMembership

Returns:

a list of Entry

See Also:

• membership entity
• membership key

setDictionary

public void setDictionary(QualifiedName dictionary)

Description copied from interface: DictionaryMembership

Set an identifier for the dictionary whose members are asserted.

Specified by:

setDictionary in interface DictionaryMembership

Parameters:

dictionary - a QualifiedName of the dictionary

See Also:

• membership dictionary

getKind

public StatementOrBundle.Kind getKind()

Description copied from interface: StatementOrBundle

Gets the type of a provenance statement

Specified by:

getKind in interface StatementOrBundle

Returns:

StatementOrBundle.Kind

equals

public void equals(Object object,
 org.openprovenance.apache.commons.lang.builder.EqualsBuilder equalsBuilder)

equals

public boolean equals(Object object)

Overrides:

equals in class Object

hashCode

public void hashCode(org.openprovenance.apache.commons.lang.builder.HashCodeBuilder hashCodeBuilder)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public void toString(org.openprovenance.apache.commons.lang.builder.ToStringBuilder toStringBuilder)

toString

public String toString()

Overrides:

toString in class Object

getLabel

public List<LangString> getLabel()

Description copied from interface: HasLabel

Gets the value of the label property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the object. This is why there is not a set method for the label property.

For example, to add a new item, do as follows:

    getLabel().add(newItem);
 

Objects of the following type(s) are allowed in the list LangString

Specified by:

getLabel in interface HasLabel

Returns:

a List of strings

getOther

public List<Other> getOther()

Description copied from interface: HasOther

Gets the list of non-PROV attributes.

This accessor method returns a reference to the live list, not a snapshot. Therefore, any modification made to the returned list will be present inside the object. This is why there is not a set method for the role property.

For example, to add a new item, do as follows:

    getOther().add(newItem);
 

Specified by:

getOther in interface HasOther

Returns:

a list of objects of type Other

getType

public List<Type> getType()

Description copied from interface: HasType

Gets the value of the prov:type property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the type property.

For example, to add a new item, do as follows:

    getType().add(newItem);
 

Objects of the following type(s) are allowed in the list Type

Specified by:

getType in interface HasType

Returns:

a List of Type values

getId

public QualifiedName getId()

Description copied from interface: Identifiable

Gets the value of the id property. A null value means that the object has not been identified. Entity, Activity, Agent have a non-null identifier.

Specified by:

getId in interface Identifiable

Returns:

possible object is QualifiedName

setId

public void setId(QualifiedName id)

Description copied from interface: Identifiable

Sets the value of the id property.

Specified by:

setId in interface Identifiable

Parameters:

id - allowed object is QualifiedName