The following sub-sections present all packages in the model with their types.
The packages are listed here in alphabetical order.
Each sub-section contains a description of the package and a table containing its various features.
vodml-id |
feature type |
description |
|
vo-dml:model |
Data model describing the structure and content of the IVOA Provenance Data Model. This re-uses the concepts from the W3C
Provenance DM, but extends it with a description layer for Activities and Entities. The « voprov » name has ben choosen to
avoid clashing with W3C « prov » namespace
|
Activity |
objectType |
A task executed at some time. It consumes products via relations of type Used and produces results via relations of type WasGeneratedBy.
The method applied for this task is described in the ActivityDescription class and its subtree.
|
Activity.activityDescription |
reference |
Points to the corresponding description class |
Activity.comment |
attribute |
A text about some peculiar information on the instance. |
Activity.endTime |
attribute |
Time when the Activity ends up. |
Activity.id |
attribute |
Unique identifier for an Activity. Must be unique in the domain. |
Activity.informant |
reference |
refers to an activity providing information |
Activity.name |
attribute |
Activity name |
Activity.startTime |
attribute |
This allows to know when the activity was launched .
This is might help to check dependencies and errors into the database.
|
Activity.used |
composition |
Gathers Entities used by the Activity instance |
Activity.wasAssociatedWith |
composition |
Gathers Agents bound to this Activity instance |
Activity.wasConfiguredBy |
composition |
Gathers Configuration elements for this Activity instance |
ActivityDescription |
objectType |
Gives further information on how an activity works internally. |
ActivityDescription.configFileDescription |
composition |
Gathers the description of the config files |
ActivityDescription.description |
attribute |
A descriptive text for this kind of activity |
ActivityDescription.docurl |
attribute |
Link to more documentation |
ActivityDescription.generationDescription |
composition |
This link points to some description of the results produced in the context of one specific ActivityDescription. |
ActivityDescription.name |
attribute |
Instance name |
ActivityDescription.parameterDescription |
composition |
Gathers the description classes explaining the Parameter object that can be applied when running an Activity that can follow
this ActivityDescription template.
|
ActivityDescription.subtype |
attribute |
More specific subtype of the activity |
ActivityDescription.type |
attribute |
type of the activity |
ActivityDescription.usageDescription |
composition |
This link points to some description of the Usage in the context of one specific ActivityDescription. |
ActivityDescription.version |
attribute |
Version number, if applicable |
Agent |
objectType |
A person or an organisation that was involved in the follow-up of an Activity, or can be credited for the production of an
Entity.
|
Agent.address |
attribute |
Agent's postmail address |
Agent.affiliation |
attribute |
Agent's affiliation |
Agent.comment |
attribute |
A text about some peculiar information on the instance. |
Agent.email |
attribute |
Email address of the Agent |
Agent.id |
attribute |
Unique identifier for an Agent. Must be unique in the domain. |
Agent.name |
attribute |
Agent name |
Agent.phone |
attribute |
Agent's phone number |
Agent.type |
attribute |
Defines the Agent type : Person, Organization or SoftwareAgent |
Agent.url |
attribute |
Reference URL to the agent |
AgentType |
enumeration |
A literal for specifying the Agent type : Individal or Organisation or SoftwareAgent |
AgentType.Organization |
literal |
Type label for agents considered as organizations |
AgentType.Person |
literal |
Type label for agents considered as persons |
AgentType.SoftwareAgent |
literal |
Type label for agents considered as software agents |
Collection |
objectType |
A collection of Entities. It is a way to consider a set of entities when produced and consumed with respect to an Activity.
Allows coarse description of the provenance.
|
Collection.entity |
reference |
Binds a collection entity to its members |
DatasetDescription |
objectType |
The description of a DatasetEntity. Can be pointed to by multiple instances of DatasetEntity. |
DatasetDescription.contentType |
attribute |
MIME-type or format of the dataset |
DatasetEntity |
objectType |
An Entity which represents a data file in the Provenance system. It is not the data file itself |
Entity |
objectType |
A thing which is consumed or produced in a task , namely here in the astronomical domain. It represents some data as single
element or file or an instrument.
|
Entity.comment |
attribute |
A text about some peculiar information on the instance. |
Entity.entityDescription |
reference |
Link to the corresponding EntityDescription instance. Many Entities may share the same EntityDescription instance. |
Entity.generatedAtTime |
attribute |
The time and date of generation for the entity. The format is chosen by the provider e.g. ISO 8601
|
Entity.id |
attribute |
Unique identifier for an Entity. Must be unique in the domain.
|
Entity.invalidatedAtTime |
attribute |
Date and time of invalidation of the entity. After that date, the entity is no longer available for any use. |
Entity.location |
attribute |
A path, a URL, coordinates or the name of a place. |
Entity.name |
attribute |
This is a text string which designate the Entity for display in application or diagrams . It can follow various syntax and
naming conventions depending on the Entity subclass : dataset, quality flag, device name convention, etc .
|
Entity.usedEntity |
reference |
The link from the progenitor Entity to its descendant. |
Entity.wasAttributedTo |
composition |
Gathers Agents to which the entity was attributed |
Entity.wasGeneratedBy |
composition |
Binds to the activity which generated this entity |
EntityDescription |
objectType |
This class is meant to store descriptive information for
different categories of entities.
|
EntityDescription.description |
attribute |
A descriptive text for this kind of entity |
EntityDescription.docurl |
attribute |
Link to more documentation |
EntityDescription.name |
attribute |
Instance name
|
EntityDescription.type |
attribute |
Type of the entity |
GenerationDescription |
objectType |
This class gathers description features about the products an ActivityDescription considers as output results. |
GenerationDescription.description |
attribute |
A descriptive text for this kind of entity generation |
GenerationDescription.entityDescription |
reference |
Points to the description of the used entities |
GenerationDescription.multiplicity |
attribute |
Number of expected input entities to be generated with the given role. The string syntax is similar to that of VO-DML in the
form ‘minOccurs..maxOccurs” or a single value if minOccurs and maxOccurs are identical.
|
GenerationDescription.role |
attribute |
A label that describes the function of what was produced. It is defined in the context of an ActivityDescription instance. |
GenerationDescription.type |
attribute |
Type of the entity generation. It is a free text attribute with some reserved words |
UsageDescription |
objectType |
This class gathers description features about the products an ActivityDescription considers as input resources. It can differentiate
various roles and types of Entities consumed by the task described by the corresponding ActivityDescription instance.
|
UsageDescription.description |
attribute |
A descriptive text for this kind of usage
|
UsageDescription.entityDescription |
reference |
Points to the description of the used entities |
UsageDescription.multiplicity |
attribute |
Number of expected input entities to be used with the given role. The string syntax is similar to that of VO-DML in the form
‘minOccurs..maxOccurs” or a single value if minOccurs and maxOccurs are identical.
|
UsageDescription.role |
attribute |
Function of the entity with respect to its usage by the activity. |
UsageDescription.type |
attribute |
type of the usage. It is a free text attribute with some reserved words |
Used |
objectType |
Binds an Activity to the Entities it consumes . |
Used.entity |
reference |
Points to the used entity |
Used.role |
attribute |
function of the entity with respect to the activity |
Used.time |
attribute |
Time at which the usage of an entity started |
Used.usageDescription |
reference |
This link points to some description of the Usage in the context of one specific ActivityDescription. |
ValueDescription |
objectType |
Description of the properties of a ValueEntity. |
ValueDescription.ucd |
attribute |
VO-compliant UCD string |
ValueDescription.unit |
attribute |
VO unit string |
ValueDescription.utype |
attribute |
Role of the value in the context of an external VO data mode |
ValueDescription.valueType |
attribute |
VOTable compliant data type of the parameter value |
ValueEntity |
objectType |
An entity that only contains a value. The way to interpret this value is described in the ValueDescription instance it linked
to.
|
ValueEntity.value |
attribute |
The value of the Entity. |
VotableFieldFormat |
primitiveType |
Field format as defined in the VOTable specification |
WasAssociatedWith |
objectType |
Denotes the assignment of responsibility to an agent for an activity. |
WasAssociatedWith.agent |
reference |
Points to the agent |
WasAssociatedWith.role |
attribute |
Function of the agent with respect to the activity
|
WasAttributedTo |
objectType |
Links an Agent to the Entity it is responsible for. Various roles for this relation are allowed and defined in the Provenance
vocabulary under TypeOfAgentRole
|
WasAttributedTo.agent |
reference |
Points to the agent. |
WasAttributedTo.role |
attribute |
Function of the agent with respect to the entity. |
WasGeneratedBy |
objectType |
Binds an Entity to the Activity that produced it as a result. |
WasGeneratedBy.activity |
reference |
points to the creating Activity instance. |
WasGeneratedBy.generationDescription |
reference |
Points to the instance of GenerationDescription describing this kind of generated output. |
WasGeneratedBy.role |
attribute |
Function of the entity with respect to the activity. |
ActivityConfiguration |
package |
This package gathers the necessary classes for expressing the configuration of a task before, during and after execution.
We consider only the executed version will be stored in a provenance information system.
|
ActivityConfiguration.ConfigFile |
objectType |
The values used to control the activity can be provided as a Configuration file document.
|
ActivityConfiguration.ConfigFile.comment |
attribute |
text containing comments on the config file |
ActivityConfiguration.ConfigFile.configFileDescription |
reference |
Points to the corresponding description class |
ActivityConfiguration.ConfigFile.location |
attribute |
Path or URL to the config file |
ActivityConfiguration.ConfigFile.name |
attribute |
Name of the file |
ActivityConfiguration.ConfigFileDescription |
objectType |
Properties of the configuration files |
ActivityConfiguration.ConfigFileDescription.contentType |
attribute |
MIME-type or format of the configuration file |
ActivityConfiguration.ConfigFileDescription.description |
attribute |
A text that explains the content and purpose of the configuration file. |
ActivityConfiguration.ConfigFileDescription.name |
attribute |
Name of the instance |
ActivityConfiguration.Parameter |
objectType |
A simple value which is part of the configuration of an activity instance |
ActivityConfiguration.Parameter.name |
attribute |
Name of the parameter |
ActivityConfiguration.Parameter.parameterDescription |
reference |
Gathers the properties and the description of the Parameter instance. |
ActivityConfiguration.Parameter.value |
attribute |
The value of the parameter. The data type, meaning, units, etc., are stored in the ParameterDescription instance bound to
it.
|
ActivityConfiguration.Parameter.valueEntity |
reference |
A Parameter instance can have a value derived from a ValueEntity value element computed previously by some former Activity
instance. Therefore, the ValueEntity it refers to is generated with another instance of the Activity class, in a different
generation scenario executed previously.
This references such a ValueEntity from the Parameter instance.
|
ActivityConfiguration.ParameterDescription |
objectType |
How to both use and interpret the parameter |
ActivityConfiguration.ParameterDescription.default |
attribute |
Default parameter value as a string whose value can be interpreted by the valueType attribute. |
ActivityConfiguration.ParameterDescription.description |
attribute |
A text that explains the content and purpose of this Parameter. |
ActivityConfiguration.ParameterDescription.max |
attribute |
Maximum parameter value as a string whose value can be interpreted by the valueType attribute |
ActivityConfiguration.ParameterDescription.min |
attribute |
Minimum parameter value as a string whose value can be interpreted by the valueType attribute |
ActivityConfiguration.ParameterDescription.name |
attribute |
Name of the parameter |
ActivityConfiguration.ParameterDescription.options |
attribute |
array of possible values |
ActivityConfiguration.ParameterDescription.ucd |
attribute |
Unified Content Descriptor, supplying a standardized classification of the physical quantity |
ActivityConfiguration.ParameterDescription.unit |
attribute |
VO unit string |
ActivityConfiguration.ParameterDescription.utype |
attribute |
Expresses the role of the parameter in the context of VO data mode text |
ActivityConfiguration.ParameterDescription.valueType |
attribute |
VOTable compliant data type of the parameter value |
ActivityConfiguration.TypeOfConfigArtefact |
enumeration |
The configuration for an Activity ( job) can be fully explicit , with a list of searchable parameters , or expressed into
a document file storing the configuration . This attribute contains the type of config information at the end of the wasConfiguredby
association instance .
|
ActivityConfiguration.TypeOfConfigArtefact.Configfile |
literal |
Label for config file config artifact |
ActivityConfiguration.TypeOfConfigArtefact.Parameter |
literal |
Label for parameter config artifact |
ActivityConfiguration.WasConfiguredBy |
objectType |
This is an association class binding an Activity Instance to one configuration artefact which can be a Parameter instance
or a ConfigFile instance .
Attribute "artefactType" holds the type of its target .
|
ActivityConfiguration.WasConfiguredBy.artefactType |
attribute |
Object type pointed by the instance
|
ActivityConfiguration.WasConfiguredBy.configFile |
reference |
Points to the configuration file |
ActivityConfiguration.WasConfiguredBy.parameter |
reference |
points to parameter |
This section lists the external models imported by the current data model.
For each imported model we list URLs to the VO-DML and HTML representations and the prefix used for vodml-ids from inside
the model.