org.openrdf.sesame.sail
Interface Sail

All Known Subinterfaces:

RdfRepository, RdfSchemaRepository, RdfSchemaSource, RdfSource, Reasoner, StackedSail, TrackingChanges, VersionManagement

All Known Implementing Classes:

NativeRdfRepository, RdfRepository, RdfRepository, RdfSchemaRepository, RdfSchemaRepository, RdfSource, RdfSource, SecuritySail, SyncRdfRepository, SyncRdfSchemaRepository, VersioningRdbmsSail

public interface Sail

An interface for an RDF-based Storage And Inference Layer. This interface only defines methods for initializing and shutting down a repository. The extensions of this interface (RdfSource, RdfRepository, RdfSchemaSource and RdfSchemaRepository) define methods for querying and manipulating the contents of the repository. These interfaces are organized in a hierarachy like this:

              Sail
                ^
                |
            RdfSource
              ^  ^
             /    \
 RdfRepository   RdfSchemaSource
            ^     ^
             \   /
      RdfSchemaRepository
 

All methods in this interface, or in any extension of this interface, can throw SailInternalException's (a RuntimeException) to indicate an error or an unexpected situation in the RDF Sail internally (e.g. the database to connect to does not exist).

Version:

$Revision: 1.3.4.2 $

Author:

Arjohn Kampman

Method Summary

void	initialize(Map configParams) Initializes the Sail using a set of configuration parameters.
void	shutDown() Allow the SAIL to synchronize any stale data.

Method Detail

initialize

public void initialize(Map configParams)
                throws SailInitializationException

Initializes the Sail using a set of configuration parameters. The relevant names and values of the parameters are determined by the implementation of the interface.

Parameters:

configParams - A set a configuration parameters.

Throws:

SailInitializationException - If the Sail could not be initialized.

SailInternalException - To indicate an internal error.

shutDown

public void shutDown()

Allow the SAIL to synchronize any stale data. The SAIL can assume that shutDown() is called before an application is stopped.

Throws:

SailInternalException - To indicate an internal error.