eu.optique.api.mapping.R2RMLView Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of r2rml-api Show documentation
There is a newer version: 0.4.0
/*******************************************************************************
 * Copyright 2013, the Optique Consortium
 * 
 * Licensed 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.
 * 
 * This first version of the R2RML API was developed jointly at the University of Oslo, 
 * the University of Bolzano, La Sapienza University of Rome, and fluid Operations AG, 
 * as part of the Optique project, www.optique-project.eu
 ******************************************************************************/
package eu.optique.api.mapping;

import java.util.List;

/**
 * A logical tables' R2RML View.
 * 
 * @author Marius Strandhaug
 */
public interface R2RMLView extends LogicalTable {

	/**
	 * Sets the SQL Query of this R2RMLView. A R2RMLView must have exactly one
	 * SQL query.
	 * 
	 * @param sqlQuery
	 *            The SQL query that will be set.
	 * @throws NullPointerException
	 *             If sqlQuery is null.
	 */
	public void setR2RMLView(String sqlQuery);

	/**
	 * Adds a SQL version identifier to this R2RMLView. The SQL version URI will
	 * be added to the end of the SQL version list. A R2RMLView can have any
	 * number of SQL version identifiers. The version parameter must be an
	 * instance of the library's resource class.
	 * 
	 * @param version
	 *            The SQL version that will be set.
	 */
	public void addSQLVersion(Object version);

	/**
	 * Get the SQL version URI located at the given index.
	 * 
	 * @param resourceClass
	 *            Must be equal to (or a superclass of) the library's resource
	 *            class.
	 * @param index
	 *            The index of the SQL version URI.
	 * @return The SQL version URI located at the given index.
	 * @throws IndexOutOfBoundsException
	 *             If the given index is out of range.
	 */
	public  R getSQLVersion(Class resourceClass, int index);

	/**
	 * Returns an unmodifiable view of the list of SQL versions that have been
	 * added to this R2RMLView.
	 * 
	 * @param resourceClass
	 *            Must be equal to (or a superclass of) the library's resource
	 *            class.
	 * @return An unmodifiable list of SQL versions.
	 */
	public  List getSQLVersions(Class resourceClass);

	/**
	 * Remove the SQL version identifier given by the parameter, from the
	 * R2RMLTable. The subsequent SQL version URIs in the list will be shifted
	 * left.
	 * 
	 * @param version
	 *            The SQL version identifier that will be removed.
	 */
	public void removeSQLVersion(Object version);
}