org.gradoop.common.model.api.strategies

Interface PropertyValueStrategy<T>

Type Parameters:

T - The property value type.

All Known Implementing Classes:

AbstractFixSizedPropertyValueStrategy, AbstractVariableSizedPropertyValueStrategy, BigDecimalStrategy, BooleanStrategy, DateStrategy, DateTimeStrategy, DoubleStrategy, FloatStrategy, GradoopIdStrategy, IntegerStrategy, ListStrategy, LongStrategy, MapStrategy, NullStrategy, SetStrategy, ShortStrategy, StringStrategy, TimeStrategy

public interface PropertyValueStrategy<T>

Interface defining the methods necessary to handle the (de-) serialization of a PropertyValue's value.

Method Summary

Modifier and Type	Method and Description
int	compare(T value, Object other) Compares two objects.
T	get(byte[] bytes) Deserializes an object from the provided byte array.
byte[]	getRawBytes(T value) Serializes the given object.
byte	getRawType() Gets a byte which represents the data type the specific strategy handles.
Class<T>	getType() Gets the class of the data type the specific strategy handles.
boolean	is(Object value) Checks if given object is an instance of the data type the specific strategy handles.
T	read(org.apache.flink.core.memory.DataInputView inputView, byte typeByte) Reads raw bytes from the given DataInputView and deserializes the contained object.
void	write(T value, org.apache.flink.core.memory.DataOutputView outputView) Writes the given value to the provided DataOutputView.

Method Detail

write

void write(T value,
           org.apache.flink.core.memory.DataOutputView outputView)
    throws IOException

Writes the given value to the provided DataOutputView. The argument value can not be null.

Parameters:

value - to be written to the DataOutputView.

outputView - that the value is written to.

Throws:

IOException - if write process fails.

read

T read(org.apache.flink.core.memory.DataInputView inputView,
       byte typeByte)
throws IOException

Reads raw bytes from the given DataInputView and deserializes the contained object.

Parameters:

inputView - containing serialized object.

typeByte - byte needed to indicate whether serialized object has a variable length.

Returns:

deserialized object.

Throws:

IOException - when reading or deserialization of the object fails.

compare

int compare(T value,
            Object other)

Compares two objects.

Parameters:

value - first object.

other - second object.

Returns:

a negative integer, zero, or a positive integer as first object is less than, equal to, or greater than the second object.

Throws:

IllegalArgumentException - when other is not comparable to value.

is

boolean is(Object value)

Checks if given object is an instance of the data type the specific strategy handles.

Parameters:

value - to be checked.

Returns:

true if value is an instance of the data type this strategy handles. False otherwise.

getType

Class<T> getType()

Gets the class of the data type the specific strategy handles.

Returns:

class of the type handled by this strategy.

get

T get(byte[] bytes)
throws IOException

Deserializes an object from the provided byte array.

Parameters:

bytes - representing a serialized object.

Returns:

an instance of the type handled by this strategy.

Throws:

IOException - on failure

getRawType

byte getRawType()

Gets a byte which represents the data type the specific strategy handles.

Returns:

a byte.

getRawBytes

byte[] getRawBytes(T value)
            throws IOException

Serializes the given object. The argument value can not be null.

Parameters:

value - the object to be serialized.

Returns:

byte array representation of the provided object.

Throws:

IOException - on failure