Module prov.model

Package org.openprovenance.prov.model

Interface TypedValue

All Known Subinterfaces:

Attribute, Key, Label, Location, Other, Role, Type, Value

All Known Implementing Classes:

Key, Label, Location, Other, Role, Type, TypedValue, Value

public interface TypedValue

Interface for a PROV value.

PROV-DM Definition for Value: A value is a constant such as a string, number, time, qualified name, IRI, and encoded binary data, whose interpretation is outside the scope of PROV. Values can occur in attribute-value pairs.

In the Java implementation, a TypedValue can be seen as an object with two properties: a value and a type.

The type is expressed as a QualifiedName, whereas the value is normally expected to be a string. (Two notable exceptions are qualified names whose external representation is dependent on the choice of prefix, and langString which also have a language property.

Relevant Factory Methods:

• ProvFactory.newKey(Object, QualifiedName)
• ProvFactory.newLocation(Object, QualifiedName)
• ProvFactory.newOther(QualifiedName, Object, QualifiedName)
• ProvFactory.newRole(Object, QualifiedName)
• ProvFactory.newType(Object, QualifiedName)
• ProvFactory.newValue(Object, QualifiedName)

Schema Definition:

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

 <complexType name="Location">
   <simpleContent>
     <extension base="<http://www.w3.org/2001/XMLSchema>anySimpleType">
       <attribute name="type" type="{http://www.w3.org/2001/XMLSchema}QName" />
     </extension>
   </simpleContent>
 </complexType>
 

See Also:

• PROV-DM Value
• PROV-N Literal
• PROV-XML Value
• PROV-JSON Data Typing

Method Summary

Modifier and Type	Method	Description
Object	convertValueToObject(ValueConverter vconv)	Converts the value associated with the value property into a Java object.
Object	getConvertedValue()	Returns the cached converted value for the value property .
QualifiedName	getType()	Gets the type, expressed as a QualifiedName
Object	getValue()	Gets the value of the value property.
void	setType(QualifiedName value)	Sets the value of the type property.
void	setValue(String value)	Sets the value property.
void	setValue(LangString value)	Sets the value property.
void	setValue(QualifiedName value)	Sets the value property.
void	setValueFromObject(Object value)	Sets the value of the value property.

Method Details

convertValueToObject

Object convertValueToObject(ValueConverter vconv)

Converts the value associated with the value property into a Java object.

Parameters:

vconv - value converter

Returns:

possible object is Object

getType

QualifiedName getType()

Gets the type, expressed as a QualifiedName

Returns:

possible object is QualifiedName

getValue

Object getValue()

Gets the value of the value property.

Returns:

possible object of String, QualifiedName, LangString

getConvertedValue

Object getConvertedValue()

Returns the cached converted value for the value property .

Returns:

possible object is Object

setType

void setType(QualifiedName value)

Sets the value of the type property.

Parameters:

value - allowed object is QualifiedName

setValue

void setValue(LangString value)

Sets the value property.

Parameters:

value - allowed object is LangString

setValue

void setValue(QualifiedName value)

Sets the value property.

Parameters:

value - allowed object is QualifiedName

setValue

void setValue(String value)

Sets the value property.

Parameters:

value - allowed object is String

setValueFromObject

void setValueFromObject(Object value)

Sets the value of the value property.

Parameters:

value - allowed object is Object