org.apache.flink.runtime.state.gemini.engine.page.PageIndexContext 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.gemini.engine.page;
import org.apache.flink.annotation.Internal;
/**
* Context of specific {@link LogicalPageChain}.
*/
@Internal
public interface PageIndexContext {
/**
* Returns current logical chained page of this context.
*
* @return current logical chained page of this context.
*/
LogicalPageChain getLogicalPageChain();
/**
* Returns the index of current logical chained page at the array of {@link LogicalPageChain} within previous {@link PageIndex}.
*
* @return The index of current logical chained page at the array of {@link LogicalPageChain} within previous {@link PageIndex}.
*/
int getPageIndexID();
/**
* Return true if this {@link LogicalPageChain} need to be split, otherwise false.
*
* @return true if this {@link LogicalPageChain} need to be split, otherwise false.
*/
boolean isNeedSplit();
}