eu.stratosphere.pact.runtime.hash.AbstractMutableHashTable Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of stratosphere-runtime Show documentation
There is a newer version: 0.5.2-hadoop2
/***********************************************************************************************************************
 *
 * Copyright (C) 2010-2014 by the Stratosphere project (http://stratosphere.eu)
 *
 * 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 eu.stratosphere.pact.runtime.hash;

import java.io.IOException;
import java.util.List;

import eu.stratosphere.api.common.typeutils.TypeComparator;
import eu.stratosphere.api.common.typeutils.TypePairComparator;
import eu.stratosphere.api.common.typeutils.TypeSerializer;
import eu.stratosphere.core.memory.MemorySegment;
import eu.stratosphere.util.MutableObjectIterator;

public abstract class AbstractMutableHashTable {
	
	/**
	 * The utilities to serialize the build side data types.
	 */
	protected final TypeSerializer buildSideSerializer;
	
	/**
	 * The utilities to hash and compare the build side data types.
	 */
	protected final TypeComparator buildSideComparator;
	
	
	public AbstractMutableHashTable (TypeSerializer buildSideSerializer, TypeComparator buildSideComparator) {
		this.buildSideSerializer = buildSideSerializer;
		this.buildSideComparator = buildSideComparator;
	}
	
	public TypeSerializer getBuildSideSerializer() {
		return this.buildSideSerializer;
	}
	
	public TypeComparator getBuildSideComparator() {
		return this.buildSideComparator;
	}
	
	// ------------- Life-cycle functions -------------
	
	public abstract void open();
	
	public abstract void close();
	
	public abstract void abort();
	
	public abstract void buildTable(final MutableObjectIterator input) throws IOException;
	
	public abstract List getFreeMemory();
	
	// ------------- Modifier -------------
	
	public abstract void insert(T record) throws IOException;
	
	public abstract void insertOrReplaceRecord(T record, T tempHolder) throws IOException;
	
	// ------------- Accessors -------------
	
	public abstract MutableObjectIterator getEntryIterator();
	
	/**
	 * 
	 * @param probeSideComparator
	 * @param pairComparator
	 * @param  The type of the probe side.
	 * @return
	 */
	public abstract  AbstractHashTableProber getProber(TypeComparator probeSideComparator, TypePairComparator pairComparator);

}