flink-libraries/flink-table/src/main/java/org/apache/flink/table/runtime/sort/NormalizedKeyComputer.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.apache.flink.table.runtime.sort;

import org.apache.flink.api.common.typeutils.TypeComparator;
import org.apache.flink.api.common.typeutils.TypeSerializer;
import org.apache.flink.core.memory.MemorySegment;
import org.apache.flink.table.dataformat.BaseRow;

/**
 * Normalized key computer for {@link BinaryInMemorySortBuffer}.
 */
public abstract class NormalizedKeyComputer {

	protected TypeSerializer[] serializers;
	protected TypeComparator[] comparators;

	public void init(TypeSerializer[] serializers, TypeComparator[] comparators) {
		this.serializers = serializers;
		this.comparators = comparators;
	}

	/**
	 * Writes a normalized key for the given record into the target {@link MemorySegment}.
	 */
	public abstract void putKey(BaseRow record, MemorySegment target, int offset);

	/**
	 * Compares two normalized keys in respective {@link MemorySegment}.
	 */
	public abstract int compareKey(MemorySegment segI, int offsetI, MemorySegment segJ, int offsetJ);

	/**
	 * Swaps two normalized keys in respective {@link MemorySegment}.
	 */
	public abstract void swapKey(MemorySegment segI, int offsetI, MemorySegment segJ, int offsetJ);

	/**
	 * Get normalized keys bytes length.
	 */
	public abstract int getNumKeyBytes();

	/**
	 * whether the normalized key can fully determines the comparison.
	 */
	public abstract boolean isKeyFullyDetermines();

	/**
	 * Flag whether normalized key comparisons should be inverted key.
	 */
	public abstract boolean invertKey();
}