org.apache.flink.api.common.typeutils.base

Class BooleanComparator

java.lang.Object

org.apache.flink.api.common.typeutils.TypeComparator<T>

org.apache.flink.api.common.typeutils.base.BasicTypeComparator<Boolean>

org.apache.flink.api.common.typeutils.base.BooleanComparator

All Implemented Interfaces:

Serializable

@Internal
public final class BooleanComparator
extends BasicTypeComparator<Boolean>

See Also:

Serialized Form

Field Summary

Fields inherited from class org.apache.flink.api.common.typeutils.base.BasicTypeComparator

ascendingComparison

Constructor Summary

Constructors

Constructor and Description
BooleanComparator(boolean ascending)

Method Summary

Modifier and Type	Method and Description
int	compareSerialized(DataInputView firstSource, DataInputView secondSource) Compares two records in serialized form.
BooleanComparator	duplicate() Creates a copy of this class.
int	getNormalizeKeyLen() Gets the number of bytes that the normalized key would maximally take.
boolean	isNormalizedKeyPrefixOnly(int keyBytes) Checks, whether the given number of bytes for a normalized is only a prefix to determine the order of elements of the data type for which this comparator provides the comparison methods.
void	putNormalizedKey(Boolean value, MemorySegment target, int offset, int numBytes) Writes a normalized key for the given record into the target byte array, starting at the specified position and writing exactly the given number of bytes.
boolean	supportsNormalizedKey() Checks whether the data type supports the creation of a normalized key for comparison.

Methods inherited from class org.apache.flink.api.common.typeutils.base.BasicTypeComparator

compare, compareToReference, equalToReference, extractKeys, getFlatComparators, hash, invertNormalizedKey, readWithKeyDenormalization, setReference, supportsSerializationWithKeyNormalization, writeWithKeyNormalization

Methods inherited from class org.apache.flink.api.common.typeutils.TypeComparator

compareAgainstReference, supportsCompareAgainstReference

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BooleanComparator

public BooleanComparator(boolean ascending)

Method Detail

compareSerialized

public int compareSerialized(DataInputView firstSource,
                             DataInputView secondSource)
                      throws IOException

Description copied from class: TypeComparator

Compares two records in serialized form. The return value indicates the order of the two in the same way as defined by Comparator.compare(Object, Object).

This method may de-serialize the records or compare them directly based on their binary representation.

Specified by:

compareSerialized in class TypeComparator<Boolean>

Parameters:

firstSource - The input view containing the first record.

secondSource - The input view containing the second record.

Returns:

An integer defining the oder among the objects in the same way as Comparator.compare(Object, Object).

Throws:

IOException - Thrown, if any of the input views raised an exception when reading the records.

See Also:

Comparator.compare(Object, Object)

supportsNormalizedKey

public boolean supportsNormalizedKey()

Description copied from class: TypeComparator

Checks whether the data type supports the creation of a normalized key for comparison.

Specified by:

supportsNormalizedKey in class TypeComparator<Boolean>

Returns:

True, if the data type supports the creation of a normalized key for comparison, false otherwise.

getNormalizeKeyLen

public int getNormalizeKeyLen()

Description copied from class: TypeComparator

Gets the number of bytes that the normalized key would maximally take. A value of Integer.MAX_VALUE is interpreted as infinite.

Specified by:

getNormalizeKeyLen in class TypeComparator<Boolean>

Returns:

The number of bytes that the normalized key would maximally take.

isNormalizedKeyPrefixOnly

public boolean isNormalizedKeyPrefixOnly(int keyBytes)

Description copied from class: TypeComparator

Checks, whether the given number of bytes for a normalized is only a prefix to determine the order of elements of the data type for which this comparator provides the comparison methods. For example, if the data type is ordered with respect to an integer value it contains, then this method would return true, if the number of key bytes is smaller than four.

Specified by:

isNormalizedKeyPrefixOnly in class TypeComparator<Boolean>

Returns:

True, if the given number of bytes is only a prefix, false otherwise.

putNormalizedKey

public void putNormalizedKey(Boolean value,
                             MemorySegment target,
                             int offset,
                             int numBytes)

Description copied from class: TypeComparator

Writes a normalized key for the given record into the target byte array, starting at the specified position and 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.

This method is similar to NormalizableKey.copyNormalizedKey(MemorySegment, int, int). In the case that multiple fields of a record contribute to the normalized key, it is crucial that the fields align on the byte field, i.e. that every field always takes up the exact same number of bytes.

Specified by:

putNormalizedKey in class TypeComparator<Boolean>

Parameters:

value - The record for which to create the normalized key.

target - The byte array into which to write the normalized key bytes.

offset - The offset in the byte array, where to start writing the normalized key bytes.

numBytes - The number of bytes to be written exactly.

See Also:

NormalizableKey.copyNormalizedKey(MemorySegment, int, int)

duplicate

public BooleanComparator duplicate()

Description copied from class: TypeComparator

Creates a copy of this class. The copy must be deep such that no state set in the copy affects this instance of the comparator class.

Specified by:

duplicate in class TypeComparator<Boolean>

Returns:

A deep copy of this comparator instance.