/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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 org.apache.pig.pen;

import org.apache.pig.data.Tuple;

public interface Illustrable {
    public void setIllustrator(Illustrator illustrator);
    /**
     * input tuple mark up to be illustrate-able
     * @param in             input tuple
     * @param out            output tuple before wrapped in ExampleTuple
     * @param eqClassIndex   index into equivalence classes in illustrator
     * 
     * @return               tuple
     */
    public Tuple illustratorMarkup(Object in, Object out, int eqClassIndex);
}