Package io.micronaut.data.model

Interface Association

All Superinterfaces:

io.micronaut.core.annotation.AnnotationMetadataProvider, io.micronaut.core.annotation.AnnotationSource, io.micronaut.core.naming.Named, PersistentElement, PersistentProperty

All Known Subinterfaces:

Embedded

All Known Implementing Classes:

RuntimeAssociation, SourceAssociation

public interface Association
extends PersistentProperty

A property that represents an association.

Since:

1.0

Author:

graemerocher

Nested Class Summary

Nested classes/interfaces inherited from interface io.micronaut.data.model.PersistentProperty

PersistentProperty.EnumConstant

Field Summary

Fields inherited from interface io.micronaut.core.annotation.AnnotationSource

EMPTY

Method Summary

Modifier and Type	Method	Description
default boolean	doesCascade(Relation.Cascade... types)	Whether this association cascades the given types.
default String	getAliasName()
@NonNull PersistentEntity	getAssociatedEntity()	The associated entity if any.
default EnumSet<Relation.Cascade>	getCascadeTypes()
default Optional<PersistentAssociationPath>	getInversePathSide()	Retrieves the inverse side path of the association.
default Optional<? extends Association>	getInverseSide()	Retrieves the inverse side of the association.
default Relation.Kind	getKind()
default boolean	hasDeclaredAliasName()
default boolean	isBidirectional()	Whether the relationship is bidirectional.
default boolean	isForeignKey()
default boolean	isSingleEnded()	Determines whether this association is single-ended, meaning it only has one end point.

Methods inherited from interface io.micronaut.core.annotation.AnnotationMetadataProvider

findAnnotation, findAnnotation, findDeclaredAnnotation, findDeclaredAnnotation, getAnnotationMetadata, getTargetAnnotationMetadata, isAnnotationPresent, isDeclaredAnnotationPresent, synthesize, synthesizeAll, synthesizeAnnotationsByType, synthesizeDeclared, synthesizeDeclared, synthesizeDeclaredAnnotationsByType

Methods inherited from interface io.micronaut.core.annotation.AnnotationSource

getAnnotation, getAnnotation, getDeclaredAnnotation, getDeclaredAnnotation, isAnnotationPresent, isDeclaredAnnotationPresent, synthesize, synthesizeDeclared

Methods inherited from interface io.micronaut.data.model.PersistentElement

getPersistedName

Methods inherited from interface io.micronaut.data.model.PersistentProperty

getAlias, getCapitalizedName, getCapitilizedName, getConverter, getDataType, getEnumConstants, getJsonDataType, getName, getOwner, getTypeName, isAssignable, isAssignable, isAutoPopulated, isConstructorArgument, isEmbedded, isEnum, isGenerated, isOptional, isReadOnly, isRequired

Method Details

getAliasName

default String getAliasName()

Returns:

The alias name representation.

hasDeclaredAliasName

default boolean hasDeclaredAliasName()

Returns:

whether this Association has a declared alias name

Since:

3.8

getAssociatedEntity

@NonNull
@NonNull PersistentEntity getAssociatedEntity()

The associated entity if any.

Returns:

The associated entity

getInverseSide

default Optional<? extends Association> getInverseSide()

Retrieves the inverse side of the association. If there is one.

Returns:

The association.

getInversePathSide

default Optional<PersistentAssociationPath> getInversePathSide()

Retrieves the inverse side path of the association. If there is one.

Returns:

The association.

isBidirectional

default boolean isBidirectional()

Whether the relationship is bidirectional.

Returns:

True if it is bidirectional.

getKind

@NonNull
default Relation.Kind getKind()

Returns:

The relationship kind

isForeignKey

default boolean isForeignKey()

Returns:

Whether the association is a foreign key association

isSingleEnded

default boolean isSingleEnded()

Determines whether this association is single-ended, meaning it only has one end point. An association is considered single-ended if its kind is either ONE_TO_ONE or MANY_TO_ONE, but not EMBEDDED.

Returns:

True if the association is single-ended, false otherwise.

doesCascade

default boolean doesCascade(Relation.Cascade... types)

Whether this association cascades the given types.

Parameters:

types - The types

Returns:

True if it does, false otherwise.

getCascadeTypes

default EnumSet<Relation.Cascade> getCascadeTypes()