org.neo4j.ogm.metadata

Class FieldInfo

java.lang.Object

org.neo4j.ogm.metadata.FieldInfo

public class FieldInfo
extends Object

Author:

Vince Bickers, Luanne Misquitta

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
AttributeConverter	converter()
ObjectAnnotations	getAnnotations()
String	getCollectionClassname() Get the collection class name for the field
String	getDescriptor()
String	getName()
String	getTypeDescriptor() Get the type descriptor
String	getTypeParameterDescriptor()
boolean	hasAnnotation(String annotationName)
boolean	hasConverter()
boolean	isArray()
boolean	isArrayOf(Class<?> type)
boolean	isCollection()
boolean	isParameterisedTypeOf(Class<?> type)
boolean	isScalar()
boolean	isSimple()
boolean	isTypeOf(Class<?> type)
String	property()
String	relationship()
String	relationshipDirection(String defaultDirection)
String	relationshipTypeAnnotation()

Methods inherited from class java.lang.Object

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

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()

getDescriptor

public String getDescriptor()

getTypeParameterDescriptor

public String getTypeParameterDescriptor()

getAnnotations

public ObjectAnnotations getAnnotations()

isSimple

public boolean isSimple()

converter

public AttributeConverter converter()

hasConverter

public boolean hasConverter()

relationshipDirection

public String relationshipDirection(String defaultDirection)

isTypeOf

public boolean isTypeOf(Class<?> type)

isCollection

public boolean isCollection()

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()

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.