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 Summary

    Modifier and Type
    Method
    Description
    Class<?>
    getActualType()
    This will return the type of a simple property or the component type of a collection like property.
    String
    getFieldName()
    The name of the attribute of the mapped class.
    String
    getPropertyName()
    The name of the property as stored in the graph.
    boolean
    isComposite()
    Flag, if this is a composite property.
    boolean
    isIdProperty()
    True if this property is the id property.
    boolean
    isInternalIdProperty()
    Flag, if this is an internal id property.
    boolean
    isRelationship()
    Flag, if this is a relationship.

  • Method Details

    • getFieldName

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

    • getPropertyName

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

    • isIdProperty

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

    • isInternalIdProperty

      boolean isInternalIdProperty()
      Flag, if this is an internal id property.
      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()
      Flag, if this is a relationship.
      Returns:
      whether this property describes a relationship or not.

    • isComposite

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