Package org.gcube.informationsystem.base.reference

Interface Element

All Superinterfaces:

Serializable

All Known Subinterfaces:

ConsistsOf<S,T>, ConsistsOfSchema, Context, Encrypted, Entity, EntityElement, EntitySchema, ERElement, Event, Facet, FacetSchema, IdentifiableElement, IsRelatedTo<S,T>, IsRelatedToSchema, LinkedEntity, Metadata, ModelElement, PropagationConstraint, Property, PropertyDefinition, PropertyElement, PropertySchema, QueryTemplate, QueryTemplateReference, Relation<S,T>, RelationElement<S,T>, RelationSchema<S,T>, Resource, ResourceSchema, SchemaMixedElement, TemplateVariable, Type, TypeProjection

All Known Implementing Classes:

ConsistsOfImpl, ConsistsOfSchemaImpl, ContextImpl, DummyFacet, DummyIsRelatedTo, DummyResource, ElementImpl, EncryptedImpl, EntityElementImpl, EntityImpl, EntitySchemaImpl, EventImpl, FacetImpl, FacetSchemaImpl, IsRelatedToImpl, IsRelatedToSchemaImpl, LinkedEntityImpl, MetadataImpl, PropagationConstraintImpl, PropertyDefinitionImpl, PropertyElementImpl, PropertyImpl, PropertySchemaImpl, QueryTemplateImpl, QueryTemplateReferenceImpl, RelationElementImpl, RelationImpl, RelationSchemaImpl, ResourceImpl, ResourceSchemaImpl, TemplateVariableImpl, TypeImpl, TypeProjectionImpl

@TypeMetadata(name="Element",
              description="The base type for all elements in the Information System model; provides a common foundation for serialization and type identification during JSON processing.",
              version="1.0.0")
@Change(version="1.0.0",
        description="First Version")
public interface Element
extends Serializable

The base interface for all elements in the Information System model.

This interface provides a common foundation for various types of elements, ensuring they are serializable and can be identified by type during JSON processing. It defines constants for type identification and date-time formatting.

Author:

Luca Frosini (ISTI - CNR)

See Also:

IdentifiableElement, SchemaMixedElement

Field Summary

Fields

Modifier and Type	Field	Description
static String	DATETIME_PATTERN	The standard date-time pattern used for serializing and deserializing dates across all elements.
static String	NAME	The name of the element type.
static String	REDACTED	The standard placeholder string used to mask sensitive fields in responses for non-privileged users.
static String	TYPE_PROPERTY	The name of the property used to store the type of the element during JSON serialization.
static String	UNKNOWN_USER	The standard placeholder string used for an unresolvable or unknown user.

Method Summary

Modifier and Type	Method	Description
String	getTypeName()	Returns the name of the element's type.

Field Detail

NAME

static final String NAME

The name of the element type.

See Also:

Constant Field Values

TYPE_PROPERTY

static final String TYPE_PROPERTY

The name of the property used to store the type of the element during JSON serialization.

See Also:

Constant Field Values

DATETIME_PATTERN

static final String DATETIME_PATTERN

The standard date-time pattern used for serializing and deserializing dates across all elements. The pattern is "yyyy-MM-dd HH:mm:ss.SSS Z".

See Also:

Constant Field Values

REDACTED

static final String REDACTED

The standard placeholder string used to mask sensitive fields in responses for non-privileged users.

See Also:

Constant Field Values

UNKNOWN_USER

static final String UNKNOWN_USER

The standard placeholder string used for an unresolvable or unknown user.

See Also:

Constant Field Values

Method Detail

getTypeName

String getTypeName()

Returns the name of the element's type. This is typically used for type identification in serialized forms.

Returns:

The type name of the element.