org.apache.marmotta.kiwi.versioning.api.VersioningSail Maven / Gradle / Ivy

Go to download
/*
 * 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.marmotta.kiwi.versioning.api;

import org.apache.marmotta.commons.sesame.transactions.api.TransactionalSail;
import org.apache.marmotta.kiwi.versioning.model.Version;
import org.openrdf.model.Resource;
import org.openrdf.repository.RepositoryResult;
import org.openrdf.sail.SailConnection;
import org.openrdf.sail.SailException;

import java.util.Date;

/**
 * A Sesame SAIL with support for versioning of transaction data. Allows querying for the versions of a
 * repository (see {@link Version}).
 * 
 * Author: Sebastian Schaffert
 */
public interface VersioningSail extends TransactionalSail {


    /**
     * List all versions of this repository.
     *
     * @return
     */
    RepositoryResult listVersions() throws SailException;

    /**
     * List all versions of this repository between a start and end date.
     *
     * @return
     */
    RepositoryResult listVersions(Date from, Date to) throws SailException;


    /**
     * Get a read-only snapshot of the repository at the given date. Returns a sail connection that
     * can be used to access the triple data. Any attempts to modify the underlying data will throw
     * a SailReadOnlyException.
     *
     * @param snapshotDate the date of which to take the snapshot; the snapshot will consist of all
     *                     triples that have been created before or at the date and deleted after that date
     *                     (or not deleted at all).
     * @return  a read-only sail connection to access the data of the triple store at the given date
     */
    SailConnection getSnapshot(Date snapshotDate) throws SailException;

    /**
     * List all versions of this repository affecting the given resource as subject.
     *
     * @return
     */
    RepositoryResult listVersions(Resource r)  throws SailException;

    /**
     * List all versions of this repository affecting the given resource as subject between a start and end date.
     *
     * @return
     */
    RepositoryResult listVersions(Resource r, Date from, Date to) throws SailException;
}