net.sf.sparql.benchmarking.loader.OperationMixLoader Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of core Show documentation

An API for benchmarking the performance of queries against arbitrary SPARQL endpoint

The newest version!

/*
Copyright 2011-2014 Cray Inc. All Rights Reserved

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are
met:

* Redistributions of source code must retain the above copyright
  notice, this list of conditions and the following disclaimer.

* Redistributions in binary form must reproduce the above copyright
  notice, this list of conditions and the following disclaimer in the
  documentation and/or other materials provided with the distribution.

* Neither the name Cray Inc. nor the names of its contributors may be
  used to endorse or promote products derived from this software
  without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
*/

package net.sf.sparql.benchmarking.loader;

import java.io.File;
import java.io.IOException;

import net.sf.sparql.benchmarking.operations.OperationMix;

/**
 * Interface for operation mix loaders
 * 
 * @author rvesse
 * 
 */
public interface OperationMixLoader {

    /**
     * Loads an operation mix from the given file
     * 
     * @param file
     *            File
     * @return Operation mix
     * @throws IOException
     */
    public abstract OperationMix load(File file) throws IOException;

    /**
     * Gets the file extension without the leading {@code .} that this loader
     * prefers to use for its mix files
     * 
     * This is the preferred extension used in certain circumstances such as
     * when registering using
     * {@link OperationMixLoaderRegistry#addLoader(OperationMixLoader)} but
     * users may register a mix loader with any extension they want.
     * 
     * 
     * @return Preferred extension
     */
    public abstract String getPreferredExtension();
}