Package org.gcube.informationsystem.types.reference.entities

Interface FacetSchema

All Superinterfaces:

Element, EntityElement, EntitySchema, IdentifiableElement, Serializable, Type

All Known Implementing Classes:

FacetSchemaImpl

@TypeMetadata(name="FacetSchema",
              description="Defines the type of a Facet, extending EntitySchema with the set of PropertyDefinitions that specify the Facet\'s properties.",
              version="1.0.0")
@Change(version="1.0.0",
        description="First Version")
public interface FacetSchema
extends EntitySchema

Defines the type of a Facet.

Author:

Luca Frosini (ISTI - CNR)

Field Summary

Fields

Modifier and Type	Field	Description
static final String	NAME	The name of the FacetSchema.

Fields inherited from interface org.gcube.informationsystem.base.reference.Element

DATETIME_PATTERN, REDACTED, TYPE_PROPERTY, UNKNOWN_USER

Fields inherited from interface org.gcube.informationsystem.base.reference.IdentifiableElement

ID_PROPERTY, METADATA_PROPERTY

Fields 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 Type	Method	Description
List<PropertyDefinition>	getProperties()	Returns the properties defined by this type.

Methods inherited from interface org.gcube.informationsystem.base.reference.Element

getTypeName

Methods inherited from interface org.gcube.informationsystem.base.reference.entities.EntityElement

getID, getMetadata, setID, setMetadata

Methods inherited from interface org.gcube.informationsystem.types.reference.entities.EntitySchema

getDescription, getExtendedTypes, getName, isAbstract

Methods 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

static final String NAME

The name of the FacetSchema.

See Also:

• Constant Field Values

Method Details

getProperties

@ISProperty(name="properties",
            readonly=false,
            mandatory=true)
List<PropertyDefinition> getProperties()

Returns the properties defined by this type.

A List because 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. A Set would map to an unordered store and lose it.

Specified by:

getProperties in interface Type

Returns:

The PropertyDefinitions, in declaration order.