Interface Neo4jPersistentProperty

All Superinterfaces:

GraphPropertyDescription, PersistentProperty<Neo4jPersistentProperty>

@API(status=STABLE,
     since="6.0")
public interface Neo4jPersistentProperty
extends PersistentProperty<Neo4jPersistentProperty>, GraphPropertyDescription

A PersistentProperty interface with additional methods for metadata related to Neo4j.

Since:

6.0

Author:

Michael J. Simons, Philipp Tölle, Gerrit Meier

Method Summary

Modifier and Type	Method	Description
default String	computePrefixWithDelimiter()	Computes a prefix to be used on multiple properties on a node when this persistent property is annotated with @CompositeProperty.
@Nullable Neo4jPersistentPropertyConverter<?>	getOptionalConverter()
default boolean	isDynamicAssociation()	Dynamic associations are associations to non-simple types stored in a map with a key type of java.lang.String or enum.
default boolean	isDynamicLabels()	Flag if this property points to a collection of dynamic labels for the owning entity.
default boolean	isDynamicOneToManyAssociation()	Dynamic one-to-many associations are associations to non-simple types stored in a map with a key type of java.lang.String and values of java.util.Collection.
boolean	isEntityWithRelationshipProperties()	Returns true if this property belongs to a relationship.
default boolean	isReadOnly()	A flag is this is a read only property, can be changed via PersistentPropertyCharacteristics.
default boolean	isVectorProperty()

Methods inherited from interface GraphPropertyDescription

getActualType, getFieldName, getPropertyName, isComposite, isIdProperty, isInternalIdProperty, isRelationship

Methods inherited from interface PersistentProperty

findAnnotation, findPropertyOrOwnerAnnotation, getAccessorForOwner, getActualType, getAssociation, getAssociationTargetType, getAssociationTargetTypeInformation, getComponentType, getField, getGetter, getMapValueType, getName, getOwner, getPersistentEntityTypeInformation, getRawType, getRequiredAnnotation, getRequiredAssociation, getRequiredField, getRequiredGetter, getRequiredSetter, getRequiredWither, getSetter, getSpelExpression, getType, getTypeInformation, getWither, hasActualTypeAnnotation, isAnnotationPresent, isArray, isAssociation, isCollectionLike, isEntity, isIdProperty, isImmutable, isMap, isReadable, isTransient, isVersionProperty, isWritable, usePropertyAccess

Method Details

isDynamicAssociation

default boolean isDynamicAssociation()

Dynamic associations are associations to non-simple types stored in a map with a key type of java.lang.String or enum.

Returns:

true, if this association is a dynamic association.

isDynamicOneToManyAssociation

default boolean isDynamicOneToManyAssociation()

Dynamic one-to-many associations are associations to non-simple types stored in a map with a key type of java.lang.String and values of java.util.Collection.

Returns:

true, if this association is a dynamic association with multiple values per type.

Since:

6.0.1

isDynamicLabels

default boolean isDynamicLabels()

Flag if this property points to a collection of dynamic labels for the owning entity.

Returns:

whether the property is a property describing dynamic labels

Since:

6.0

isVectorProperty

default boolean isVectorProperty()

getOptionalConverter

@Nullable Neo4jPersistentPropertyConverter<?> getOptionalConverter()

isEntityWithRelationshipProperties

boolean isEntityWithRelationshipProperties()

Returns true if this property belongs to a relationship.

Returns:

true if this property targets an entity which is a container for relationship properties.

computePrefixWithDelimiter

default String computePrefixWithDelimiter()

Computes a prefix to be used on multiple properties on a node when this persistent property is annotated with @CompositeProperty.

Returns:

a valid prefix

isReadOnly

default boolean isReadOnly()

A flag is this is a read only property, can be changed via PersistentPropertyCharacteristics.

Returns:

true if this is a read only property.