spark.api.BooleanResult Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of spark-api Show documentation

Defines a Java client-side connection-oriented API for accessing sparql endpoints ala JDBC.

There is a newer version: 0.1.7

/*
 * Copyright 2011 Revelytix Inc.
 *
 * 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.
 */
package spark.api;

/**
 * {@link Result} interface to wrap the result of executing a SPARQL ASK query so that it can
 * be returned from a call to {@link Command#execute()}. An ASK query takes a query pattern and
 * tests whether a solution for the pattern exists in the dataset. It always returns a single
 * boolean result: true if a solution exists for the pattern, or false if no
 * solution is known to exist.
 * 
 * This interface is designed to be returned from the {@link Command#execute()} method for
 * executing general SPARQL commands. If you have prior knowledge that a command is an ASK query,
 * then you can access the boolean result directy by calling the {@link Command#executeAsk()}
 * method.
 * 
 * @author Alex Hall
 * @created Aug 9, 2011
 */
public interface BooleanResult extends Result {

  /**
   * Gets the boolean result value that was produced by executing the ASK query.
   * 
   * @return true if a solution exists for the query pattern, or false if no
   * solution is known to exist.
   */
  boolean getResult();
}