Interface Neo4jPersistentEntity<T>
- Type Parameters:
T
- type of the underlying class
- All Superinterfaces:
Aware
,EnvironmentAware
,Iterable<Neo4jPersistentProperty>
,MutablePersistentEntity<T,
,Neo4jPersistentProperty> NodeDescription<T>
,PersistentEntity<T,
Neo4jPersistentProperty>
@API(status=STABLE,
since="6.0")
public interface Neo4jPersistentEntity<T>
extends MutablePersistentEntity<T,Neo4jPersistentProperty>, NodeDescription<T>
A
PersistentEntity
interface with additional methods for metadata related to
Neo4j. Both Spring Data methods PersistentEntity.doWithProperties(PropertyHandler)
and
PersistentEntity.doWithAssociations(AssociationHandler)
are aware which field of a class is meant to be mapped as a property
of a node or a relationship or if it is a relationship (in Spring Data terms: if it is an association).
Note to the outside world, we treat the @TargetNode
annotated field of a @RelationshipProperties
annotated
class as association. Internally, we treat it as a property
- Since:
- 6.0
- Author:
- Michael J. Simons
-
Field Summary
Fields -
Method Summary
Modifier and TypeMethodDescriptionboolean
Determines if the entity is annotated withRelationshipProperties
default boolean
Methods inherited from interface org.springframework.context.EnvironmentAware
setEnvironment
Methods inherited from interface java.lang.Iterable
forEach, iterator, spliterator
Methods inherited from interface org.springframework.data.mapping.model.MutablePersistentEntity
addAssociation, addPersistentProperty, setEvaluationContextProvider, setPersistentPropertyAccessorFactory, verify
Methods inherited from interface org.springframework.data.neo4j.core.mapping.NodeDescription
addChildNodeDescription, containsPossibleCircles, describesInterface, getAdditionalLabels, getChildNodeDescriptionsInHierarchy, getGraphProperties, getGraphPropertiesInHierarchy, getGraphProperty, getIdDescription, getIdExpression, getMostAbstractParentLabel, getParentNodeDescription, getPrimaryLabel, getRelationships, getRelationshipsInHierarchy, getStaticLabels, getUnderlyingClass, isUsingInternalIds, setParentNodeDescription
Methods inherited from interface org.springframework.data.mapping.PersistentEntity
doWithAll, doWithAssociations, doWithAssociations, doWithProperties, doWithProperties, findAnnotation, getIdentifierAccessor, getIdProperty, getInstanceCreatorMetadata, getName, getPersistenceConstructor, getPersistentProperties, getPersistentProperty, getPersistentProperty, getPropertyAccessor, getPropertyPathAccessor, getRequiredAnnotation, getRequiredIdProperty, getRequiredPersistentProperty, getRequiredVersionProperty, getType, getTypeAlias, getTypeInformation, getVersionProperty, hasIdProperty, hasVersionProperty, isAnnotationPresent, isConstructorArgument, isCreatorArgument, isIdProperty, isImmutable, isNew, isVersionProperty, requiresPropertyPopulation
-
Field Details
-
DEPRECATED_GENERATED_ID_TYPES
-
-
Method Details
-
getDynamicLabelsProperty
Optional<Neo4jPersistentProperty> getDynamicLabelsProperty()- Returns:
- An optional property pointing to a
Collection<String>
containing dynamic "runtime managed" labels.
-
isRelationshipPropertiesEntity
boolean isRelationshipPropertiesEntity()Determines if the entity is annotated withRelationshipProperties
- Returns:
- true if this is a relationship properties class, otherwise false.
-
isUsingDeprecatedInternalId
default boolean isUsingDeprecatedInternalId()- Returns:
- True if the underlying domain classes uses
id()
to compute internally generated ids.
-