org.neo4j.ogm.annotation

Annotation Type Properties

@Retention(value=RUNTIME)
 @Target(value=FIELD)
 @Inherited
public @interface Properties

Tells OGM to map values of a Map field in a node or relationship entity to properties of a node or a relationship in the graph. The property names are derived from field name or prefix(), delimiter and keys in the Map. If the delimiter, prefix or keys conflict with other field names in the class the behaviour is not defined. Supported types for keys in the Map are String and Enum. The values in the Map can be of any Java type equivalent to Cypher types. If full type information is provided other Java types are also supported. If allowCast() is set to true then types that can be cast to corresponding Cypher types are allowed as well. Note that the original type cannot be deduced and the value will be deserialized to corresponding type - e.g. when Integer instance is put to Map<String, Object> it will be deserialized as Long.

Since:

3.0

Author:

Frantisek Hartman

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	allowCast If values in the Map that do not have supported Cypher type should be allowed to be cast to Cypher types
String	delimiter Delimiter to use in the property names
String	prefix Prefix for mapped properties, if not set the field name is used

Element Detail

prefix

public abstract String prefix

Prefix for mapped properties, if not set the field name is used

Default:

""

delimiter

public abstract String delimiter

Delimiter to use in the property names

Default:

"."

allowCast

public abstract boolean allowCast

If values in the Map that do not have supported Cypher type should be allowed to be cast to Cypher types

Default:

false