WhereClause.java

/*
 * 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.jena.arq.querybuilder.clauses;

import org.apache.jena.arq.querybuilder.AbstractQueryBuilder;
import org.apache.jena.arq.querybuilder.SelectBuilder;
import org.apache.jena.arq.querybuilder.handlers.WhereHandler;
import org.apache.jena.graph.FrontsTriple ;
import org.apache.jena.graph.Node;
import org.apache.jena.graph.Triple ;
import org.apache.jena.sparql.expr.Expr;
import org.apache.jena.sparql.lang.sparql_11.ParseException ;

/**
 * Interface that defines the WhereClause as per
 * http://www.w3.org/TR/2013/REC-sparql11-query-20130321/#rWhereClause
 * 
 * @param <T>
 *            The Builder type that the clause is part of.
 */
public interface WhereClause<T extends AbstractQueryBuilder<T>> {

	/**
	 * Adds a triple as to the where clause.
	 * 
	 * @param t
	 *            The triple to add
	 * @return The Builder for chaining.
	 */
	public T addWhere(Triple t);

	/**
	 * Adds a triple as to the where clause.
	 * 
	 * @param t
	 *            The triple to add
	 * @return The Builder for chaining.
	 */
	public T addWhere(FrontsTriple t);

	/**
	 * Adds a triple to the where clause.
	 * 
	 * See {@link AbstractQueryBuilder#makeNode} for conversion of the param values.
	 * 
	 * @param s
	 *            The subject.
	 * @param p
	 *            The predicate.
	 * @param o
	 *            The object.
	 * @return The Builder for chaining.
	 */
	public T addWhere(Object s, Object p, Object o);

	/**
	 * Adds an optional triple to the where clause.
	 * 
	 * @param t
	 *            The triple to add
	 * @return The Builder for chaining.
	 */
	public T addOptional(Triple t);

	/**
	 * Adds an optional triple as to the where clause.
	 * 
	 * @param t
	 *            The triple to add
	 * @return The Builder for chaining.
	 */
	public T addOptional(FrontsTriple t);

	/**
	 * Adds an optional triple to the where clause.
	 * 
	 * See {@link AbstractQueryBuilder#makeNode} for conversion of the param values.
	 * 
	 * @param s
	 *            The subject.
	 * @param p
	 *            The predicate.
	 * @param o
	 *            The object.
	 * @return The Builder for chaining.
	 */
	public T addOptional(Object s, Object p, Object o);
	
	/**
	 * Adds an optional group pattern to the where clause.
	 * 
	 * @param t
	 *            The select builder to add as a group pattern
	 * @return The Builder for chaining.
	 */
	public T addOptional(SelectBuilder t);

	/**
	 * Adds a filter to the where clause
	 * 
	 * @param expression
	 *            the expression to evaluate for the filter.
	 * @return @return The Builder for chaining.
	 * @throws ParseException
	 *             If the expression can not be parsed.
	 */
	public T addFilter(String expression) throws ParseException;

	/**
	 * Add a sub query.
	 * 
	 * @param subQuery
	 *            The subquery as defined by a SelectBuilder.
	 * @return This builder for chaining.
	 */
	public T addSubQuery(SelectBuilder subQuery);

	/**
	 * Add a union.
	 * 
	 * @param union
	 *            The union as defined by a SelectBuilder.
	 * @return This builder for chaining.
	 */
	public T addUnion(SelectBuilder union);

	/**
	 * Add a graph statement to the query as per
	 * http://www.w3.org/TR/2013/REC-sparql11
	 * -query-20130321/#rGraphGraphPattern.
	 * 
	 * See {@link AbstractQueryBuilder#makeNode} for conversion of the graph param.
	 * 
	 * @param graph
	 *            The iri or variable identifying the graph.
	 * @param subQuery
	 *            The graph to add.
	 * @return This builder for chaining.
	 */
	public T addGraph(Object graph, SelectBuilder subQuery);
	
	/**
	 * Add a bind statement to the query
	 * * http://www.w3.org/TR/2013/REC-sparql11-query-20130321/#rGraphGraphPattern.
	 * @param expression The expression to bind to the var.
	 * @param var The variable to bind to.
	 * @return This builder for chaining.
	 */
	public T addBind( Expr expression, Object var);

	/**
	 * Add a bind statement to the query
	 * http://www.w3.org/TR/2013/REC-sparql11-query-20130321/#rGraphGraphPattern.
	 * @param expression The expression to bind to the var.
	 * @param var The variable to bind to.
	 * @return This builder for chaining.
	 * @throws ParseException 
	 */
	public T addBind( String expression, Object var) throws ParseException;
	
	/**
	 * Get the Where handler for this clause.
	 * @return The WhereHandler used by this clause.
	 */
	public WhereHandler getWhereHandler();
	
	/**
	 * Create a list node from a list of objects as per RDF Collections.
	 * 
	 * http://www.w3.org/TR/2013/REC-sparql11-query-20130321/#collections 
	 * 
	 * See {@link AbstractQueryBuilder#makeNode} for conversion of the param values.
	 * <p>
	 * usage:
	 * <ul>
	 * <li>list( param1, param2, param3, ... )</li>
	 * <li>addWhere( list( param1, param2, param3, ... ), p, o )</li>
	 * <li>addOptional( list( param1, param2, param3, ... ), p, o )</li>
	 * </ul>
	 * </p>
	 * 
	 * @param objs the list of objects for the list.
	 * @return the first blank node in the list.
	 */
	public Node list( Object ... objs );

}