001 /** 002 * Licensed to the Apache Software Foundation (ASF) under one or more 003 * contributor license agreements. See the NOTICE file distributed with 004 * this work for additional information regarding copyright ownership. 005 * The ASF licenses this file to You under the Apache License, Version 2.0 006 * (the "License"); you may not use this file except in compliance with 007 * the License. You may obtain a copy of the License at 008 * 009 * http://www.apache.org/licenses/LICENSE-2.0 010 * 011 * Unless required by applicable law or agreed to in writing, software 012 * distributed under the License is distributed on an "AS IS" BASIS, 013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 014 * See the License for the specific language governing permissions and 015 * limitations under the License. 016 */ 017 package org.fusesource.hawtdb.api; 018 019 /** 020 * The common interface to {@link Index} factories. An index factory 021 * allows you to create or open an index in a {@link Paged} object. 022 * 023 * @author <a href="http://hiramchirino.com">Hiram Chirino</a> 024 */ 025 public interface IndexFactory<Key, Value> { 026 027 /** 028 * 029 * @param paged 030 * @param page 031 * @return 032 */ 033 public Index<Key, Value> create(Paged paged); 034 035 /** 036 * 037 * @param paged 038 * @param indexNumber 039 * @return 040 */ 041 public Index<Key, Value> open(Paged paged, int indexNumber); 042 043 /** 044 * 045 * @param paged 046 * @return 047 */ 048 public Index<Key, Value> open(Paged paged); 049 }