org.neo4j.ogm.annotations

Interface PropertyReader

All Known Implementing Classes:

FieldReader, MethodReader

public interface PropertyReader

Simple interface through which a particular property of a given object can be read.

Author:

Adam George

Method Summary

Methods

Modifier and Type	Method and Description
String	propertyName() Retrieves the property name as it would be written to the node or relationship in the graph database.
Object	read(Object instance) Reads the value corresponding to this property from the given object.

Method Detail

propertyName

String propertyName()

Retrieves the property name as it would be written to the node or relationship in the graph database.

Returns:

The name of the property to write to the graph database property container

read

Object read(Object instance)

Reads the value corresponding to this property from the given object.

Parameters:

instance - The instance from which to read the property value

Returns:

The value of the property, which may be null

Throws:

RuntimeException - if there's an error reading the property or if it's not found on the given object