Interface SchemaFacet
- All Superinterfaces:
org.gcube.informationsystem.base.reference.Element,org.gcube.informationsystem.model.reference.entities.Entity,org.gcube.informationsystem.base.reference.entities.EntityElement,org.gcube.informationsystem.model.reference.ERElement,org.gcube.informationsystem.model.reference.entities.Facet,org.gcube.informationsystem.base.reference.IdentifiableElement,org.gcube.informationsystem.model.reference.ModelElement,org.gcube.informationsystem.base.reference.SchemaMixedElement,Serializable
- All Known Implementing Classes:
SchemaFacetImpl
@TypeMetadata(name="SchemaFacet",
description="SchemaFacet captures information on any schema, i.e., a vocabulary used to validate a document associated with a resource. Examples of schema are JavaScript Object Notation (JSON) schema and XML schema. JSON schema \"is a vocabulary that allows you to annotate and validate JSON documents\". JSON schema is under standardisation by Internet Engineering Task force (IETF) (see references at https://json-schema.org/specification.html). XSD defines the legal building blocks of an XML document. DTD defines the structure and the legal elements and attributes of an XML document.",
version="1.0.0")
@Change(version="1.0.0",
description="First Version")
public interface SchemaFacet
extends org.gcube.informationsystem.model.reference.entities.Facet
SchemaFacet captures information on any schema,
i.e., a vocabulary used to validate a document associated with a resource.
Examples of schema are JavaScript Object Notation (JSON) schema and XML schema.
JSON schema "is a vocabulary that allows you to annotate and validate JSON documents".
JSON schema is under standardisation by Internet Engineering Task force (IETF)
(see references at https://json-schema.org/specification.html).
XSD defines the legal building blocks of an XML document.
DTD defines the structure and the legal elements and attributes of an XML document.
https://wiki.gcube-system.org/gcube/GCube_Model#Schema_Facet
- Author:
- Luca Frosini (ISTI - CNR)
-
Field Summary
FieldsFields inherited from interface org.gcube.informationsystem.base.reference.Element
DATETIME_PATTERN, TYPE_PROPERTYFields inherited from interface org.gcube.informationsystem.model.reference.ERElement
CONTEXTS_PROPERTYFields inherited from interface org.gcube.informationsystem.base.reference.IdentifiableElement
ID_PROPERTY, METADATA_PROPERTYFields inherited from interface org.gcube.informationsystem.model.reference.ModelElement
EXPECTED_TYPE_PROPERTY, SUPERTYPES_PROPERTY -
Method Summary
Modifier and TypeMethodDescriptiongetName()voidsetDescription(String description) voidvoidsetSchema(ValueSchema schema) Methods inherited from interface org.gcube.informationsystem.base.reference.Element
getTypeNameMethods inherited from interface org.gcube.informationsystem.base.reference.entities.EntityElement
getID, getMetadata, setID, setMetadataMethods inherited from interface org.gcube.informationsystem.model.reference.ERElement
getContextsMethods inherited from interface org.gcube.informationsystem.model.reference.entities.Facet
getAdditionalProperties, getAdditionalProperty, setAdditionalProperties, setAdditionalPropertyMethods inherited from interface org.gcube.informationsystem.model.reference.ModelElement
getExpectedtype, getSupertypes
-
Field Details
-
NAME
- See Also:
-
NAME_PROPERTY
- See Also:
-
-
Method Details
-
getName
@ISProperty(name="name", description="Schema Name", mandatory=true, nullable=false) String getName() -
setName
-
getDescription
@ISProperty(description="Schema Description", mandatory=true, nullable=false) String getDescription() -
setDescription
-
getSchema
@ISProperty(description="The \'value\' property contains the defined \'schema\' that in turn is validated by the schema available at the URL indicated in the \u2019schema\u2019 property. An example could be an XSD schema instantiation as \'value\' and the URL of the DTD defining the XSD as \'schema\' i.e., https://www.w3.org/2009/XMLSchema/XMLSchema.dtd.") ValueSchema getSchema() -
setSchema
-