com.bigdata.bop.join.IHashJoinUtilityFactory Maven / Gradle / Ivy

Go to download
/**

Copyright (C) SYSTAP, LLC DBA Blazegraph 2006-2016.  All rights reserved.

Contact:
     SYSTAP, LLC DBA Blazegraph
     2501 Calvert ST NW #106
     Washington, DC 20008
     [email protected]

This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General License as published by
the Free Software Foundation; version 2 of the License.

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 License for more details.

You should have received a copy of the GNU General License
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */
/*
 * Created on Aug 19, 2015
 */

package com.bigdata.bop.join;

import java.io.Serializable;

import com.bigdata.bop.BOpContext;
import com.bigdata.bop.BOpEvaluationContext;
import com.bigdata.bop.IBindingSet;
import com.bigdata.bop.PipelineOp;
import com.bigdata.bop.controller.INamedSolutionSetRef;

/**
 * Interface for the factory pattern to create a {@link IHashJoinUtility}.
 * 
 * @see BLZG-1438 (by using such a factory as an annotation of
 *                 {@link HashIndexOpBase} it becomes possible
 *                 to get rid of the two earlier subclasses of
 *                 {@link HashIndexOp} (namely, HTreeHashIndexOp
 *                 and JVMHashIndexOp) which imposed the duplication
 *                 of code) 
 *
 * @author Olaf Hartig
 * @version $Id$
 */
public interface IHashJoinUtilityFactory extends Serializable {
    
    /**
     * Return an instance of the {@link IHashJoinUtility}.
     * 
     * @param context
     *            The {@link BOpEvaluationContext}
     * @param namedSetRef
     *            Metadata to identify the named solution set.
     * @param op
     *            The operator whose annotation will inform the construction of
     *            the hash index. 
     * @param joinType
     *            The type of join.
     */
    IHashJoinUtility create(//
            final BOpContext context,//
            final INamedSolutionSetRef namedSetRef,//
            final PipelineOp op,//
            final JoinTypeEnum joinType//
            );
    
}