org.apache.flink.graph.types.valuearray

Class ShortValueArray

java.lang.Object

org.apache.flink.graph.types.valuearray.ShortValueArray

All Implemented Interfaces:

Serializable, Comparable<ValueArray<ShortValue>>, Iterable<ShortValue>, IOReadableWritable, ValueArray<ShortValue>, CopyableValue<ValueArray<ShortValue>>, Key<ValueArray<ShortValue>>, NormalizableKey<ValueArray<ShortValue>>, ResettableValue<ValueArray<ShortValue>>, Value

public class ShortValueArray
extends Object
implements ValueArray<ShortValue>

An array of ShortValue.

See Also:

Serialized Form

Field Summary

Fields

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
boolean	add(ShortValue value) Appends the value to this array if and only if the array capacity would not be exceeded.
boolean	addAll(ValueArray<ShortValue> 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<ShortValue> o)
ValueArray<ShortValue>	copy() Performs a deep copy of this object into a new instance.
void	copy(DataInputView source, DataOutputView target) Copies the next serialized instance from source to target.
protected static void	copyInternal(DataInputView source, DataOutputView target)
void	copyNormalizedKey(MemorySegment target, int offset, int len) Writes a normalized key for the given record into the target byte array, starting at the specified position an writing exactly the given number of bytes.
void	copyTo(ValueArray<ShortValue> target) Performs a deep copy of this object into the target instance.
boolean	equals(Object obj) Compares the object on equality with another object.
int	getBinaryLength() Gets the length of the data type when it is serialized, in bytes.
int	getMaxNormalizedKeyLen() Gets the maximal length of normalized keys that the data type would produce to determine the order of instances solely by the normalized key.
int	hashCode() All keys must override the hash-code function to generate proper deterministic hash codes, based on their contents.
boolean	isFull() An bounded array fills when the allocated capacity has been fully used.
Iterator<ShortValue>	iterator()
void	mark() Saves the array index, which can be restored by calling reset().
void	read(DataInputView in) Reads the object's internal data from the given data input view.
void	reset() Restores the array index to when mark() was last called.
void	setValue(ValueArray<ShortValue> value) Sets the encapsulated value to another value
int	size() Returns the number of elements stored in the array.
String	toString()
void	write(DataOutputView out) Writes the object's internal data to the given data output view.

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

ELEMENT_LENGTH_IN_BYTES

protected static final int ELEMENT_LENGTH_IN_BYTES

See Also:

Constant Field Values

DEFAULT_CAPACITY_IN_BYTES

protected static final int DEFAULT_CAPACITY_IN_BYTES

See Also:

Constant Field Values

Constructor Detail

ShortValueArray

public ShortValueArray()

Initializes an expandable array with default capacity.

ShortValueArray

public ShortValueArray(int bytes)

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

Parameters:

bytes - number of bytes of the encapsulated array

Method Detail

toString

public String toString()

Overrides:

toString in class Object

iterator

public Iterator<ShortValue> iterator()

Specified by:

iterator in interface Iterable<ShortValue>

write

public void write(DataOutputView out)
           throws IOException

Description copied from interface: IOReadableWritable

Writes the object's internal data to the given data output view.

Specified by:

write in interface IOReadableWritable

Parameters:

out - the output view to receive the data.

Throws:

IOException - thrown if any error occurs while writing to the output stream

read

public void read(DataInputView in)
          throws IOException

Description copied from interface: IOReadableWritable

Reads the object's internal data from the given data input view.

Specified by:

read in interface IOReadableWritable

Parameters:

in - the input view to read the data from

Throws:

IOException - thrown if any error occurs while reading from the input stream

getMaxNormalizedKeyLen

public int getMaxNormalizedKeyLen()

Description copied from interface: NormalizableKey

Gets the maximal length of normalized keys that the data type would produce to determine the order of instances solely by the normalized key. A value of Integer.MAX_VALUE is interpreted as infinite.

For example, 32 bit integers return four, while Strings (potentially unlimited in length) return Integer.MAX_VALUE.

Specified by:

getMaxNormalizedKeyLen in interface NormalizableKey<ValueArray<ShortValue>>

Returns:

The maximal length of normalized keys.

copyNormalizedKey

public void copyNormalizedKey(MemorySegment target,
                              int offset,
                              int len)

Description copied from interface: NormalizableKey

Writes a normalized key for the given record into the target byte array, starting at the specified position an writing exactly the given number of bytes. Note that the comparison of the bytes is treating the bytes as unsigned bytes: int byteI = bytes[i] & 0xFF;

If the meaningful part of the normalized key takes less than the given number of bytes, then it must be padded. Padding is typically required for variable length data types, such as strings. The padding uses a special character, either 0 or 0xff, depending on whether shorter values are sorted to the beginning or the end.

Specified by:

copyNormalizedKey in interface NormalizableKey<ValueArray<ShortValue>>

Parameters:

target - The memory segment to put the normalized key bytes into.

offset - The offset in the byte array where the normalized key's bytes should start.

len - The number of bytes to put.

compareTo

public int compareTo(ValueArray<ShortValue> o)

Specified by:

compareTo in interface Comparable<ValueArray<ShortValue>>

hashCode

public int hashCode()

Description copied from interface: Key

All keys must override the hash-code function to generate proper deterministic hash codes, based on their contents.

Specified by:

hashCode in interface Key<ValueArray<ShortValue>>

Overrides:

hashCode in class Object

Returns:

The hash code of the key

equals

public boolean equals(Object obj)

Description copied from interface: Key

Compares the object on equality with another object.

Specified by:

equals in interface Key<ValueArray<ShortValue>>

Overrides:

equals in class Object

Parameters:

obj - The other object to compare against.

Returns:

True, iff this object is identical to the other object, false otherwise.

setValue

public void setValue(ValueArray<ShortValue> value)

Description copied from interface: ResettableValue

Sets the encapsulated value to another value

Specified by:

setValue in interface ResettableValue<ValueArray<ShortValue>>

Parameters:

value - the new value of the encapsulated value

getBinaryLength

public int getBinaryLength()

Description copied from interface: CopyableValue

Gets the length of the data type when it is serialized, in bytes.

Specified by:

getBinaryLength in interface CopyableValue<ValueArray<ShortValue>>

Returns:

The length of the data type, or -1, if variable length.

copyTo

public void copyTo(ValueArray<ShortValue> target)

Description copied from interface: CopyableValue

Performs a deep copy of this object into the target instance.

Specified by:

copyTo in interface CopyableValue<ValueArray<ShortValue>>

Parameters:

target - Object to copy into.

copy

public ValueArray<ShortValue> copy()

Description copied from interface: CopyableValue

Performs a deep copy of this object into a new instance.

This method is useful for generic user-defined functions to clone a CopyableValue when storing multiple objects. With object reuse a deep copy must be created and type erasure prevents calling new.

Specified by:

copy in interface CopyableValue<ValueArray<ShortValue>>

Returns:

New object with copied fields.

copy

public void copy(DataInputView source,
                 DataOutputView target)
          throws IOException

Description copied from interface: CopyableValue

Copies the next serialized instance from source to target.

This method is equivalent to calling IOReadableWritable.read(DataInputView) followed by IOReadableWritable.write(DataOutputView) but does not require intermediate deserialization.

Specified by:

copy in interface CopyableValue<ValueArray<ShortValue>>

Parameters:

source - Data source for serialized instance.

target - Data target for serialized instance.

Throws:

IOException

See Also:

IOReadableWritable

copyInternal

protected static void copyInternal(DataInputView source,
                                   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<ShortValue>

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<ShortValue>

Returns:

whether the array is full

add

public boolean add(ShortValue 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<ShortValue>

Parameters:

value - the value to add to this array

Returns:

whether the value was added to the array

addAll

public boolean addAll(ValueArray<ShortValue> 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<ShortValue>

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<ShortValue>

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<ShortValue>

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<ShortValue>