Interface DescriptiveMetadataFacet
- 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:
DescriptiveMetadataFacetImpl
@TypeMetadata(name="DescriptiveMetadataFacet",
description="DescriptiveMetadataFacet captures information on descriptive metadata to be associated with the resource. This facet is mainly used to attach metadata to a Dataset.",
version="1.1.0")
@Change(version="1.1.0",description="Replaced complex ValueSchema property for \'descriptiveMetadata\' with a clean, flat String representation.") @Change(version="1.0.0",description="First Version")
public interface DescriptiveMetadataFacet
extends org.gcube.informationsystem.model.reference.entities.Facet
DescriptiveMetadataFacet captures information on descriptive metadata
to be associated with the resource.
This facet is mainly used to attach metadata to a Dataset.
- Author:
- Luca Frosini (ISTI - CNR)
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringThe name associated with this facetstatic final StringThe version associated with this facetFields inherited from interface org.gcube.informationsystem.base.reference.Element
DATETIME_PATTERN, REDACTED, TYPE_PROPERTY, UNKNOWN_USERFields 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 TypeMethodDescriptionstatic DescriptiveMetadataFacetReturns a default instance of DescriptiveMetadataFacetA metadata record representing the descriptive metadata.voidsetDescriptiveMetadata(String metadata) Sets a metadata record representing the descriptive metadata.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
The name associated with this facet- See Also:
-
VERSION
The version associated with this facet- See Also:
-
-
Method Details
-
getDefaultInstance
Returns a default instance of DescriptiveMetadataFacet- Returns:
- a default instance of DescriptiveMetadataFacet
-
getDescriptiveMetadata
@ISProperty(type=java.lang.Object.class, description="A metadata record representing the descriptive metadata. Deliberately unconstrained: accepts any JSON-compatible value.", mandatory=true) String getDescriptiveMetadata()A metadata record representing the descriptive metadata. Deliberately unconstrained: accepts any JSON-compatible value (string, number, object, array, ...) since the concrete metadata standard in use (e.g., Dublin Core, DataCite) is not known in advance. The Java API always exposes it as aString.- Returns:
- the metadata
-
setDescriptiveMetadata
Sets a metadata record representing the descriptive metadata.- Parameters:
metadata- the metadata
-