Interface Facet
- All Superinterfaces:
Element,Entity,EntityElement,ERElement,IdentifiableElement,ModelElement,SchemaMixedElement,Serializable
- All Known Implementing Classes:
DummyFacet,FacetImpl
@TypeMetadata(name="Facet",
description="This is the base type for any Facet",
version="1.0.0")
@Change(version="1.0.0",
description="First Version")
public interface Facet
extends Entity, SchemaMixedElement
Represents a facet, which describes a specific aspect or dimension of a
Resource.
Facets are extensible entities that support additional properties not defined
in the formal schema, through the SchemaMixedElement interface. For
more details, refer to the
gCube Facet Based Resource Model Wiki.
- Author:
- Luca Frosini (ISTI - CNR)
- See Also:
-
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 TypeMethodDescriptionReturns a map of all additional properties not defined in the schema.Retrieves a single additional property by its key.voidsetAdditionalProperties(Map<String, Object> additionalProperties) Sets the map of additional properties for the element.voidsetAdditionalProperty(String key, Object value) Sets a single additional property.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.ModelElement
getExpectedtype, getSupertypes
-
Field Details
-
NAME
The name of the facet type.- See Also:
-
-
Method Details
-
getAdditionalProperties
Returns a map of all additional properties not defined in the schema.This method allows retrieving all additional properties of the facet that are not part of its defined schema.
- Specified by:
getAdditionalPropertiesin interfaceSchemaMixedElement- Returns:
- A
Mapcontaining the additional properties, where the key is the property name and the value is the property value.
-
setAdditionalProperties
Sets the map of additional properties for the element.- Specified by:
setAdditionalPropertiesin interfaceSchemaMixedElement- Parameters:
additionalProperties- AMapof additional properties.
-
getAdditionalProperty
Retrieves a single additional property by its key.- Specified by:
getAdditionalPropertyin interfaceSchemaMixedElement- Parameters:
key- The name of the additional property to retrieve.- Returns:
- The value of the property, or
nullif the key is not found.
-
setAdditionalProperty
Sets a single additional property.This method allows setting additional properties on the facet that are not part of its defined schema.
- Specified by:
setAdditionalPropertyin interfaceSchemaMixedElement- Parameters:
key- The name of the additional property.value- The value of the additional property.
-