com.bigdata.service.proxy.IRemoteChunk Maven / Gradle / Ivy

Go to download
package com.bigdata.service.proxy;

import java.io.Serializable;
import java.rmi.Remote;

import com.bigdata.striterator.IKeyOrder;

/**
 * Abstraction for a chunk from a remote iterator. Instances of this interface
 * are serialized by a remote service and materialized on the client. The
 * interface itself is NOT {@link Remote}.
 * 
 * @author Bryan Thompson
 * @version $Id$
 * @param 
 *            The generic type of the elements in the chunk.
 */
public interface IRemoteChunk extends Serializable {

    /**
     * true iff the iterator will not return any more chunks.
     */
    boolean isExhausted();

    /**
     * The elements in the current chunk -or- null iff there are
     * NO elements in the chunk.
     */
    public E[] getChunk();

    /**
     * The natural sort orded of the elements in this chunk -or-
     * null if the elements are not in any known order.
     * 
     * Note: The returned value should be the same each time for a given source
     * iterator. It is put here so that we can avoid an RMI for this property
     * and the expense of serializing the value with each chunk.
     */
    public IKeyOrder getKeyOrder();

}