All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.apache.flink.runtime.state.heap.NestedMapsStateTable Maven / Gradle / Ivy

There is a newer version: 1.13.6
Show newest version
/*
 * 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.annotation.Internal;
import org.apache.flink.api.common.typeutils.TypeSerializer;
import org.apache.flink.runtime.state.RegisteredKeyValueStateBackendMetaInfo;
import org.apache.flink.runtime.state.StateSnapshotTransformer;

import javax.annotation.Nonnull;

/**
 * This implementation of {@link StateTable} uses {@link NestedStateMap}.
 *
 * @param  type of key.
 * @param  type of namespace.
 * @param  type of state.
 */
@Internal
public class NestedMapsStateTable extends StateTable {

	/**
	 * Creates a new {@link NestedMapsStateTable} for the given key context and meta info.
	 * @param keyContext the key context.
	 * @param metaInfo the meta information for this state table.
	 * @param keySerializer the serializer of the key.
	 */
	public NestedMapsStateTable(
		InternalKeyContext keyContext,
		RegisteredKeyValueStateBackendMetaInfo metaInfo,
		TypeSerializer keySerializer) {
		super(keyContext, metaInfo, keySerializer);
	}

	@Override
	protected NestedStateMap createStateMap() {
		return new NestedStateMap<>();
	}

	// Snapshotting ----------------------------------------------------------------------------------------------------

	@Nonnull
	@Override
	public NestedMapsStateTableSnapshot stateSnapshot() {
		return new NestedMapsStateTableSnapshot<>(
			this,
			getKeySerializer(),
			getNamespaceSerializer(),
			getStateSerializer(),
			getMetaInfo().getStateSnapshotTransformFactory().createForDeserializedState().orElse(null));
	}

	/**
	 * This class encapsulates the snapshot logic.
	 *
	 * @param  type of key.
	 * @param  type of namespace.
	 * @param  type of state.
	 */
	static class NestedMapsStateTableSnapshot
			extends AbstractStateTableSnapshot {

		NestedMapsStateTableSnapshot(
			NestedMapsStateTable owningTable,
			TypeSerializer localKeySerializer,
			TypeSerializer localNamespaceSerializer,
			TypeSerializer localStateSerializer,
			StateSnapshotTransformer stateSnapshotTransformer) {
			super(owningTable,
				localKeySerializer,
				localNamespaceSerializer,
				localStateSerializer,
				stateSnapshotTransformer);
		}

		@Override
		protected StateMapSnapshot> getStateMapSnapshotForKeyGroup(int keyGroup) {
			NestedStateMap stateMap = (NestedStateMap) owningStateTable.getMapForKeyGroup(keyGroup);

			return stateMap.stateSnapshot();
		}

		@Override
		public void release() {
		}
	}
}