org.springframework.data.neo4j.mapping
Interface Neo4jPersistentProperty

All Superinterfaces:

org.springframework.data.mapping.PersistentProperty<Neo4jPersistentProperty>

public interface Neo4jPersistentProperty
extends org.springframework.data.mapping.PersistentProperty<Neo4jPersistentProperty>

Interface for Neo4J specific PersistentPropertys. Declares additional metadata to lookup relationship information.

Author:

Oliver Gierke

Method Summary

<T extends Annotation> T	getAnnotation(Class<? extends T> annotationType)
Collection<? extends Annotation>	getAnnotations()
<T> T	getDefaultValue(ConversionService conversionService, Class<T> targetType)
IndexInfo	getIndexInfo()
String	getIndexKey()
MappingPolicy	getMappingPolicy()
String	getNeo4jPropertyName()
Neo4jPersistentEntity<?>	getOwner()
Class<?>	getPropertyType()
String	getQuery()
RelationshipInfo	getRelationshipInfo() Returns the RelationshipInfo for the given property if it is a relationship or null otherwise.
Class<?>	getTargetType()
Object	getValue(Object entity, MappingPolicy mappingPolicy)
Object	getValueFromEntity(Object entity, MappingPolicy mappingPolicy)
boolean	hasQuery()
<T extends Annotation> boolean	isAnnotationPresent(Class<T> annotationType)
boolean	isIndexed()
boolean	isIndexedNumerically()
boolean	isNeo4jPropertyType() Returns true if the type of this property is a natively supported neo4j property type.
boolean	isNeo4jPropertyValue(Object value) Returns true if the given object value is a natively supported neo4j property type, but not an array.
boolean	isReallyTransient()
boolean	isRelationship() Returns whether the property represents a relationship.
boolean	isSerializablePropertyField(ConversionService conversionService)
boolean	isSyntheticField()
boolean	isTargetTypeEnforced()
boolean	isUnique()
MappingPolicy	obtainMappingPolicy(MappingPolicy currentMappingPolicy)
void	setValue(Object entity, Object newValue)

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

getAssociation, getComponentType, getField, getGetter, getMapValueType, getName, getPersistentEntityType, getRawType, getSetter, getSpelExpression, getType, getTypeInformation, isArray, isAssociation, isCollectionLike, isEntity, isIdProperty, isMap, isTransient, isVersionProperty, shallBePersisted

Method Detail

isRelationship

boolean isRelationship()

Returns whether the property represents a relationship. If this returns true, clients can expect getRelationshipInfo() to return a non-null value.

getRelationshipInfo

RelationshipInfo getRelationshipInfo()

Returns the RelationshipInfo for the given property if it is a relationship or null otherwise.

See Also:

isRelationship()

isIndexed

boolean isIndexed()

getIndexInfo

IndexInfo getIndexInfo()

getNeo4jPropertyName

String getNeo4jPropertyName()

isSerializablePropertyField

boolean isSerializablePropertyField(ConversionService conversionService)

isNeo4jPropertyType

boolean isNeo4jPropertyType()

Returns true if the type of this property is a natively supported neo4j property type. Supported type are listed here: PropertyContainer.setProperty(String, Object).

isNeo4jPropertyValue

boolean isNeo4jPropertyValue(Object value)

Returns true if the given object value is a natively supported neo4j property type, but not an array.

isSyntheticField

boolean isSyntheticField()

getAnnotations

Collection<? extends Annotation> getAnnotations()

getAnnotation

<T extends Annotation> T getAnnotation(Class<? extends T> annotationType)

isAnnotationPresent

<T extends Annotation> boolean isAnnotationPresent(Class<T> annotationType)

setValue

void setValue(Object entity,
              Object newValue)

getValue

Object getValue(Object entity,
                MappingPolicy mappingPolicy)

getOwner

Neo4jPersistentEntity<?> getOwner()

Specified by:

getOwner in interface org.springframework.data.mapping.PersistentProperty<Neo4jPersistentProperty>

getIndexKey

String getIndexKey()

getMappingPolicy

MappingPolicy getMappingPolicy()

isReallyTransient

boolean isReallyTransient()

getValueFromEntity

Object getValueFromEntity(Object entity,
                          MappingPolicy mappingPolicy)

getDefaultValue

<T> T getDefaultValue(ConversionService conversionService,
                      Class<T> targetType)

getPropertyType

Class<?> getPropertyType()

isUnique

boolean isUnique()

obtainMappingPolicy

MappingPolicy obtainMappingPolicy(MappingPolicy currentMappingPolicy)

hasQuery

boolean hasQuery()

getQuery

String getQuery()

getTargetType

Class<?> getTargetType()

isTargetTypeEnforced

boolean isTargetTypeEnforced()

isIndexedNumerically

boolean isIndexedNumerically()