org.neo4j.ogm.metadata

Class FieldInfo

java.lang.Object

org.neo4j.ogm.metadata.FieldInfo

public class FieldInfo
extends Object

Author:

Vince Bickers, Luanne Misquitta, Mark Angrish

Property Summary

Type	Property and Description
boolean	persistableAs

Constructor Summary

Constructors

Constructor and Description
FieldInfo(ClassInfo classInfo, Field field, String typeParameterDescriptor, ObjectAnnotations annotations) Constructs a new FieldInfo based on the given arguments.

Method Summary

Modifier and Type	Method and Description
ClassInfo	containingClassInfo() ClassInfo for the class this field is defined in
Class<?>	convertedType()
boolean	forScalar()
ObjectAnnotations	getAnnotations()
String	getCollectionClassname() Get the collection class name for the field
CompositeAttributeConverter	getCompositeConverter()
Field	getField()
String	getName()
AttributeConverter	getPropertyConverter()
String	getTypeDescriptor() Get the type descriptor
boolean	hasAnnotation(Class<?> annotationNameClass)
boolean	hasAnnotation(String annotationName)
boolean	hasCompositeConverter()
boolean	hasPropertyConverter()
boolean	isArray()
boolean	isArrayOf(Class<?> type)
boolean	isComposite()
boolean	isConstraint()
boolean	isIterable()
boolean	isLabelField()
boolean	isParameterisedTypeOf(Class<?> type)
boolean	isScalar()
boolean	isTypeOf(Class<?> type)
boolean	persistableAsProperty()
String	property()
String	propertyName()
static Object	read(Field field, Object instance)
Object	read(Object instance)
Map<String,?>	readComposite(Object instance)
Object	readProperty(Object instance)
String	relationship()
String	relationshipDirection()
String	relationshipDirection(String defaultDirection)
String	relationshipName()
String	relationshipType()
String	relationshipTypeAnnotation()
void	setCompositeConverter(CompositeAttributeConverter<?> converter)
Class<?>	type()
String	typeDescriptor()
String	typeParameterDescriptor()
static void	write(Field field, Object instance, Object value)
void	write(Object instance, Object value)
void	writeDirect(Object instance, Object value) Write the value of the field directly to the instance, bypassing the converters

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Property Detail

persistableAs

public boolean persistableAsProperty

Constructor Detail

FieldInfo

public FieldInfo(ClassInfo classInfo,
                 Field field,
                 String typeParameterDescriptor,
                 ObjectAnnotations annotations)

Constructs a new FieldInfo based on the given arguments.

Parameters:

typeParameterDescriptor - The descriptor that expresses the generic type parameter, which may be null if that's not appropriate

annotations - The ObjectAnnotations applied to the field

Method Detail

getName

public String getName()

property

public String property()

relationship

public String relationship()

relationshipTypeAnnotation

public String relationshipTypeAnnotation()

getAnnotations

public ObjectAnnotations getAnnotations()

persistableAsProperty

public boolean persistableAsProperty()

getPropertyConverter

public AttributeConverter getPropertyConverter()

hasPropertyConverter

public boolean hasPropertyConverter()

getCompositeConverter

public CompositeAttributeConverter getCompositeConverter()

setCompositeConverter

public void setCompositeConverter(CompositeAttributeConverter<?> converter)

hasCompositeConverter

public boolean hasCompositeConverter()

relationshipDirection

public String relationshipDirection(String defaultDirection)

isTypeOf

public boolean isTypeOf(Class<?> type)

isIterable

public boolean isIterable()

isParameterisedTypeOf

public boolean isParameterisedTypeOf(Class<?> type)

isArrayOf

public boolean isArrayOf(Class<?> type)

getCollectionClassname

public String getCollectionClassname()

Get the collection class name for the field

Returns:

collection class name

isScalar

public boolean isScalar()

isLabelField

public boolean isLabelField()

isArray

public boolean isArray()

hasAnnotation

public boolean hasAnnotation(String annotationName)

hasAnnotation

public boolean hasAnnotation(Class<?> annotationNameClass)

getTypeDescriptor

public String getTypeDescriptor()

Get the type descriptor

Returns:

the descriptor if the field is scalar or an array, otherwise the type parameter descriptor.

convertedType

public Class<?> convertedType()

isConstraint

public boolean isConstraint()

Returns:

true is this field is a constraint rather than just a plain index.

write

public static void write(Field field,
                         Object instance,
                         Object value)

read

public static Object read(Field field,
                          Object instance)

write

public void write(Object instance,
                  Object value)

writeDirect

public void writeDirect(Object instance,
                        Object value)

Write the value of the field directly to the instance, bypassing the converters

Parameters:

instance - class instance

value - field value to be written

type

public Class<?> type()

relationshipName

public String relationshipName()

forScalar

public boolean forScalar()

typeParameterDescriptor

public String typeParameterDescriptor()

read

public Object read(Object instance)

readProperty

public Object readProperty(Object instance)

readComposite

public Map<String,?> readComposite(Object instance)

relationshipType

public String relationshipType()

propertyName

public String propertyName()

isComposite

public boolean isComposite()

relationshipDirection

public String relationshipDirection()

typeDescriptor

public String typeDescriptor()

getField

public Field getField()

containingClassInfo

public ClassInfo containingClassInfo()

ClassInfo for the class this field is defined in

Returns:

ClassInfo of containing