org.eclipse.rdf4j.query.algebra.BinaryTupleOperator Maven / Gradle / Ivy

Go to download
/*******************************************************************************
 * Copyright (c) 2015 Eclipse RDF4J contributors, Aduna, and others.
 *
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Distribution License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/org/documents/edl-v10.php.
 *
 * SPDX-License-Identifier: BSD-3-Clause
 *******************************************************************************/
package org.eclipse.rdf4j.query.algebra;

import java.util.HashSet;
import java.util.Objects;
import java.util.Set;

import org.eclipse.rdf4j.common.annotation.Experimental;
import org.eclipse.rdf4j.common.iteration.CloseableIteration;
import org.eclipse.rdf4j.common.order.AvailableStatementOrder;

/**
 * An abstract superclass for binary tuple operators which, by definition, has two arguments.
 */
public abstract class BinaryTupleOperator extends AbstractQueryModelNode implements TupleExpr {

	/*-----------*
	 * Variables *
	 *-----------*/

	/**
	 * The operator's left argument.
	 */
	protected TupleExpr leftArg;

	/**
	 * The operator's right argument.
	 */
	protected TupleExpr rightArg;

	// the name of the algorithm used to combine leftArg and rightArg
	private String algorithmName;

	/*--------------*
	 * Constructors *
	 *--------------*/

	protected BinaryTupleOperator() {
	}

	/**
	 * Creates a new binary tuple operator.
	 *
	 * @param leftArg  The operator's left argument, must not be null.
	 * @param rightArg The operator's right argument, must not be null.
	 */
	protected BinaryTupleOperator(TupleExpr leftArg, TupleExpr rightArg) {
		setLeftArg(leftArg);
		setRightArg(rightArg);
	}

	/*---------*
	 * Methods *
	 *---------*/

	/**
	 * Gets the left argument of this binary tuple operator.
	 *
	 * @return The operator's left argument.
	 */
	public TupleExpr getLeftArg() {
		return leftArg;
	}

	/**
	 * Sets the left argument of this binary tuple operator.
	 *
	 * @param leftArg The (new) left argument for this operator, must not be null.
	 */
	public void setLeftArg(TupleExpr leftArg) {
		assert leftArg != null : "leftArg must not be null";
		assert leftArg != this : "leftArg must not be itself";
		leftArg.setParentNode(this);
		this.leftArg = leftArg;
	}

	/**
	 * Gets the right argument of this binary tuple operator.
	 *
	 * @return The operator's right argument.
	 */
	public TupleExpr getRightArg() {
		return rightArg;
	}

	/**
	 * Sets the right argument of this binary tuple operator.
	 *
	 * @param rightArg The (new) right argument for this operator, must not be null.
	 */
	public void setRightArg(TupleExpr rightArg) {
		assert rightArg != null : "rightArg must not be null";
		assert rightArg != this : "rightArg must not be itself";
		rightArg.setParentNode(this);
		this.rightArg = rightArg;
	}

	@Override
	public  void visitChildren(QueryModelVisitor visitor) throws X {
		leftArg.visit(visitor);
		rightArg.visit(visitor);
	}

	@Override
	public void replaceChildNode(QueryModelNode current, QueryModelNode replacement) {
		if (leftArg == current) {
			setLeftArg((TupleExpr) replacement);
		} else if (rightArg == current) {
			setRightArg((TupleExpr) replacement);
		}
	}

	@Override
	public boolean equals(Object other) {
		if (other instanceof BinaryTupleOperator) {
			BinaryTupleOperator o = (BinaryTupleOperator) other;
			return leftArg.equals(o.getLeftArg()) && rightArg.equals(o.getRightArg());
		}

		return false;
	}

	@Override
	public int hashCode() {
		return leftArg.hashCode() ^ rightArg.hashCode();
	}

	@Override
	public BinaryTupleOperator clone() {
		BinaryTupleOperator clone = (BinaryTupleOperator) super.clone();

		TupleExpr leftArgClone = getLeftArg().clone();
		leftArgClone.setParentNode(clone);
		clone.leftArg = leftArgClone;

		TupleExpr rightArgClone = getRightArg().clone();
		rightArgClone.setParentNode(clone);
		clone.rightArg = rightArgClone;

		return clone;
	}

	@Experimental
	public void setAlgorithm(CloseableIteration iteration) {
		this.algorithmName = iteration.getClass().getSimpleName();
	}

	@Experimental
	public void setAlgorithm(String classSimpleName) {
		this.algorithmName = classSimpleName;
	}

	@Experimental
	public String getAlgorithmName() {
		return algorithmName;
	}

	@Override
	public Set getSupportedOrders(AvailableStatementOrder tripleSource) {
		Set leftArgSupportedOrders = leftArg.getSupportedOrders(tripleSource);
		Set rightArgSupportedOrders = rightArg.getSupportedOrders(tripleSource);
		if (leftArgSupportedOrders.equals(rightArgSupportedOrders)) {
			return leftArgSupportedOrders;
		} else {
			HashSet intersection = new HashSet<>(leftArgSupportedOrders);
			intersection.retainAll(rightArgSupportedOrders);
			return intersection;
		}

	}

	@Override
	public void setOrder(Var var) {
		leftArg.setOrder(var);
		rightArg.setOrder(var);
	}

	@Override
	public Var getOrder() {
		Var leftArgOrder = leftArg.getOrder();
		Var rightArgOrder = rightArg.getOrder();
		assert Objects.equals(leftArgOrder, rightArgOrder);
		return leftArgOrder;
	}
}