/***********************************************************************************************************************
 *
 * Copyright (C) 2010 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.resettable;

import java.io.IOException;
import java.util.Collections;
import java.util.Iterator;
import java.util.List;
import java.util.NoSuchElementException;

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;

import eu.stratosphere.nephele.services.iomanager.IOManager;
import eu.stratosphere.nephele.services.memorymanager.DataInputView;
import eu.stratosphere.nephele.services.memorymanager.ListMemorySegmentSource;
import eu.stratosphere.nephele.services.memorymanager.MemoryAllocationException;
import eu.stratosphere.nephele.services.memorymanager.MemoryManager;
import eu.stratosphere.nephele.services.memorymanager.MemorySegment;
import eu.stratosphere.nephele.template.AbstractInvokable;
import eu.stratosphere.pact.generic.types.TypeSerializer;
import eu.stratosphere.pact.runtime.io.SpillingBuffer;
import eu.stratosphere.pact.runtime.util.ResettableIterator;

/**
 * Implementation of a resettable iterator. While iterating the first time over the data, the iterator writes the
 * records to a spillable buffer. Any subsequent iteration re-reads the data from that buffer.
 * 
 * @author Stephan Ewen
 * @param <T> The type of record that the iterator handles.
 */
public class SpillingResettableIterator<T> implements ResettableIterator<T>
{
	private static final Log LOG = LogFactory.getLog(SpillingResettableIterator.class);
	
	// ------------------------------------------------------------------------

	private T next;
	
	private final T instance;
	
	protected DataInputView inView;
	
	protected final TypeSerializer<T> serializer;
	
	private int elementCount;
	
	private int currentElementNum;
	
	protected final SpillingBuffer buffer;
	
	protected final Iterator<T> input;
	
	protected final MemoryManager memoryManager;
	
	private final List<MemorySegment> memorySegments;
	
	private final boolean releaseMemoryOnClose;
	
	// ------------------------------------------------------------------------


	public SpillingResettableIterator(Iterator<T> input, TypeSerializer<T> serializer, 
			MemoryManager memoryManager, IOManager ioManager,
			long availableMemory, AbstractInvokable parentTask)
	throws MemoryAllocationException
	{
		this(input, serializer, memoryManager, ioManager, memoryManager.allocatePages(parentTask, availableMemory), true);
	}
	
	public SpillingResettableIterator(Iterator<T> input, TypeSerializer<T> serializer,
			MemoryManager memoryManager, IOManager ioManager, List<MemorySegment> memory)
	{
		this(input, serializer, memoryManager, ioManager, memory, false);
	}
	
	private SpillingResettableIterator(Iterator<T> input, TypeSerializer<T> serializer,
			MemoryManager memoryManager, IOManager ioManager,
			List<MemorySegment> memory, boolean releaseMemOnClose)
	{
		this.memoryManager = memoryManager;
		this.input = input;
		this.instance = serializer.createInstance();
		this.serializer = serializer;
		this.memorySegments = memory;
		this.releaseMemoryOnClose = releaseMemOnClose;
		
		if (LOG.isDebugEnabled())
			LOG.debug("Creating spilling resettable iterator with " + memory.size() + " pages of memory.");
		
		this.buffer = new SpillingBuffer(ioManager, new ListMemorySegmentSource(memory), memoryManager.getPageSize());
	}

	
	public void open() throws IOException
	{
		if (LOG.isDebugEnabled())
			LOG.debug("Spilling Resettable Iterator opened.");
	}

	public void reset() throws IOException
	{
		this.inView = this.buffer.flip();
		this.currentElementNum = 0;
	}

	@Override
	public boolean hasNext()
	{
		if (this.next == null) {
			if (this.inView != null) {
				if (this.currentElementNum < this.elementCount) {
					try {
						this.serializer.deserialize(this.instance, this.inView);
					} catch (IOException e) {
						throw new RuntimeException("SpillingIterator: Error reading element from buffer.", e);
					}
					this.next = this.instance;
					this.currentElementNum++;
					return true;
				} else {
					return false;
				}
			} else {
				// writing pass (first)
				if (this.input.hasNext()) {
					this.next = this.input.next();
					try {
						this.serializer.serialize(this.next, this.buffer);
					} catch (IOException e) {
						throw new RuntimeException("SpillingIterator: Error writing element to buffer.", e);
					}
					this.elementCount++;
					return true;
				} else {
					return false;
				}
			}
		} else {
			return true;
		}
	}

	@Override
	public T next()
	{
		if (this.next != null || hasNext()) {
			final T out = this.next;
			this.next = null;
			return out;
		} else {
			throw new NoSuchElementException();
		}
	}

	@Override
	public void remove() {
		throw new UnsupportedOperationException();
	}

	public List<MemorySegment> close() throws IOException
	{
		if (LOG.isDebugEnabled())
			LOG.debug("Spilling Resettable Iterator closing. Stored " + this.elementCount + " records.");

		this.inView = null;
		
		final List<MemorySegment> memory = this.buffer.close();
		memory.addAll(this.memorySegments);
		this.memorySegments.clear();
		
		if (this.releaseMemoryOnClose) {
			this.memoryManager.release(memory);
			return Collections.emptyList();
		} else {
			return memory;
		}
	}
}
