/*
// $Id: //open/dev/farrago/src/org/eigenbase/oj/rel/JavaRel.java#10 $
// Package org.eigenbase is a class library of data management components.
// Copyright (C) 2005-2009 The Eigenbase Project
// Copyright (C) 2002-2009 SQLstream, Inc.
// Copyright (C) 2005-2009 LucidEra, Inc.
// Portions Copyright (C) 2003-2009 John V. Sichi
//
// This program is free software; you can redistribute it and/or modify it
// under the terms of the GNU General Public License as published by the Free
// Software Foundation; either version 2 of the License, or (at your option)
// any later version approved by The Eigenbase Project.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
*/
package org.eigenbase.oj.rel;

import openjava.ptree.*;

import org.eigenbase.rel.*;


/**
 * A relational expression of one of the the Java-based calling conventions.
 *
 * <p>Objects which implement this interface must:
 *
 * <ul>
 * <li>extend {@link org.eigenbase.rel.AbstractRelNode}, and</li>
 * <li>return one of the following calling-conventions from their {@link
 * #getConvention} method:
 *
 * <ul>
 * <li>{@link org.eigenbase.relopt.CallingConvention#ARRAY ARRAY},
 * <li>{@link org.eigenbase.relopt.CallingConvention#ITERABLE ITERABLE},
 * <li>{@link org.eigenbase.relopt.CallingConvention#ITERATOR ITERATOR},
 * <li>{@link org.eigenbase.relopt.CallingConvention#COLLECTION COLLECTION},
 * <li>{@link org.eigenbase.relopt.CallingConvention#MAP MAP},
 * <li>{@link org.eigenbase.relopt.CallingConvention#VECTOR VECTOR},
 * <li>{@link org.eigenbase.relopt.CallingConvention#HASHTABLE HASHTABLE},
 * <li>{@link org.eigenbase.relopt.CallingConvention#JAVA JAVA}
 * </ul>
 * </li>
 * </ul>
 *
 * <p>For {@link org.eigenbase.relopt.CallingConvention#JAVA JAVA
 * calling-convention}, see the sub-interface {@link JavaLoopRel}, and the
 * auxilliary interface {@link JavaSelfRel}.
 *
 * @author jhyde
 * @version $Id: //open/dev/farrago/src/org/eigenbase/oj/rel/JavaRel.java#10 $
 * @since Nov 22, 2003
 */
public interface JavaRel
    extends RelNode
{
    //~ Methods ----------------------------------------------------------------

    /**
     * Creates a plan for this expression according to a calling convention.
     *
     * @param implementor implementor
     */
    ParseTree implement(JavaRelImplementor implementor);
}

// End JavaRel.java
