Package org.springframework.data.neo4j.core.mapping

Interface GraphPropertyDescription

All Known Subinterfaces:
Neo4jPersistentProperty
@API(status=STABLE, since="6.0") public interface GraphPropertyDescription
Provides minimal information how to map class attributes to the properties of a node or a relationship.

Spring Data's persistent properties have slightly different semantics. They have an entity centric approach of properties. Spring Data properties contain - if not marked otherwise - also associations.

Associations between different node types can be queried on the Schema itself.

Since:
6.0
Author:
Michael J. Simons

  • Method Details

    • getFieldName

      String getFieldName()
      Returns:
      The name of the attribute of the mapped class

    • getPropertyName

      String getPropertyName()
      Returns:
      The name of the property as stored in the graph.

    • isIdProperty

      boolean isIdProperty()
      Returns:
      True if this property is the id property.

    • isInternalIdProperty

      boolean isInternalIdProperty()
      Returns:
      True, if this property is the id property and the owner uses internal ids.

    • getActualType

      Class<?> getActualType()
      This will return the type of a simple property or the component type of a collection like property.
      Returns:
      The type of this property.

    • isRelationship

      boolean isRelationship()
      Returns:
      Whether this property describes a relationship or not.

    • isComposite

      boolean isComposite()
      Returns:
      True if the entity's property (this object) is stored as multiple properties on a node or relationship.