PropertyValue (Gradoop Common 0.5.1 API)

java.lang.Object
- org.gradoop.common.model.impl.properties.PropertyValue

All Implemented Interfaces:

Serializable, Comparable<PropertyValue>, org.apache.flink.core.io.IOReadableWritable, org.apache.flink.types.Value
```
public class PropertyValue
extends Object
implements org.apache.flink.types.Value, Serializable, Comparable<PropertyValue>
```
Represents a single property value in the EPGM. A property value wraps a value that implements a supported data type.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static byte`	`FLAG_LARGE` Bit flag indicating a "large" property.
`static int`	`LARGE_PROPERTY_THRESHOLD` If the length of the byte representation is larger than this value, the length will be stored as an `int` instead of a `short`.
`static PropertyValue`	`NULL_VALUE` Represents a property value that is `null`.
`static byte`	`OFFSET` Value offset in byte

Constructor Summary

Constructors
Constructor and Description

PropertyValue()
Default constructor.

Constructors
Constructor and Description
`PropertyValue()` Default constructor.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`byteSize()` Returns the byte size of the properties internal representation.
`int`	`compareTo(PropertyValue other)` Compares this to another `PropertyValue`.
`PropertyValue`	`copy()` Creates a deep copy of the property value.
`static PropertyValue`	`create(Object value)` Creates a new Property Value from the given object.
`boolean`	`equals(Object object)`
`static PropertyValue`	`fromRawBytes(byte[] rawBytes)` Create a `PropertyValue` that wraps a byte array.
`<T> T`	`get(Class<T> clazz)` Returns the value as the specified type.
`BigDecimal`	`getBigDecimal()` Returns the wrapped value as `BigDecimal`.
`boolean`	`getBoolean()` Returns the wrapped value as `boolean`.
`int`	`getByteSize()`
`LocalDate`	`getDate()` Returns the wrapped List as `LocalDate`.
`LocalDateTime`	`getDateTime()` Returns the wrapped List as `LocalDateTime`.
`double`	`getDouble()` Returns the wrapped value as `double`.
`float`	`getFloat()` Returns the wrapped value as `float`.
`GradoopId`	`getGradoopId()` Returns the wrapped value as `GradoopId`.
`int`	`getInt()` Returns the wrapped value as `int`.
`List<PropertyValue>`	`getList()` Returns the wrapped List as `List<PropertyValue>`.
`long`	`getLong()` Returns the wrapped value as `long`.
`Map<PropertyValue,PropertyValue>`	`getMap()` Returns the wrapped Map as `Map<PropertyValue, PropertyValue>`.
`Object`	`getObject()` Returns the wrapped value as object.
`byte[]`	`getRawBytes()`
`Set<PropertyValue>`	`getSet()` Returns the wrapped Set as `Set<PropertyValue>`.
`short`	`getShort()` Returns the wrapped value as `short`.
`String`	`getString()` Returns the wrapped value as `String`.
`LocalTime`	`getTime()` Returns the wrapped List as `LocalTime`.
`Class<?>`	`getType()` Get the data type as class object according to the first position of the rawBytes[] array.
`int`	`hashCode()`
`boolean`	`is(Class clazz)` Check if the property value type is an instance of a certain class.
`boolean`	`isBigDecimal()` True, if the wrapped value is of type `BigDecimal`.
`boolean`	`isBoolean()` True, if the wrapped value is of type `boolean`.
`boolean`	`isDate()` True, if the wrapped value is of type `LocalDate`.
`boolean`	`isDateTime()` True, if the wrapped value is of type `LocalDateTime`.
`boolean`	`isDouble()` True, if the wrapped value is of type `double`.
`boolean`	`isFloat()` True, if the wrapped value is of type `float`.
`boolean`	`isGradoopId()` True, if the wrapped value is of type `GradoopId`.
`boolean`	`isInt()` True, if the wrapped value is of type `int`.
`boolean`	`isList()` True, if the wrapped value is of type `List`.
`boolean`	`isLong()` True, if the wrapped value is of type `long`.
`boolean`	`isMap()` True, if the wrapped value is of type `Map`.
`boolean`	`isNull()` True, if the value represents `null`.
`boolean`	`isNumber()` True, if the wrapped value is a subtype of `Number`.
`boolean`	`isSet()` True, if the wrapped value is of type `Set`.
`boolean`	`isShort()` True, if the wrapped value is of type `short`.
`boolean`	`isString()` True, if the wrapped value is of type `String`.
`boolean`	`isTime()` True, if the wrapped value is of type `LocalTime`.
`void`	`read(org.apache.flink.core.memory.DataInputView inputView)`
`void`	`setBigDecimal(BigDecimal bigDecimalValue)` Sets the wrapped value as `BigDecimal` value.
`void`	`setBoolean(boolean booleanValue)` Sets the wrapped value as `boolean` value.
`void`	`setBytes(byte[] bytes)` Set internal byte representation.
`void`	`setDate(LocalDate date)` Sets the wrapped value as `LocalDate` value.
`void`	`setDateTime(LocalDateTime dateTime)` Sets the wrapped value as `LocalDateTime` value.
`void`	`setDouble(double doubleValue)` Sets the wrapped value as `double` value.
`void`	`setFloat(float floatValue)` Sets the wrapped value as `float` value.
`void`	`setGradoopId(GradoopId gradoopIdValue)` Sets the wrapped value as `GradoopId` value.
`void`	`setInt(int intValue)` Sets the wrapped value as `int` value.
`void`	`setList(List<PropertyValue> list)` Sets the wrapped value as `List` value.
`void`	`setLong(long longValue)` Sets the wrapped value as `long` value.
`void`	`setMap(Map<PropertyValue,PropertyValue> map)` Sets the wrapped value as `Map` value.
`void`	`setObject(Object value)` Sets the given value as internal value if it has a supported type.
`void`	`setSet(Set<PropertyValue> set)` Sets the wrapped value as `Set` value.
`void`	`setShort(short shortValue)` Sets the wrapped value as `short` value.
`void`	`setString(String stringValue)` Sets the wrapped value as `String` value.
`void`	`setTime(LocalTime time)` Sets the wrapped value as `LocalTime` value.
`String`	`toString()`
`void`	`write(org.apache.flink.core.memory.DataOutputView outputView)` Byte representation: byte 1 : type info for dynamic length types (e.g.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - NULL_VALUE
```
public static final PropertyValue NULL_VALUE
```
    Represents a property value that is null.
  - OFFSET
```
public static final transient byte OFFSET
```
    Value offset in byte
    
    See Also:
    
    Constant Field Values
  - FLAG_LARGE
```
public static final transient byte FLAG_LARGE
```
    Bit flag indicating a "large" property. The length of the byte representation will be stored as an int instead.
    
    See Also:
    
    write(DataOutputView), Constant Field Values
  - LARGE_PROPERTY_THRESHOLD
```
public static final transient int LARGE_PROPERTY_THRESHOLD
```
    If the length of the byte representation is larger than this value, the length will be stored as an int instead of a short.
    
    See Also:
    
    write(DataOutputView), Constant Field Values
- Constructor Detail
  - PropertyValue
```
public PropertyValue()
```
    Default constructor.
- Method Detail
  - create
```
public static PropertyValue create(Object value)
```
    Creates a new Property Value from the given object. If the given object type is not supported, an UnsupportedTypeException will be thrown.
    
    Parameters:
    
    value - value with supported type
    
    Returns:
    
    property value
  - fromRawBytes
```
public static PropertyValue fromRawBytes(byte[] rawBytes)
```
    Create a PropertyValue that wraps a byte array.
    
    Parameters:
    
    rawBytes - array to wrap
    
    Returns:
    
    new instance of PropertyValue
  - copy
```
public PropertyValue copy()
```
    Creates a deep copy of the property value.
    
    Returns:
    
    property value
  - is
```
public boolean is(Class clazz)
```
    Check if the property value type is an instance of a certain class.
    
    Parameters:
    
    clazz - class to check against
    
    Returns:
    
    true if the attribute value is an object of the provided class, false otherwise
  - isNull
```
public boolean isNull()
```
    True, if the value represents null.
    
    Returns:
    
    true, if null value
  - isBoolean
```
public boolean isBoolean()
```
    True, if the wrapped value is of type boolean.
    
    Returns:
    
    true, if boolean value
  - isShort
```
public boolean isShort()
```
    True, if the wrapped value is of type short.
    
    Returns:
    
    true, if short value
  - isInt
```
public boolean isInt()
```
    True, if the wrapped value is of type int.
    
    Returns:
    
    true, if int value
  - isLong
```
public boolean isLong()
```
    True, if the wrapped value is of type long.
    
    Returns:
    
    true, if long value
  - isFloat
```
public boolean isFloat()
```
    True, if the wrapped value is of type float.
    
    Returns:
    
    true, if float value
  - isDouble
```
public boolean isDouble()
```
    True, if the wrapped value is of type double.
    
    Returns:
    
    true, if double value
  - isString
```
public boolean isString()
```
    True, if the wrapped value is of type String.
    
    Returns:
    
    true, if String value
  - isBigDecimal
```
public boolean isBigDecimal()
```
    True, if the wrapped value is of type BigDecimal.
    
    Returns:
    
    true, if BigDecimal value
    
    See Also:
    
    BigDecimal
  - isGradoopId
```
public boolean isGradoopId()
```
    True, if the wrapped value is of type GradoopId.
    
    Returns:
    
    true, if GradoopId value
  - isMap
```
public boolean isMap()
```
    True, if the wrapped value is of type Map.
    
    Returns:
    
    true, if Map value
  - isList
```
public boolean isList()
```
    True, if the wrapped value is of type List.
    
    Returns:
    
    true, if List value
  - isDate
```
public boolean isDate()
```
    True, if the wrapped value is of type LocalDate.
    
    Returns:
    
    true, if LocalDate value
  - isTime
```
public boolean isTime()
```
    True, if the wrapped value is of type LocalTime.
    
    Returns:
    
    true, if LocalTime value
  - isDateTime
```
public boolean isDateTime()
```
    True, if the wrapped value is of type LocalDateTime.
    
    Returns:
    
    true, if LocalDateTime value
  - isSet
```
public boolean isSet()
```
    True, if the wrapped value is of type Set.
    
    Returns:
    
    true, if Set value
  - isNumber
```
public boolean isNumber()
```
    True, if the wrapped value is a subtype of Number.
    
    Returns:
    
    true, if Number value
  - get
```
public <T> T get(Class<T> clazz)
          throws UnsupportedOperationException
```
    Returns the value as the specified type. If it is already of the same type as requested, we just return the value. If not, an UnsupportedOperationException is thrown.
    
    Type Parameters:
    
    T - PropertyValue supported type
    
    Parameters:
    
    clazz - the requested value type
    
    Returns:
    
    value
    
    Throws:
    
    UnsupportedOperationException - when trying to get the wrong type
  - getObject
```
public Object getObject()
```
    Returns the wrapped value as object.
    
    Returns:
    
    value or null if the value is empty
  - getBoolean
```
public boolean getBoolean()
```
    Returns the wrapped value as boolean.
    
    Returns:
    
    boolean value
  - getShort
```
public short getShort()
```
    Returns the wrapped value as short.
    
    Returns:
    
    short value
  - getInt
```
public int getInt()
```
    Returns the wrapped value as int.
    
    Returns:
    
    int value
  - getLong
```
public long getLong()
```
    Returns the wrapped value as long.
    
    Returns:
    
    long value
  - getFloat
```
public float getFloat()
```
    Returns the wrapped value as float.
    
    Returns:
    
    float value
  - getDouble
```
public double getDouble()
```
    Returns the wrapped value as double.
    
    Returns:
    
    double value
  - getString
```
public String getString()
```
    Returns the wrapped value as String.
    
    Returns:
    
    String value
  - getBigDecimal
```
public BigDecimal getBigDecimal()
```
    Returns the wrapped value as BigDecimal.
    
    Returns:
    
    BigDecimal value
    
    See Also:
    
    BigDecimal
  - getGradoopId
```
public GradoopId getGradoopId()
```
    Returns the wrapped value as GradoopId.
    
    Returns:
    
    GradoopId value
  - getMap
```
public Map<PropertyValue,PropertyValue> getMap()
```
    Returns the wrapped Map as Map<PropertyValue, PropertyValue>.
    
    Returns:
    
    Map<PropertyValue, PropertyValue> value
  - getList
```
public List<PropertyValue> getList()
```
    Returns the wrapped List as List<PropertyValue>.
    
    Returns:
    
    List<PropertyValue> value
  - getDate
```
public LocalDate getDate()
```
    Returns the wrapped List as LocalDate.
    
    Returns:
    
    LocalDate value
  - getTime
```
public LocalTime getTime()
```
    Returns the wrapped List as LocalTime.
    
    Returns:
    
    LocalTime value
  - getDateTime
```
public LocalDateTime getDateTime()
```
    Returns the wrapped List as LocalDateTime.
    
    Returns:
    
    LocalDateTime value
  - getSet
```
public Set<PropertyValue> getSet()
```
    Returns the wrapped Set as Set<PropertyValue>.
    
    Returns:
    
    Set<PropertyValue> value
  - setObject
```
public void setObject(Object value)
```
    Sets the given value as internal value if it has a supported type.
    
    Parameters:
    
    value - value
    
    Throws:
    
    UnsupportedTypeException - if the type of the Object is not supported
  - setBoolean
```
public void setBoolean(boolean booleanValue)
```
    Sets the wrapped value as boolean value.
    
    Parameters:
    
    booleanValue - value
  - setShort
```
public void setShort(short shortValue)
```
    Sets the wrapped value as short value.
    
    Parameters:
    
    shortValue - value
  - setInt
```
public void setInt(int intValue)
```
    Sets the wrapped value as int value.
    
    Parameters:
    
    intValue - intValue
  - setLong
```
public void setLong(long longValue)
```
    Sets the wrapped value as long value.
    
    Parameters:
    
    longValue - value
  - setFloat
```
public void setFloat(float floatValue)
```
    Sets the wrapped value as float value.
    
    Parameters:
    
    floatValue - value
  - setDouble
```
public void setDouble(double doubleValue)
```
    Sets the wrapped value as double value.
    
    Parameters:
    
    doubleValue - value
  - setString
```
public void setString(String stringValue)
```
    Sets the wrapped value as String value.
    
    Parameters:
    
    stringValue - value
  - setBigDecimal
```
public void setBigDecimal(BigDecimal bigDecimalValue)
```
    Sets the wrapped value as BigDecimal value.
    
    Parameters:
    
    bigDecimalValue - value
  - setGradoopId
```
public void setGradoopId(GradoopId gradoopIdValue)
```
    Sets the wrapped value as GradoopId value.
    
    Parameters:
    
    gradoopIdValue - value
  - setMap
```
public void setMap(Map<PropertyValue,PropertyValue> map)
```
    Sets the wrapped value as Map value.
    
    Parameters:
    
    map - value
  - setList
```
public void setList(List<PropertyValue> list)
```
    Sets the wrapped value as List value.
    
    Parameters:
    
    list - value
  - setDate
```
public void setDate(LocalDate date)
```
    Sets the wrapped value as LocalDate value.
    
    Parameters:
    
    date - value
  - setTime
```
public void setTime(LocalTime time)
```
    Sets the wrapped value as LocalTime value.
    
    Parameters:
    
    time - value
  - setDateTime
```
public void setDateTime(LocalDateTime dateTime)
```
    Sets the wrapped value as LocalDateTime value.
    
    Parameters:
    
    dateTime - value
  - setSet
```
public void setSet(Set<PropertyValue> set)
```
    Sets the wrapped value as Set value.
    
    Parameters:
    
    set - value
  - getType
```
public Class<?> getType()
```
    Get the data type as class object according to the first position of the rawBytes[] array.
    
    Returns:
    
    Class object
  - getByteSize
```
public int getByteSize()
```
  - getRawBytes
```
public byte[] getRawBytes()
```
  - setBytes
```
public void setBytes(byte[] bytes)
```
    Set internal byte representation.
    
    Parameters:
    
    bytes - array
  - equals
```
public boolean equals(Object object)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - compareTo
```
public int compareTo(PropertyValue other)
```
    Compares this to another PropertyValue. See PropertyValueStrategyFactory.compare(java.lang.Object, java.lang.Object).
    
    Specified by:
    
    compareTo in interface Comparable<PropertyValue>
    
    Parameters:
    
    other - the property value to be compared.
    
    Returns:
    
    a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.
    
    See Also:
    
    PropertyValueStrategyFactory.compare(java.lang.Object, java.lang.Object)
  - byteSize
```
public int byteSize()
```
    Returns the byte size of the properties internal representation.
    
    Returns:
    
    byte size
  - write
```
public void write(org.apache.flink.core.memory.DataOutputView outputView)
           throws IOException
```
    Byte representation: byte 1 : type info for dynamic length types (e.g. String and BigDecimal) byte 2 : length (short) byte 3 : length (short) byte 4 - end : value bytes If the size of the internal byte representation if larger than LARGE_PROPERTY_THRESHOLD (i.e. if a short is too small to store the length), then the FLAG_LARGE bit will be set in the first byte and the byte representation will be: byte 2 ; length (int) byte 3 : length (int) byte 4 : length (int) byte 5 : length (int) byte 6 - end : value bytes for fixed length types (e.g. int, long, float, ...) byte 2 - end : value bytes
    
    Specified by:
    
    write in interface org.apache.flink.core.io.IOReadableWritable
    
    Parameters:
    
    outputView - data output to write data to
    
    Throws:
    
    IOException - if write to output view fails.
  - read
```
public void read(org.apache.flink.core.memory.DataInputView inputView)
          throws IOException
```
    Specified by:
    
    read in interface org.apache.flink.core.io.IOReadableWritable
    
    Throws:
    
    IOException
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class PropertyValue

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

NULL_VALUE

OFFSET

FLAG_LARGE

LARGE_PROPERTY_THRESHOLD

Constructor Detail

PropertyValue

Method Detail

create

fromRawBytes

copy

is

isNull

isBoolean

isShort

isInt

isLong

isFloat

isDouble

isString

isBigDecimal

isGradoopId

isMap

isList

isDate

isTime

isDateTime

isSet

isNumber

get

getObject

getBoolean

getShort

getInt

getLong

getFloat

getDouble

getString

getBigDecimal

getGradoopId

getMap

getList

getDate

getTime

getDateTime

getSet

setObject

setBoolean

setShort

setInt

setLong

setFloat

setDouble

setString

setBigDecimal

setGradoopId

setMap

setList

setDate

setTime

setDateTime

setSet

getType

getByteSize

getRawBytes

setBytes

equals

hashCode

compareTo

byteSize

write

read

toString