/*******************************************************************************
 * Copyright 2010 Cees De Groot, Alex Boisvert, Jan Kotek
 * 
 * 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 de.mxro.thrd.jdbm2V22;

import java.util.Comparator;
import java.util.Map;

import de.mxro.thrd.jdbm2V22.helper.JdbmBase;


/**
 * Primary Map which persist data in storage. 
 * Behavior is very similar to  <code>java.util.HashMap/code>.
 * PrimaryMaps have some additional methods to create secondary views. 
 * <p>
 *  
 * @author Jan Kotek
 *
 * @param <K> key type
 * @param <V> value type
 */
public interface PrimaryMap<K,V> extends JdbmBase<K,V>, Map<K,V>{

	/**
	 * Secondary hash view over this PrimaryMap. 
	 * It is readonly, is auto updated as PrimaryMaps is modified. 
	 * View is indexed and persisted, so lookup is always fast
	 *  
	 * @param <A> type of secondary key
	 * @param objectName under this name view will be stored in storage
	 * @param secondaryKeyExtractor extracts secondary key from primary map
	 * @return secondary map 
	 */
	<A> SecondaryHashMap<A,K,V> secondaryHashMap(String objectName, 
			SecondaryKeyExtractor<A,K,V> secondaryKeyExtractor);

	<A> SecondaryHashMap<A,K,V> secondaryHashMapManyToOne(String objectName, 
			SecondaryKeyExtractor<Iterable<A>,K,V> secondaryKeyExtractor);


	<A> SecondaryTreeMap<A,K,V> secondaryTreeMap(String objectName, 
			SecondaryKeyExtractor<A,K,V> secondaryKeyExtractor,Comparator<A> secondaryKeyComparator);

	@SuppressWarnings("unchecked")
	<A extends Comparable> SecondaryTreeMap<A,K,V> secondaryTreeMap(String objectName, 
			SecondaryKeyExtractor<A,K,V> secondaryKeyExtractor);

	<A> SecondaryTreeMap<A,K,V> secondaryTreeMapManyToOne(String objectName, 
			SecondaryKeyExtractor<Iterable<A>,K,V> secondaryKeyExtractor,Comparator<A> secondaryKeyComparator);

	@SuppressWarnings("unchecked")
	<A extends Comparable> SecondaryTreeMap<A,K,V> secondaryTreeMapManyToOne(String objectName, 
			SecondaryKeyExtractor<Iterable<A>,K,V> secondaryKeyExtractor);

    <A> SecondaryHashMap<A,K,V> secondaryHashMap(String objectName,
            SecondaryKeyExtractor<A,K,V> secondaryKeyExtractor, Serializer<A> secondaryKeySerializer);

    <A> SecondaryHashMap<A,K,V> secondaryHashMapManyToOne(String objectName,
            SecondaryKeyExtractor<Iterable<A>,K,V> secondaryKeyExtractor, Serializer<A> secondaryKeySerializer);


    <A> SecondaryTreeMap<A,K,V> secondaryTreeMap(String objectName,
            SecondaryKeyExtractor<A,K,V> secondaryKeyExtractor,Comparator<A> secondaryKeyComparator,
            Serializer<A> secondaryKeySerializer);

    @SuppressWarnings("unchecked")
    <A extends Comparable> SecondaryTreeMap<A,K,V> secondaryTreeMap(String objectName,
            SecondaryKeyExtractor<A,K,V> secondaryKeyExtractor,
            Serializer<A> secondaryKeySerializer);

    <A> SecondaryTreeMap<A,K,V> secondaryTreeMapManyToOne(String objectName,
            SecondaryKeyExtractor<Iterable<A>,K,V> secondaryKeyExtractor,Comparator<A> secondaryKeyComparator,
            Serializer<A> secondaryKeySerializer);

    @SuppressWarnings("unchecked")
    <A extends Comparable> SecondaryTreeMap<A,K,V> secondaryTreeMapManyToOne(String objectName,
            SecondaryKeyExtractor<Iterable<A>,K,V> secondaryKeyExtractor,
            Serializer<A> secondaryKeySerializer);


	InverseHashView<K,V> inverseHashView(String name);

}