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

Properties

Type	Property and Description
boolean	persistableAs

Constructor Summary

Constructors

Constructor and Description
FieldInfo(String name, String descriptor, String typeParameterDescriptor, ObjectAnnotations annotations) Constructs a new FieldInfo based on the given arguments.

Method Summary

Methods

Modifier and Type	Method and Description
Class<?>	convertedType()
ObjectAnnotations	getAnnotations()
String	getCollectionClassname() Get the collection class name for the field
CompositeAttributeConverter	getCompositeConverter()
String	getName()
AttributeConverter	getPropertyConverter()
String	getTypeDescriptor() Get the type descriptor
boolean	hasAnnotation(String annotationName)
boolean	hasCompositeConverter()
boolean	hasPropertyConverter()
boolean	isArray()
boolean	isArrayOf(Class<?> type)
boolean	isConstraint()
boolean	isIterable()
boolean	isLabelField()
boolean	isParameterisedTypeOf(Class<?> type)
boolean	isScalar()
boolean	isTypeOf(Class<?> type)
boolean	persistableAsProperty()
String	property()
String	relationship()
String	relationshipDirection(String defaultDirection)
String	relationshipTypeAnnotation()
void	setCompositeConverter(CompositeAttributeConverter<?> converter)

Methods inherited from class java.lang.Object

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

Property Detail

persistableAs

Constructor Detail

FieldInfo

public FieldInfo(String name,
         String descriptor,
         String typeParameterDescriptor,
         ObjectAnnotations annotations)

Constructs a new FieldInfo based on the given arguments.

Parameters:

name - The name of the field

descriptor - The field descriptor that expresses the type of the field using Java signature string notation

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)

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.