V
- Type of the attribute associated with the AttributeSerializerpublic interface AttributeSerializer<V>
For most data types (i.e. classes) used with properties, using the default serializer when registering the type with the
JanusGraph will be sufficient and efficient in practice. However, for certain data types, it can be more
efficient to provide custom serializers implementing this interface.
Such custom serializers are registered in the configuration file by specifying their path and loaded when
the database is initialized. Hence, the serializer must be on the classpath.
When a PropertyKey
is defined using a data type specified via PropertyKeyMaker
for which a custom serializer
is configured, then it will use this custom serializer for persistence operations.
RelationTypeMaker
,
"Datatype and Attribute Serializer Configuration" manual chapterModifier and Type | Method and Description |
---|---|
default V |
convert(Object value)
Converts the given (not-null) value to the expected data type V.
|
V |
read(ScanBuffer buffer)
Reads an attribute from the given ReadBuffer.
|
default void |
verifyAttribute(V value)
Verifies the given (not-null) attribute value is valid.
|
void |
write(WriteBuffer buffer,
V attribute)
Writes the attribute value to the given WriteBuffer.
|
V read(ScanBuffer buffer)
It is expected that this read operation adjusts the position in the ReadBuffer to after the attribute value.
buffer
- ReadBuffer to read attribute fromvoid write(WriteBuffer buffer, V attribute)
It is expected that this write operation adjusts the position in the WriteBuffer to after the attribute value.
buffer
- WriteBuffer to write attribute toattribute
- Attribute to write to WriteBufferdefault void verifyAttribute(V value)
IllegalArgumentException
if the value is invalid,
otherwise simply returns.value
- to verifydefault V convert(Object value)
IllegalArgumentException
if it cannot be converted.value
- to convertCopyright © 2012–2023. All rights reserved.