Package org.gcube.informationsystem.model.impl.relations

Class RelationImpl<S extends Resource,T extends Entity>

java.lang.Object

org.gcube.informationsystem.base.impl.ElementImpl

org.gcube.informationsystem.base.impl.relations.RelationElementImpl<S,T>

org.gcube.informationsystem.model.impl.relations.RelationImpl<S,T>

All Implemented Interfaces:

Serializable, Element, IdentifiableElement, RelationElement<S,T>, SchemaMixedElement, ERElement, ModelElement, Relation<S,T>

Direct Known Subclasses:

ConsistsOfImpl, IsRelatedToImpl

public abstract class RelationImpl<S extends Resource,T extends Entity>
extends RelationElementImpl<S,T>
implements Relation<S,T>

The default abstract implementation of the Relation interface.

Upon instantiation, a unique, non-reserved identifier (UUID) is automatically generated and assigned by default, purely as a convenience so that callers are not forced to set an id explicitly on every instance. This default does not by itself provide idempotency across retries (e.g. of a PUT): a caller that needs the server to recognize a retried request as the same logical instance must capture and reuse an explicit UUID via RelationElementImpl.setID(UUID) — a freshly constructed instance always receives a new random id.

Author:

Luca Frosini (ISTI - CNR)

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected Map<String,Object>	additionalProperties	The additional properties of the relation.
protected final Set<String>	allowedAdditionalKeys	A set of keys that are allowed as additional properties, even if they start with '_' or '@'.
protected Map<UUID,String>	contexts	The contexts of the relation.
protected String	expectedtype	The expected type of the relation.
protected PropagationConstraint	propagationConstraint	The propagation constraint of the relation.
protected List<String>	supertypes	The supertypes of the relation.

Fields inherited from class org.gcube.informationsystem.base.impl.relations.RelationElementImpl

metadata, source, target, uuid

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

DATETIME_PATTERN, NAME, REDACTED, TYPE_PROPERTY, UNKNOWN_USER

Fields inherited from interface org.gcube.informationsystem.model.reference.ERElement

CONTEXTS_PROPERTY

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

ID_PROPERTY, METADATA_PROPERTY

Fields inherited from interface org.gcube.informationsystem.model.reference.ModelElement

EXPECTED_TYPE_PROPERTY, SUPERTYPES_PROPERTY

Fields inherited from interface org.gcube.informationsystem.model.reference.relations.Relation

NAME, PROPAGATION_CONSTRAINT_PROPERTY

Fields inherited from interface org.gcube.informationsystem.base.reference.relations.RelationElement

NAME, SOURCE_PROPERTY, TARGET_PROPERTY

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	RelationImpl()	Default constructor.
protected	RelationImpl(S source, T target, PropagationConstraint propagationConstraint)	Constructs a new RelationImpl with the given source, target, and propagation constraint.

Method Summary

Modifier and Type	Method	Description
Map<String,Object>	getAdditionalProperties()	Returns a map of all additional properties not defined in the schema.
Object	getAdditionalProperty(String key)	Retrieves a single additional property by its key.
Map<UUID,String>	getContexts()	Returns a map of contexts where this element is present.
String	getExpectedtype()	Returns the name of the expected type.
PropagationConstraint	getPropagationConstraint()	Returns the propagation constraint for this relation.
List<String>	getSupertypes()	Returns the list of supertypes for this element.
void	setAdditionalProperties(Map<String,Object> additionalProperties)	Sets the map of additional properties for the element.
void	setAdditionalProperty(String key, Object value)	Sets a single additional property.
protected void	setContexts(Map<UUID,String> contexts)	Sets the contexts of the relation.
void	setPropagationConstraint(PropagationConstraint propagationConstraint)	Sets the propagation constraint for this relation.

Methods inherited from class org.gcube.informationsystem.base.impl.relations.RelationElementImpl

getID, getMetadata, getSource, getTarget, setID, setMetadata, setSource, setTarget

Methods inherited from class org.gcube.informationsystem.base.impl.ElementImpl

getTypeName, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

getTypeName

Methods inherited from interface org.gcube.informationsystem.model.reference.relations.Relation

getSource, getTarget, setSource, setTarget

Methods inherited from interface org.gcube.informationsystem.base.reference.relations.RelationElement

getID, getMetadata, setID, setMetadata

Field Details

supertypes

protected List<String> supertypes

The supertypes of the relation.

expectedtype

protected String expectedtype

The expected type of the relation.

contexts

protected Map<UUID,String> contexts

The contexts of the relation.

propagationConstraint

protected PropagationConstraint propagationConstraint

The propagation constraint of the relation.

additionalProperties

protected Map<String,Object> additionalProperties

The additional properties of the relation.

allowedAdditionalKeys

protected final Set<String> allowedAdditionalKeys

A set of keys that are allowed as additional properties, even if they start with '_' or '@'.

Constructor Details

RelationImpl

protected RelationImpl()

Default constructor. Initializes the relation with an automatically generated, valid, and non-reserved UUID so that callers are not forced to set one explicitly. The identifier can be overridden using the setter, e.g. when the caller needs idempotency across retries.

RelationImpl

protected RelationImpl(S source,
 T target,
 PropagationConstraint propagationConstraint)

Constructs a new RelationImpl with the given source, target, and propagation constraint.

Parameters:

source - The source of the relation.

target - The target of the relation.

propagationConstraint - The propagation constraint of the relation.

Method Details

getSupertypes

public List<String> getSupertypes()

Returns the list of supertypes for this element.

This list is included in JSON serialization only if it is not empty.

Specified by:

getSupertypes in interface ModelElement

Returns:

A List of supertype names.

getExpectedtype

public String getExpectedtype()

Returns the name of the expected type.

This is used during deserialization to indicate the original type when a fallback to a supertype was necessary. It is included in JSON serialization only if it is not empty.

Specified by:

getExpectedtype in interface ModelElement

Returns:

The expected type name.

getContexts

public Map<UUID,String> getContexts()

Returns a map of contexts where this element is present.

The map keys are the context UUIDs, and the values are the context names. This property is included in JSON serialization only if it is not null.

Specified by:

getContexts in interface ERElement

Returns:

A Map of context UUIDs to context names, or null.

setContexts

protected void setContexts(Map<UUID,String> contexts)

Sets the contexts of the relation.

Parameters:

contexts - The contexts to set.

getPropagationConstraint

public PropagationConstraint getPropagationConstraint()

Returns the propagation constraint for this relation.

Specified by:

getPropagationConstraint in interface Relation<S extends Resource,T extends Entity>

Returns:

The PropagationConstraint.

setPropagationConstraint

public void setPropagationConstraint(PropagationConstraint propagationConstraint)

Sets the propagation constraint for this relation.

Specified by:

setPropagationConstraint in interface Relation<S extends Resource,T extends Entity>

Parameters:

propagationConstraint - The PropagationConstraint to set.

getAdditionalProperties

public Map<String,Object> getAdditionalProperties()

Returns a map of all additional properties not defined in the schema.

Specified by:

getAdditionalProperties in interface Relation<S extends Resource,T extends Entity>

Specified by:

getAdditionalProperties in interface SchemaMixedElement

Returns:

A Map containing the additional properties, where the key is the property name and the value is the property value.

setAdditionalProperties

public void setAdditionalProperties(Map<String,Object> additionalProperties)

Sets the map of additional properties for the element.

Specified by:

setAdditionalProperties in interface Relation<S extends Resource,T extends Entity>

Specified by:

setAdditionalProperties in interface SchemaMixedElement

Parameters:

additionalProperties - A Map of additional properties.

getAdditionalProperty

public Object getAdditionalProperty(String key)

Retrieves a single additional property by its key.

Specified by:

getAdditionalProperty in interface Relation<S extends Resource,T extends Entity>

Specified by:

getAdditionalProperty in interface SchemaMixedElement

Parameters:

key - The name of the additional property to retrieve.

Returns:

The value of the property, or null if the key is not found.

setAdditionalProperty

public void setAdditionalProperty(String key,
 Object value)

Sets a single additional property.

Specified by:

setAdditionalProperty in interface Relation<S extends Resource,T extends Entity>

Specified by:

setAdditionalProperty in interface SchemaMixedElement

Parameters:

key - The name of the additional property.

value - The value of the additional property.