org.apache.flink.api.java.typeutils.runtime.record

Class RecordComparator

java.lang.Object

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

org.apache.flink.api.java.typeutils.runtime.record.RecordComparator

All Implemented Interfaces:

Serializable

public final class RecordComparator
extends TypeComparator<Record>

Implementation of the TypeComparator interface for the pact record. Instances of this class are parameterized with which fields are relevant to the comparison.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
RecordComparator(int[] keyFields, Class<? extends Key<?>>[] keyTypes) Creates a new comparator that compares Pact Records by the subset of fields as described by the given key positions and types.
RecordComparator(int[] keyFields, Class<? extends Key<?>>[] keyTypes, boolean[] sortDirection) Creates a new comparator that compares Pact Records by the subset of fields as described by the given key positions and types.

Method Summary

Methods

Modifier and Type	Method and Description
int	compare(DataInputView source1, DataInputView source2)
int	compare(Record first, Record second)
int	compareAgainstReference(Comparable[] keys)
int	compareToReference(TypeComparator<Record> referencedAccessors)
RecordComparator	duplicate()
boolean	equalToReference(Record candidate)
int[]	getKeyPositions()
Key<?>[]	getKeysAsCopy(Record record)
Class<? extends Key<?>>[]	getKeyTypes()
int	getNormalizeKeyLen()
int	hash(Record object)
boolean	invertNormalizedKey()
boolean	isNormalizedKeyPrefixOnly(int keyBytes)
void	putNormalizedKey(Record record, MemorySegment target, int offset, int numBytes)
Record	readWithKeyDenormalization(Record reuse, DataInputView source)
void	setReference(Record toCompare)
boolean	supportsCompareAgainstReference()
boolean	supportsNormalizedKey()
boolean	supportsSerializationWithKeyNormalization()
void	writeWithKeyNormalization(Record record, DataOutputView target)

Methods inherited from class java.lang.Object

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

Constructor Detail

RecordComparator

public RecordComparator(int[] keyFields,
                Class<? extends Key<?>>[] keyTypes)

Creates a new comparator that compares Pact Records by the subset of fields as described by the given key positions and types. All order comparisons will assume ascending order on all fields.

Parameters:

keyFields - The positions of the key fields.

keyTypes - The types (classes) of the key fields.

RecordComparator

public RecordComparator(int[] keyFields,
                Class<? extends Key<?>>[] keyTypes,
                boolean[] sortDirection)

Creates a new comparator that compares Pact Records by the subset of fields as described by the given key positions and types.

Parameters:

keyFields - The positions of the key fields.

keyTypes - The types (classes) of the key fields.

sortDirection - The direction for sorting. A value of true indicates ascending for an attribute, a value of false indicated descending. If the parameter is null, then all order comparisons will assume ascending order on all fields.

Method Detail

hash

public int hash(Record object)

Specified by:

hash in class TypeComparator<Record>

setReference

public void setReference(Record toCompare)

Specified by:

setReference in class TypeComparator<Record>

equalToReference

public boolean equalToReference(Record candidate)

Specified by:

equalToReference in class TypeComparator<Record>

compareToReference

public int compareToReference(TypeComparator<Record> referencedAccessors)

Specified by:

compareToReference in class TypeComparator<Record>

compare

public int compare(Record first,
          Record second)

Specified by:

compare in class TypeComparator<Record>

compare

public int compare(DataInputView source1,
          DataInputView source2)
            throws IOException

Specified by:

compare in class TypeComparator<Record>

Throws:

IOException

supportsNormalizedKey

public boolean supportsNormalizedKey()

Specified by:

supportsNormalizedKey in class TypeComparator<Record>

getNormalizeKeyLen

public int getNormalizeKeyLen()

Specified by:

getNormalizeKeyLen in class TypeComparator<Record>

isNormalizedKeyPrefixOnly

public boolean isNormalizedKeyPrefixOnly(int keyBytes)

Specified by:

isNormalizedKeyPrefixOnly in class TypeComparator<Record>

putNormalizedKey

public void putNormalizedKey(Record record,
                    MemorySegment target,
                    int offset,
                    int numBytes)

Specified by:

putNormalizedKey in class TypeComparator<Record>

invertNormalizedKey

public boolean invertNormalizedKey()

Specified by:

invertNormalizedKey in class TypeComparator<Record>

supportsSerializationWithKeyNormalization

public boolean supportsSerializationWithKeyNormalization()

Specified by:

supportsSerializationWithKeyNormalization in class TypeComparator<Record>

writeWithKeyNormalization

public void writeWithKeyNormalization(Record record,
                             DataOutputView target)

Specified by:

writeWithKeyNormalization in class TypeComparator<Record>

readWithKeyDenormalization

public Record readWithKeyDenormalization(Record reuse,
                                DataInputView source)

Specified by:

readWithKeyDenormalization in class TypeComparator<Record>

duplicate

public RecordComparator duplicate()

Specified by:

duplicate in class TypeComparator<Record>

getKeyPositions

public final int[] getKeyPositions()

getKeyTypes

public final Class<? extends Key<?>>[] getKeyTypes()

getKeysAsCopy

public final Key<?>[] getKeysAsCopy(Record record)

supportsCompareAgainstReference

public boolean supportsCompareAgainstReference()

Overrides:

supportsCompareAgainstReference in class TypeComparator<Record>

compareAgainstReference

public final int compareAgainstReference(Comparable[] keys)

Overrides:

compareAgainstReference in class TypeComparator<Record>