Module prov.model

Package org.openprovenance.prov.vanilla

Class Agent

java.lang.Object

org.openprovenance.prov.vanilla.Agent

All Implemented Interfaces:

org.openprovenance.apache.commons.lang.builder.Equals, org.openprovenance.apache.commons.lang.builder.HashCode, org.openprovenance.apache.commons.lang.builder.ToString, Agent, Element, HasLabel, HasLocation, HasOther, HasType, Identifiable, Statement, StatementOrBundle, HasAttributes

public class Agent
extends Object
implements Agent, org.openprovenance.apache.commons.lang.builder.Equals, org.openprovenance.apache.commons.lang.builder.HashCode, org.openprovenance.apache.commons.lang.builder.ToString, HasAttributes

Nested Class Summary

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

StatementOrBundle.Kind

Constructor Summary

Constructors

Constructor	Description
Agent(QualifiedName id, 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)
Collection<Attribute>	getAttributes()
QualifiedName	getId()	Gets the value of the id property.
Map<QualifiedName,Set<Attribute>>	getIndexedAttributes()
StatementOrBundle.Kind	getKind()	Gets the type of a provenance statement
List<LangString>	getLabel()	Gets the value of the label property.
List<Location>	getLocation()	Gets the value of the location 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	setId(QualifiedName value)	Sets the value of the id property.
void	setIndexedAttributes(Object qn, Set<Attribute> attributes)
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

Agent

public Agent(QualifiedName id,
 Collection<Attribute> attributes)

Method Details

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

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

setId

public void setId(QualifiedName value)

Description copied from interface: Identifiable

Sets the value of the id property.

Specified by:

setId in interface Identifiable

Parameters:

value - allowed object is QualifiedName

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

getLocation

public List<Location> getLocation()

Description copied from interface: HasLocation

Gets the value of the location property.

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 location property.

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

    getLocation().add(newItem);
 

Specified by:

getLocation in interface HasLocation

Returns:

a list of objects of type Location

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

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

equals

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

Specified by:

equals in interface org.openprovenance.apache.commons.lang.builder.Equals

equals

public boolean equals(Object object)

Overrides:

equals in class Object

hashCode

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

Specified by:

hashCode in interface org.openprovenance.apache.commons.lang.builder.HashCode

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

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

Specified by:

toString in interface org.openprovenance.apache.commons.lang.builder.ToString

toString

public String toString()

Overrides:

toString in class Object

getAttributes

public Collection<Attribute> getAttributes()

Specified by:

getAttributes in interface HasAttributes

setIndexedAttributes

public void setIndexedAttributes(Object qn,
 Set<Attribute> attributes)

getIndexedAttributes

public Map<QualifiedName,Set<Attribute>> getIndexedAttributes()

Specified by:

getIndexedAttributes in interface HasAttributes