Package org.neo4j.ogm.metadata
Class FieldInfo
java.lang.Object
org.neo4j.ogm.metadata.FieldInfo
- Author:
- Vince Bickers, Luanne Misquitta, Mark Angrish, Michael J. Simons, Nicolas Labrot
-
Method Summary
Modifier and TypeMethodDescriptionClassInfo for the class this field is defined inClass<?>
boolean
boolean
Get the collection class name for the fieldgetField()
getName()
Get the type descriptorboolean
hasAnnotation
(Class<?> annotationNameClass) boolean
hasAnnotation
(String annotationName) boolean
int
hashCode()
boolean
boolean
isArray()
boolean
boolean
boolean
boolean
boolean
isParameterisedTypeOf
(Class<?> type) boolean
boolean
isScalar()
boolean
boolean
boolean
property()
static Object
readComposite
(Object instance) readProperty
(Object instance) relationshipDirectionOrDefault
(Relationship.Direction defaultDirection) void
setCompositeConverter
(CompositeAttributeConverter<?> converter) void
setPropertyConverter
(AttributeConverter<?, ?> propertyConverter) Class<?>
type()
void
static void
void
writeDirect
(Object instance, Object value) Write the value of the field directly to the instance, bypassing the converters
-
Method Details
-
getName
- Returns:
- The name of the underlying field
-
property
-
relationship
-
relationshipTypeAnnotation
-
getAnnotations
-
persistableAsProperty
public boolean persistableAsProperty() -
getPropertyConverter
-
setPropertyConverter
-
hasPropertyConverter
public boolean hasPropertyConverter() -
getCompositeConverter
-
setCompositeConverter
-
hasCompositeConverter
public boolean hasCompositeConverter() -
relationshipDirectionOrDefault
public Relationship.Direction relationshipDirectionOrDefault(Relationship.Direction defaultDirection) -
isIterable
public boolean isIterable() -
isTypeOf
-
isParameterisedTypeOf
-
isArrayOf
-
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
-
hasAnnotation
-
getTypeDescriptor
Get the type descriptor- Returns:
- the descriptor if the field is scalar or an array, otherwise the type parameter descriptor.
-
convertedType
- Returns:
- The type that is stored in the graph.
-
isReadOnly
public boolean isReadOnly() -
write
-
read
-
write
-
convert
-
writeDirect
Write the value of the field directly to the instance, bypassing the converters- Parameters:
instance
- class instancevalue
- field value to be written
-
type
- Returns:
- The field type (may be List, while the mapped type is retrievable from
getTypeDescriptor()
()}).
-
forScalar
public boolean forScalar() -
read
-
readProperty
-
readComposite
-
relationshipType
-
propertyName
-
isComposite
public boolean isComposite() -
relationshipDirection
-
getField
-
containingClassInfo
ClassInfo for the class this field is defined in- Returns:
- ClassInfo of containing
-
isVersionField
public boolean isVersionField() -
equals
-
hashCode
public int hashCode()
-