Interface ResourceSchema
- All Superinterfaces:
Element,EntityElement,EntitySchema,IdentifiableElement,Serializable,Type
- All Known Implementing Classes:
ResourceSchemaImpl
@TypeMetadata(name="ResourceSchema",
description="Defines the type of a Resource, extending EntitySchema with the ConsistsOf and IsRelatedTo constraints (as LinkedEntity lists) that specify which Facet and Resource types it can be linked to.",
version="1.1.0")
@Change(version="1.1.0",description="\'consistsOf\' and \'isRelatedTo\' are always present, empty when the Resource declares none. A Resource type definition has no \'properties\'.") @Change(version="1.0.0",description="First Version")
public interface ResourceSchema
extends EntitySchema
Defines the type of a
Resource.- Author:
- Luca Frosini (ISTI - CNR)
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringThe property name for the ConsistsOf constraints (facets).static final StringThe property name for the IsRelatedTo constraints (related resources).static final StringThe name of the ResourceSchema.static final StringThe version of this type definition.Fields inherited from interface org.gcube.informationsystem.base.reference.Element
DATETIME_PATTERN, REDACTED, TYPE_PROPERTY, UNKNOWN_USERFields inherited from interface org.gcube.informationsystem.base.reference.IdentifiableElement
ID_PROPERTY, METADATA_PROPERTYFields inherited from interface org.gcube.informationsystem.types.reference.Type
ABSTRACT_PROPERTY, CHANGELOG_PROPERTY, DESCRIPTION_PROPERTY, EXTENDED_TYPES_PROPERTY, FINAL_PROPERTY, LOCKED_PROPERTY, NAME_PROPERTY, NAME_REGEX, PROPERTIES_PROPERTY, VERSION_PROPERTY -
Method Summary
Modifier and TypeMethodDescriptionReturns the list of ConsistsOf constraints (target Facet types) associated with this resource type.Returns the list of IsRelatedTo constraints (related resource types) for this resource type.Returns the properties defined by this type.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.types.reference.entities.EntitySchema
getDescription, getExtendedTypes, getName, isAbstractMethods inherited from interface org.gcube.informationsystem.types.reference.Type
getAccessType, getAdditionalProperties, getChangelog, getChangelogWithVersionAsString, getID, getMetadata, getVersion, getVersionAsString, isFinal, isLocked, setAdditionalProperty, setExtendedTypes, setID, setLocked, setMetadata
-
Field Details
-
NAME
The name of the ResourceSchema.- See Also:
-
VERSION
The version of this type definition.- See Also:
-
CONSISTS_OF_PROPERTY
The property name for the ConsistsOf constraints (facets).- See Also:
-
IS_RELATED_TO_PROPERTY
The property name for the IsRelatedTo constraints (related resources).- See Also:
-
-
Method Details
-
getProperties
List<PropertyDefinition> getProperties()Returns the properties defined by this type.A
Listbecause the order carries meaning: properties are read in the order the Java class declares them, which is the intended reading order for anyone looking at the type definition. ASetwould map to an unordered store and lose it.A Resource holds no property of its own:
propertiesis not a member of a Resource type definition, which neither writes it nor reads it.- Specified by:
getPropertiesin interfaceType- Returns:
- always
null.
-
getConsistsOf
Returns the list of ConsistsOf constraints (target Facet types) associated with this resource type.- Returns:
- A list of
LinkedEntityobjects representing the ConsistsOf constraints.
-
getIsRelatedTo
Returns the list of IsRelatedTo constraints (related resource types) for this resource type.- Returns:
- A list of
LinkedEntityobjects representing the IsRelatedTo constraints.
-