com.hazelcast.query.impl.IndexProvider Maven / Gradle / Ivy
/*
* Copyright (c) 2008-2021, Hazelcast, Inc. All Rights Reserved.
*
* Licensed 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 com.hazelcast.query.impl;
import com.hazelcast.config.IndexConfig;
import com.hazelcast.internal.serialization.InternalSerializationService;
import com.hazelcast.internal.monitor.impl.PerIndexStats;
import com.hazelcast.query.impl.getters.Extractors;
/**
* Provides storage-specific indexes to {@link com.hazelcast.query.impl.Indexes
* Indexes}.
*/
public interface IndexProvider {
/**
* Creates a new index with the given name.
*
* @param config Index configuration.
* @param extractors the extractors to extract values of the given
* name.
* @param ss the serialization service to perform the
* deserialization of entries while extracting values
* from them.
* @param copyBehavior the desired index copy behaviour.
* @param stats the index stats instance to report the statistics to.
* @param storeAdapter the reference to the store adapter. {@code null} if the index is global.
* @return the created index instance.
*/
InternalIndex createIndex(
IndexConfig config,
Extractors extractors,
InternalSerializationService ss,
IndexCopyBehavior copyBehavior,
PerIndexStats stats,
int partitionCount);
}