Module prov.model

Package org.openprovenance.prov.model

Interface Document

All Known Implementing Classes:

Document

public interface Document

Interface for a PROV Document.

PROV-N Definition for Document: A document is a house-keeping construct of PROV-N capable of packaging up PROV-N expressions and namespace declarations. A document forms a self-contained package of provenance descriptions for the purpose of exchanging them. A document may be used to package up PROV-N expressions in response to a request for the provenance of something.

Relevant Factory Methods:

• ProvFactory.newDocument()
• ModelConstructor.newDocument(Namespace, java.util.Collection, java.util.Collection)
• ProvFactory.newDocument(java.util.Collection, java.util.Collection, java.util.Collection, java.util.Collection)

Schema Definition:

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

 <complexType name="Document">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <choice maxOccurs="unbounded">
           <group ref="{http://www.w3.org/ns/prov#}documentElements"/>
           <element name="bundleContent" type="{http://www.w3.org/ns/prov#}NamedBundle"/>
         </choice>
       </sequence>
     </restriction>
   </complexContent>
 </complexType>
 

Author:

lavm

See Also:

• PROV-N Document
• PROV-XML Document

Method Summary

Modifier and Type	Method	Description
Namespace	getNamespace()	Accessor for the Namespace object containing registered prefix/namespaces for the current document.#
List<StatementOrBundle>	getStatementOrBundle()	Gets the value of the statementOrBundle property.
void	setNamespace(Namespace namespace)	Sets the Namespace of this document

Method Details

getNamespace

Namespace getNamespace()

Accessor for the Namespace object containing registered prefix/namespaces for the current document.#

Returns:

an instance of Namespace

getStatementOrBundle

List<StatementOrBundle> getStatementOrBundle()

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

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

    getStatementOrBundle().add(newItem);
 

Objects of the following type(s) are allowed in the list Entity Activity WasGeneratedBy Used WasInformedBy WasStartedBy WasEndedBy WasInvalidatedBy WasDerivedFrom Agent WasAttributedTo WasAssociatedWith ActedOnBehalfOf WasInfluencedBy SpecializationOf AlternateOf HadMember MentionOf DictionaryMembership DerivedByInsertionFrom DerivedByRemovalFrom Bundle

Returns:

a list of StatementOrBundle

setNamespace

void setNamespace(Namespace namespace)

Sets the Namespace of this document

Parameters:

namespace - an instance Namespace