Interface ClassificationFacet
- 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:
ClassificationFacetImpl
@TypeMetadata(name="ClassificationFacet",
description="ClassificationFacet captures classification scheme, taxonomy category and logical name to classify any resource inside the infrastructure.",
version="1.0.0")
@Change(version="1.0.0",
description="First version introducing taxonomy classification scheme, category and name fields.")
public interface ClassificationFacet
extends org.gcube.informationsystem.model.reference.entities.Facet
ClassificationFacet captures classification scheme, taxonomy category and
logical name to classify any resource inside the infrastructure.
- Author:
- Luca Frosini (ISTI - CNR)
-
Field Summary
FieldsFields 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 TypeMethodDescriptionThe category of the classification (e.g., "Database", "SearchEngine")The classification scheme or context of this taxonomy (e.g., "Infrastructure Management")static ClassificationFacetReturns a default instance of ClassificationFacetgetName()The logical/functional name associated with this classification context (e.g., "Ckan-DB")voidsetCategory(String category) Sets the category of the classificationvoidsetClassification(String classification) Sets the classification scheme or contextvoidSets the logical/functional nameMethods 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:
-
-
Method Details
-
getDefaultInstance
Returns a default instance of ClassificationFacet- Returns:
- a default instance of ClassificationFacet
-
getClassification
@ISProperty(description="The classification scheme or context of this taxonomy (e.g., \'Infrastructure Management\').", mandatory=true) String getClassification()The classification scheme or context of this taxonomy (e.g., "Infrastructure Management")- Returns:
- the classification
-
setClassification
Sets the classification scheme or context- Parameters:
classification- the classification
-
getCategory
@ISProperty(description="The category of the classification (e.g., \'Database\', \'SearchEngine\').", mandatory=true) String getCategory()The category of the classification (e.g., "Database", "SearchEngine")- Returns:
- the category
-
setCategory
Sets the category of the classification- Parameters:
category- the category
-
getName
@ISProperty(description="The logical/functional name associated with this classification context (e.g., \'Ckan-DB\').", mandatory=true) String getName()The logical/functional name associated with this classification context (e.g., "Ckan-DB")- Returns:
- the name
-
setName
Sets the logical/functional name- Parameters:
name- the name
-