org.springframework.data.neo4j.mapping

Class Neo4jPersistentProperty

java.lang.Object

org.springframework.data.mapping.model.AbstractPersistentProperty<P>

org.springframework.data.mapping.model.AnnotationBasedPersistentProperty<Neo4jPersistentProperty>

org.springframework.data.neo4j.mapping.Neo4jPersistentProperty

All Implemented Interfaces:

PersistentProperty<Neo4jPersistentProperty>

public class Neo4jPersistentProperty
extends AnnotationBasedPersistentProperty<Neo4jPersistentProperty>

This class implements Spring Data's PersistentProperty interface, scavenging the required data from the OGM's mapping classes in order to for SDN to play nicely with Spring Data REST. The main thing to note is that this class is effectively a shim for FieldInfo. We don't reload all the mapping information again. We do not yet support getter/setter access to entity properties.

These attributes do not appear to be used/needed for SDN 4 to inter-operate correctly with SD-REST:

• mapValueType
• typeInformation
• isVersionProperty (there is no SDN versioning at this stage)
• isTransient (we never supply transient classes to the Spring mapping context)
• isWritable (we don't currently support read-only fields)

Consequently their associated getter methods always return default values of null or [true|false] However, because these method calls are not expected, we also log a warning message if they get invoked

Since:

4.0.0

Author:

Vince Bickers, Adam George, Luanne Misquitta, Mark Angrish, Mark Paluch

Property Summary

Type	Property and Description
boolean	isId Gets the value of the property idProperty.
boolean	isVersion Gets the value of the property versionProperty.

Constructor Summary

Constructors

Constructor and Description
Neo4jPersistentProperty(org.neo4j.ogm.metadata.ClassInfo owningClassInfo, Property property, PersistentEntity<?,Neo4jPersistentProperty> owner, SimpleTypeHolder simpleTypeHolder) Constructs a new Neo4jPersistentProperty based on the given arguments.

Method Summary

Modifier and Type	Method and Description
protected Association<Neo4jPersistentProperty>	createAssociation()
boolean	isAssociation() Determines whether or not this property should be considered an association to another entity or whether it's just a simple property that should be shown as a value.
boolean	isIdProperty() Gets the value of the property idProperty.
boolean	isVersionProperty() Gets the value of the property versionProperty.
boolean	usePropertyAccess() Overridden to force field access as opposed to getter method access for simplicity.

Methods inherited from class org.springframework.data.mapping.model.AnnotationBasedPersistentProperty

findAnnotation, findPropertyOrOwnerAnnotation, getSpelExpression, isAnnotationPresent, isTransient, isWritable, toString

Methods inherited from class org.springframework.data.mapping.model.AbstractPersistentProperty

equals, getActualType, getAssociation, getComponentType, getField, getGetter, getMapValueType, getName, getOwner, getPersistentEntityType, getProperty, getRawType, getSetter, getType, getTypeInformation, hashCode, isArray, isCollectionLike, isEntity, isMap

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.springframework.data.mapping.PersistentProperty

getPersistentEntityTypes, getRequiredAnnotation, getRequiredAssociation, getRequiredField, getRequiredGetter, getRequiredSetter

Property Detail

isId

public boolean isIdProperty

Gets the value of the property idProperty.

Specified by:

isIdProperty in interface PersistentProperty<Neo4jPersistentProperty>

Overrides:

isIdProperty in class AnnotationBasedPersistentProperty<Neo4jPersistentProperty>

isVersion

public boolean isVersionProperty

Gets the value of the property versionProperty.

Specified by:

isVersionProperty in interface PersistentProperty<Neo4jPersistentProperty>

Overrides:

isVersionProperty in class AnnotationBasedPersistentProperty<Neo4jPersistentProperty>

Constructor Detail

Neo4jPersistentProperty

public Neo4jPersistentProperty(org.neo4j.ogm.metadata.ClassInfo owningClassInfo,
                               Property property,
                               PersistentEntity<?,Neo4jPersistentProperty> owner,
                               SimpleTypeHolder simpleTypeHolder)

Constructs a new Neo4jPersistentProperty based on the given arguments.

Parameters:

owningClassInfo - The ClassInfo of the object of which the property field is a member

property - The property

owner - The owning PersistentEntity that corresponds to the given ClassInfo

simpleTypeHolder - The SimpleTypeHolder that dictates whether the type of this property is considered simple or not

Method Detail

isIdProperty

public boolean isIdProperty()

Gets the value of the property idProperty.

Specified by:

isIdProperty in interface PersistentProperty<Neo4jPersistentProperty>

Overrides:

isIdProperty in class AnnotationBasedPersistentProperty<Neo4jPersistentProperty>

isVersionProperty

public boolean isVersionProperty()

Gets the value of the property versionProperty.

Specified by:

isVersionProperty in interface PersistentProperty<Neo4jPersistentProperty>

Overrides:

isVersionProperty in class AnnotationBasedPersistentProperty<Neo4jPersistentProperty>

usePropertyAccess

public boolean usePropertyAccess()

Overridden to force field access as opposed to getter method access for simplicity.

Specified by:

usePropertyAccess in interface PersistentProperty<Neo4jPersistentProperty>

Overrides:

usePropertyAccess in class AnnotationBasedPersistentProperty<Neo4jPersistentProperty>

See Also:

AnnotationBasedPersistentProperty.usePropertyAccess()

isAssociation

public boolean isAssociation()

Determines whether or not this property should be considered an association to another entity or whether it's just a simple property that should be shown as a value.

This implementation works by looking for non-transient members annotated with @Relationship.

Specified by:

isAssociation in interface PersistentProperty<Neo4jPersistentProperty>

Overrides:

isAssociation in class AnnotationBasedPersistentProperty<Neo4jPersistentProperty>

Returns:

true if this property is an association to another entity, false if not

createAssociation

protected Association<Neo4jPersistentProperty> createAssociation()

Specified by:

createAssociation in class AbstractPersistentProperty<Neo4jPersistentProperty>