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

Interface EntitySchema

All Superinterfaces:

Element, EntityElement, IdentifiableElement, Serializable, Type

All Known Subinterfaces:

FacetSchema, ResourceSchema

All Known Implementing Classes:

EntitySchemaImpl, FacetSchemaImpl, ResourceSchemaImpl

@TypeMetadata(name="EntitySchema",
              description="The base type for all entity type definitions in the Information System model, specializing Type for the entity-type family (FacetSchema and ResourceSchema).",
              version="1.0.0")
@Change(version="1.0.0",
        description="First Version")
public interface EntitySchema
extends Type, EntityElement

The base interface for all entity type definitions.

Author:

Luca Frosini (ISTI - CNR)

Field Summary

Fields

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

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, PROPERTIES_PROPERTY, VERSION_PROPERTY

Method Summary

Modifier and Type	Method	Description
String	getDescription()	Returns the description of the type.
List<String>	getExtendedTypes()	Returns the types that this type extends.
String	getName()	Returns the name of the type.
boolean	isAbstract()	Checks if the type is abstract.

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.Type

getAccessType, getAdditionalProperties, getChangelog, getChangelogWithVersionAsString, getID, getMetadata, getProperties, getVersion, getVersionAsString, isFinal, isLocked, setAdditionalProperty, setExtendedTypes, setID, setLocked, setMetadata

Field Details

NAME

static final String NAME

The name of the EntitySchema.

See Also:

• Constant Field Values

Method Details

getName

@ISProperty(name="name",
            readonly=true,
            mandatory=true)
String getName()

Returns the name of the type.

Specified by:

getName in interface Type

Returns:

The type name.

getDescription

@ISProperty(name="description",
            readonly=false,
            mandatory=true)
String getDescription()

Returns the description of the type.

Specified by:

getDescription in interface Type

Returns:

The type description.

isAbstract

@ISProperty(name="abstract",
            mandatory=true)
boolean isAbstract()

Checks if the type is abstract.

Specified by:

isAbstract in interface Type

Returns:

true if the type is abstract, false otherwise.

getExtendedTypes

@ISProperty(name="extendedTypes",
            readonly=true,
            mandatory=true)
List<String> getExtendedTypes()

Returns the types that this type extends.

A List because the order carries meaning: it is the declaration order of the direct parents -- the local precedence order C3 linearization requires -- and it must survive serialization and persistence unchanged. A Set would map to an unordered store and lose it.

Specified by:

getExtendedTypes in interface Type

Returns:

The parent type names, in declaration order.