Package org.gcube.informationsystem.types.reference.relations

Interface RelationSchema<S extends EntitySchema,T extends EntitySchema>

Type Parameters:

S - The type of the source entity.

T - The type of the target entity.

All Superinterfaces:

Element, IdentifiableElement, RelationElement<S,T>, Serializable, Type

All Known Subinterfaces:

ConsistsOfSchema, IsRelatedToSchema

All Known Implementing Classes:

ConsistsOfSchemaImpl, IsRelatedToSchemaImpl, RelationSchemaImpl

@TypeMetadata(name="RelationSchema",
              description="The base type for all relation type definitions in the Information System model, specializing Type for the relation-type family (ConsistsOfSchema and IsRelatedToSchema).",
              version="1.0.0")
@Change(version="1.0.0",
        description="First Version")
public interface RelationSchema<S extends EntitySchema,T extends EntitySchema>
extends Type, RelationElement<S,T>

The base interface for all relation type definitions.

Author:

Luca Frosini (ISTI - CNR)

Field Summary

Fields

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

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.base.reference.relations.RelationElement

SOURCE_PROPERTY, TARGET_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
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.
List<PropertyDefinition>	getProperties()	Returns the properties defined by this type.
S	getSource()	Returns the source entity of the relation.
T	getTarget()	Returns the target entity of the relation.
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.relations.RelationElement

getID, getMetadata, setID, setMetadata, setSource, setTarget

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 Detail

NAME

static final String NAME

The name of the RelationSchema.

See Also:

Constant Field Values

Method Detail

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",
            readonly=true,
            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.

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.

getSource

S getSource()

Returns the source entity of the relation.

Specified by:

getSource in interface RelationElement<S extends EntitySchema,T extends EntitySchema>

Returns:

The source entity.

getTarget

T getTarget()

Returns the target entity of the relation.

Specified by:

getTarget in interface RelationElement<S extends EntitySchema,T extends EntitySchema>

Returns:

The target entity.