org.openprovenance.prov.xml

Class Entity

java.lang.Object

org.openprovenance.prov.xml.Entity

All Implemented Interfaces:

org.jvnet.jaxb2_commons.lang.Equals, org.jvnet.jaxb2_commons.lang.HashCode, org.jvnet.jaxb2_commons.lang.ToString, Element, Entity, HasLabel, HasLocation, HasOther, HasType, HasValue, Identifiable, Statement, StatementOrBundle, HasAllAttributes

Direct Known Subclasses:

Bundle, Collection, Plan

public class Entity
extends Object
implements org.jvnet.jaxb2_commons.lang.Equals, org.jvnet.jaxb2_commons.lang.HashCode, org.jvnet.jaxb2_commons.lang.ToString, Entity, HasAllAttributes

Java class for Entity complex type.

An entity is a physical, digital, conceptual, or other kind of thing with some fixed aspects; entities may be real or imaginary. (PROV-DM Definition for Entity).

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

 <complexType name="Entity">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element ref="{http://www.w3.org/ns/prov#}label" maxOccurs="unbounded" minOccurs="0"/>
         <element ref="{http://www.w3.org/ns/prov#}location" maxOccurs="unbounded" minOccurs="0"/>
         <element ref="{http://www.w3.org/ns/prov#}type" maxOccurs="unbounded" minOccurs="0"/>
         <element ref="{http://www.w3.org/ns/prov#}value" minOccurs="0"/>
         <any processContents='skip' namespace='##other' maxOccurs="unbounded" minOccurs="0"/>
       </sequence>
       <attribute ref="{http://www.w3.org/ns/prov#}id"/>
     </restriction>
   </complexContent>
 </complexType>
 

Due to JAXB restrictions, it was not possible to parse attributes that had a QName as value. To avoid this problem, all attributes (except labels) are processed as <any/> The Entity bean still offers the convenience accessors getLocation, getType, getValue, getOthers, while automatically maintaining a sorted list of attributes to be compatible with prov-xml schema.

 <complexType name="Entity">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element ref="{http://www.w3.org/ns/prov#}label" maxOccurs="unbounded" minOccurs="0"/>
         <any processContents='skip' maxOccurs="unbounded" minOccurs="0"/>
       </sequence>
       <attribute ref="{http://www.w3.org/ns/prov#}id"/>
     </restriction>
   </complexContent>
 </complexType>
 

See Also:

PROV-DM Entity, PROV-O Entity, PROV-N Entity, PROV-XML Entity

Nested Class Summary

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

StatementOrBundle.Kind

Field Summary

Fields

Modifier and Type	Field and Description
protected List<Attribute>	all
protected QualifiedName	id
protected List<LangString>	label
protected List<Location>	location
protected List<Other>	others
protected List<Type>	type
protected Value	value

Constructor Summary

Constructors

Constructor and Description
Entity()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object object)
void	equals(Object object, org.apache.commons.lang.builder.EqualsBuilder equalsBuilder)
List<Attribute>	getAllAttributes() Gets the List of all attributes
QualifiedName	getId() Gets the value of the id property.
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 type property.
Value	getValue() Gets the value of the value property.
int	hashCode()
void	hashCode(org.apache.commons.lang.builder.HashCodeBuilder hashCodeBuilder)
void	setId(QualifiedName value) Sets the value of the id property.
void	setValue(Value value) Sets the value of the value property.
String	toString()
void	toString(org.apache.commons.lang.builder.ToStringBuilder toStringBuilder)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jvnet.jaxb2_commons.lang.Equals

equals

Methods inherited from interface org.jvnet.jaxb2_commons.lang.HashCode

hashCode

Field Detail

label

protected List<LangString> label

location

protected transient List<Location> location

type

protected transient List<Type> type

value

protected transient Value value

others

protected transient List<Other> others

all

protected List<Attribute> all

id

protected QualifiedName id

Constructor Detail

Entity

public Entity()

Method Detail

getLabel

public List<LangString> getLabel()

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 JAXB 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 InternationalizedString

Specified by:

getLabel in interface HasLabel

getLocation

public List<Location> getLocation()

Gets the value of the location 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 location property.

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

    getLocation().add(newItem);
 

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

Specified by:

getLocation in interface HasLocation

Returns:

a list of objects of type Location

getType

public List<Type> getType()

Gets the value of the 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

getValue

public Value getValue()

Gets the value of the value property.

Specified by:

getValue in interface HasValue

Returns:

possible object is Value

setValue

public void setValue(Value value)

Sets the value of the value property.

Specified by:

setValue in interface HasValue

Parameters:

value - allowed object is Value

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

getAllAttributes

public List<Attribute> getAllAttributes()

Gets the List of all attributes

Specified by:

getAllAttributes in interface HasAllAttributes

See Also:

org.openprovenance.prov.xml.HasAllAttributes#getAll()

getId

public QualifiedName getId()

Gets the value of the id property.

Specified by:

getId in interface Identifiable

Returns:

possible object is QualifiedName

setId

public void setId(QualifiedName value)

Sets the value of the id property.

Specified by:

setId in interface Identifiable

Parameters:

value - allowed object is QualifiedName

equals

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

equals

public boolean equals(Object object)

Overrides:

equals in class Object

hashCode

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

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

Specified by:

toString in interface org.jvnet.jaxb2_commons.lang.ToString

toString

public String toString()

Overrides:

toString in class Object

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