org.gcube.resourcemanagement.model.reference.properties

Interface ValueSchema

All Superinterfaces:

org.gcube.informationsystem.base.reference.Element, GCubeProperty, org.gcube.informationsystem.model.reference.properties.Property, org.gcube.informationsystem.base.reference.properties.PropertyElement, org.gcube.informationsystem.base.reference.SchemaMixedElement, Serializable, TypedProperty<URI,String>, ValidatedTypedProperty<URI,String>

All Known Implementing Classes:

ValueSchemaImpl

@TypeMetadata(name="ValueSchema",
              description="This type aims at exposing a value which can be automatically managed by any client with no knowledge of its format.",
              version="1.0.0")
 @Change(version="1.0.0",
        description="First Version")
public interface ValueSchema
extends GCubeProperty, ValidatedTypedProperty<URI,String>

This type aims at exposing a value which can be automatically managed by any client with no knowledge of its format. The client can retrieve the schema at the provided URI, i.e., schema property, and use its content to understand/validate/manipulate the information contained in the value property. The client must have the capability to understand the semantics of content retrieved at the URI endpoint. Examples of application of such type are eXtensible Markup Language (XML) values which can be validated by a Document Type Definition (DTD) or XML Schema Definition (XSD).

Author:

Luca Frosini (ISTI - CNR)

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ValueSchema.SchemaValidator Validator for ValueSchema properties.

Field Summary

Fields

Modifier and Type	Field and Description
static String	NAME

Fields inherited from interface org.gcube.informationsystem.base.reference.Element

CLASS_PROPERTY, DATETIME_PATTERN, SUPERCLASSES_PROPERTY

Method Summary

Modifier and Type	Method and Description
URI	getSchema() An URI containing a schema used to validate/interpret the content of the value.
String	getValue() The value which schema is available at the URI provided in the schema property.
void	setSchema(URI schema)
void	setValue(String value)
default Validation	validate() Applies this validation to the property.

Methods inherited from interface org.gcube.informationsystem.model.reference.properties.Property

getAdditionalProperties, getAdditionalProperty, setAdditionalProperties, setAdditionalProperty

Field Detail

NAME

static final String NAME

See Also:

Constant Field Values

Method Detail

validate

default Validation validate()

Description copied from interface: ValidatedTypedProperty

Applies this validation to the property.

Specified by:

validate in interface ValidatedTypedProperty<URI,String>

Returns:

the validation result

getValue

@ISProperty(description="The value which schema is available at the URI provided in the schema property.",
            mandatory=true,
            nullable=false)
String getValue()

The value which schema is available at the URI provided in the schema property.

Specified by:

getValue in interface TypedProperty<URI,String>

setValue

void setValue(String value)

Specified by:

setValue in interface TypedProperty<URI,String>

getSchema

@ISProperty(description="An URI containing a schema used to validate/interpret the content of the value. It is only an informative field. The validation is in charge of the client.")
URI getSchema()

An URI containing a schema used to validate/interpret the content of the value. It is only an informative field. The validation is charge of the client.

Specified by:

getSchema in interface TypedProperty<URI,String>

setSchema

void setSchema(URI schema)

Specified by:

setSchema in interface TypedProperty<URI,String>