org.apache.flink.runtime.state.heap.HeapPriorityQueueStateSnapshot Maven / Gradle / Ivy
/*
* 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.runtime.state.heap;
import org.apache.flink.api.common.typeutils.TypeSerializer;
import org.apache.flink.runtime.state.KeyExtractorFunction;
import org.apache.flink.runtime.state.KeyGroupPartitioner;
import org.apache.flink.runtime.state.KeyGroupRange;
import org.apache.flink.runtime.state.RegisteredPriorityQueueStateBackendMetaInfo;
import org.apache.flink.runtime.state.StateSnapshot;
import org.apache.flink.runtime.state.metainfo.StateMetaInfoSnapshot;
import javax.annotation.Nonnegative;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import java.lang.reflect.Array;
/**
* This class represents the snapshot of an {@link HeapPriorityQueueSet}.
*
* @param type of the state elements.
*/
public class HeapPriorityQueueStateSnapshot implements StateSnapshot {
/** Function that extracts keys from elements. */
@Nonnull
private final KeyExtractorFunction keyExtractor;
/** Copy of the heap array containing all the (immutable or deeply copied) elements. */
@Nonnull
private final T[] heapArrayCopy;
/** The meta info of the state. */
@Nonnull
private final RegisteredPriorityQueueStateBackendMetaInfo metaInfo;
/** The key-group range covered by this snapshot. */
@Nonnull
private final KeyGroupRange keyGroupRange;
/** The total number of key-groups in the job. */
@Nonnegative
private final int totalKeyGroups;
/** Result of partitioning the snapshot by key-group. */
@Nullable
private StateKeyGroupWriter stateKeyGroupWriter;
HeapPriorityQueueStateSnapshot(
@Nonnull T[] heapArrayCopy,
@Nonnull KeyExtractorFunction keyExtractor,
@Nonnull RegisteredPriorityQueueStateBackendMetaInfo metaInfo,
@Nonnull KeyGroupRange keyGroupRange,
@Nonnegative int totalKeyGroups) {
this.keyExtractor = keyExtractor;
this.heapArrayCopy = heapArrayCopy;
this.metaInfo = metaInfo;
this.keyGroupRange = keyGroupRange;
this.totalKeyGroups = totalKeyGroups;
}
@SuppressWarnings("unchecked")
@Nonnull
@Override
public StateKeyGroupWriter getKeyGroupWriter() {
if (stateKeyGroupWriter == null) {
T[] partitioningOutput = (T[]) Array.newInstance(
heapArrayCopy.getClass().getComponentType(),
heapArrayCopy.length);
final TypeSerializer elementSerializer = metaInfo.getElementSerializer();
KeyGroupPartitioner keyGroupPartitioner =
new KeyGroupPartitioner<>(
heapArrayCopy,
heapArrayCopy.length,
partitioningOutput,
keyGroupRange,
totalKeyGroups,
keyExtractor,
elementSerializer::serialize);
stateKeyGroupWriter = keyGroupPartitioner.partitionByKeyGroup();
}
return stateKeyGroupWriter;
}
@Nonnull
@Override
public StateMetaInfoSnapshot getMetaInfoSnapshot() {
return metaInfo.snapshot();
}
@Override
public void release() {
}
}