org.apache.flink.graph.types.valuearray

Class StringValueArray

java.lang.Object

org.apache.flink.graph.types.valuearray.StringValueArray

All Implemented Interfaces:

Serializable, Comparable<ValueArray<org.apache.flink.types.StringValue>>, Iterable<org.apache.flink.types.StringValue>, org.apache.flink.core.io.IOReadableWritable, ValueArray<org.apache.flink.types.StringValue>, org.apache.flink.types.CopyableValue<ValueArray<org.apache.flink.types.StringValue>>, org.apache.flink.types.Key<ValueArray<org.apache.flink.types.StringValue>>, org.apache.flink.types.NormalizableKey<ValueArray<org.apache.flink.types.StringValue>>, org.apache.flink.types.ResettableValue<ValueArray<org.apache.flink.types.StringValue>>, org.apache.flink.types.Value

public class StringValueArray
extends Object
implements ValueArray<org.apache.flink.types.StringValue>

An array of StringValue.

Strings are serialized to a byte array. Concatenating arrays is as simple and fast as extending and copying byte arrays. Strings are serialized when individually added to StringValueArray.

For each string added to the array the length is first serialized using a variable length integer. Then the string characters are serialized using a variable length encoding where the lower 128 ASCII/UFT-8 characters are encoded in a single byte. This ensures that common characters are serialized in only two bytes.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected static int	DEFAULT_CAPACITY_IN_BYTES
protected static int	HIGH_BIT

Constructor Summary

Constructors

Constructor and Description
StringValueArray() Initializes an expandable array with default capacity.
StringValueArray(int bytes) Initializes a fixed-size array with the provided number of bytes.

Method Summary

Modifier and Type	Method and Description
boolean	add(org.apache.flink.types.StringValue value) Appends the value to this array if and only if the array capacity would not be exceeded.
boolean	addAll(ValueArray<org.apache.flink.types.StringValue> other) Appends all of the values in the specified array to the end of this array.
void	clear() Resets the array to the empty state.
int	compareTo(ValueArray<org.apache.flink.types.StringValue> o)
ValueArray<org.apache.flink.types.StringValue>	copy()
void	copy(org.apache.flink.core.memory.DataInputView source, org.apache.flink.core.memory.DataOutputView target)
protected static void	copyInternal(org.apache.flink.core.memory.DataInputView source, org.apache.flink.core.memory.DataOutputView target)
void	copyNormalizedKey(org.apache.flink.core.memory.MemorySegment target, int offset, int len)
void	copyTo(ValueArray<org.apache.flink.types.StringValue> target)
boolean	equals(Object obj)
int	getBinaryLength()
int	getMaxNormalizedKeyLen()
int	hashCode()
boolean	isFull() An bounded array fills when the allocated capacity has been fully used.
Iterator<org.apache.flink.types.StringValue>	iterator()
void	mark() Saves the array index, which can be restored by calling reset().
void	read(org.apache.flink.core.memory.DataInputView in)
void	reset() Restores the array index to when mark() was last called.
void	setValue(ValueArray<org.apache.flink.types.StringValue> value)
int	size() Returns the number of elements stored in the array.
String	toString()
void	write(org.apache.flink.core.memory.DataOutputView out)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

DEFAULT_CAPACITY_IN_BYTES

protected static final int DEFAULT_CAPACITY_IN_BYTES

See Also:

Constant Field Values

HIGH_BIT

protected static final int HIGH_BIT

See Also:

Constant Field Values

Constructor Detail

StringValueArray

public StringValueArray()

Initializes an expandable array with default capacity.

StringValueArray

public StringValueArray(int bytes)

Initializes a fixed-size array with the provided number of bytes.

Parameters:

bytes - number of bytes of the encapsulated array

Method Detail

toString

public String toString()

Overrides:

toString in class Object

iterator

public Iterator<org.apache.flink.types.StringValue> iterator()

Specified by:

iterator in interface Iterable<org.apache.flink.types.StringValue>

write

public void write(org.apache.flink.core.memory.DataOutputView out)
           throws IOException

Specified by:

write in interface org.apache.flink.core.io.IOReadableWritable

Throws:

IOException

read

public void read(org.apache.flink.core.memory.DataInputView in)
          throws IOException

Specified by:

read in interface org.apache.flink.core.io.IOReadableWritable

Throws:

IOException

getMaxNormalizedKeyLen

public int getMaxNormalizedKeyLen()

Specified by:

getMaxNormalizedKeyLen in interface org.apache.flink.types.NormalizableKey<ValueArray<org.apache.flink.types.StringValue>>

copyNormalizedKey

public void copyNormalizedKey(org.apache.flink.core.memory.MemorySegment target,
                              int offset,
                              int len)

Specified by:

copyNormalizedKey in interface org.apache.flink.types.NormalizableKey<ValueArray<org.apache.flink.types.StringValue>>

compareTo

public int compareTo(ValueArray<org.apache.flink.types.StringValue> o)

Specified by:

compareTo in interface Comparable<ValueArray<org.apache.flink.types.StringValue>>

hashCode

public int hashCode()

Specified by:

hashCode in interface org.apache.flink.types.Key<ValueArray<org.apache.flink.types.StringValue>>

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Specified by:

equals in interface org.apache.flink.types.Key<ValueArray<org.apache.flink.types.StringValue>>

Overrides:

equals in class Object

setValue

public void setValue(ValueArray<org.apache.flink.types.StringValue> value)

Specified by:

setValue in interface org.apache.flink.types.ResettableValue<ValueArray<org.apache.flink.types.StringValue>>

getBinaryLength

public int getBinaryLength()

Specified by:

getBinaryLength in interface org.apache.flink.types.CopyableValue<ValueArray<org.apache.flink.types.StringValue>>

copyTo

public void copyTo(ValueArray<org.apache.flink.types.StringValue> target)

Specified by:

copyTo in interface org.apache.flink.types.CopyableValue<ValueArray<org.apache.flink.types.StringValue>>

copy

public ValueArray<org.apache.flink.types.StringValue> copy()

Specified by:

copy in interface org.apache.flink.types.CopyableValue<ValueArray<org.apache.flink.types.StringValue>>

copy

public void copy(org.apache.flink.core.memory.DataInputView source,
                 org.apache.flink.core.memory.DataOutputView target)
          throws IOException

Specified by:

copy in interface org.apache.flink.types.CopyableValue<ValueArray<org.apache.flink.types.StringValue>>

Throws:

IOException

copyInternal

protected static void copyInternal(org.apache.flink.core.memory.DataInputView source,
                                   org.apache.flink.core.memory.DataOutputView target)
                            throws IOException

Throws:

IOException

size

public int size()

Description copied from interface: ValueArray

Returns the number of elements stored in the array.

Specified by:

size in interface ValueArray<org.apache.flink.types.StringValue>

Returns:

the number of elements stored in the array

isFull

public boolean isFull()

Description copied from interface: ValueArray

An bounded array fills when the allocated capacity has been fully used. An unbounded array will only fill when the underlying data structure has reached capacity, for example the ~2^31 element limit for Java arrays.

Specified by:

isFull in interface ValueArray<org.apache.flink.types.StringValue>

Returns:

whether the array is full

add

public boolean add(org.apache.flink.types.StringValue value)

Description copied from interface: ValueArray

Appends the value to this array if and only if the array capacity would not be exceeded.

Specified by:

add in interface ValueArray<org.apache.flink.types.StringValue>

Parameters:

value - the value to add to this array

Returns:

whether the value was added to the array

addAll

public boolean addAll(ValueArray<org.apache.flink.types.StringValue> other)

Description copied from interface: ValueArray

Appends all of the values in the specified array to the end of this array. If the combined array would exceed capacity then no values are appended.

Specified by:

addAll in interface ValueArray<org.apache.flink.types.StringValue>

Parameters:

other - array containing values to be added to this array

Returns:

whether the values were added to the array

clear

public void clear()

Description copied from interface: ValueArray

Resets the array to the empty state. The implementation is *not* expected to release the underlying data structure. This allows the array to be reused with minimal impact on the garbage collector.

This may reset the ValueArray.mark() in order to allow arrays be shrunk.

Specified by:

clear in interface ValueArray<org.apache.flink.types.StringValue>

mark

public void mark()

Description copied from interface: ValueArray

Saves the array index, which can be restored by calling reset().

This is not serialized and is not part of the contract for Key.equals(Object).

Specified by:

mark in interface ValueArray<org.apache.flink.types.StringValue>

reset

public void reset()

Description copied from interface: ValueArray

Restores the array index to when mark() was last called.

Specified by:

reset in interface ValueArray<org.apache.flink.types.StringValue>