Franz Inc, AllegroGraph

com.franz.agraph.repository
Class AGRepository

java.lang.Object
  extended by org.openrdf.repository.base.RepositoryBase
      extended by com.franz.agraph.repository.AGRepository
All Implemented Interfaces:
AGAbstractRepository, Closeable, org.openrdf.repository.Repository

public class AGRepository
extends org.openrdf.repository.base.RepositoryBase
implements AGAbstractRepository

Implements the Sesame Repository interface for AllegroGraph, representing triple-stores on the server. In AllegroGraph, an AGCatalog contains multiple repositories. With the Sesame API, most data operations on a repository are done through the AGRepositoryConnection returned by getConnection().


Constructor Summary
AGRepository(AGCatalog catalog, String repositoryID)
          Creates an AGRepository instance for a repository having the given repository id in the given catalog.
 
Method Summary
 void close()
          Calls Sesame method RepositoryBase.shutDown().
 void ensureDBIdle()
          Waits until background db processes have gone idle.
 void forceCheckpoint()
          Forces a checkpoint for this repository.
 AGCatalog getCatalog()
          Gets the catalog to which this repository belongs.
 String getCatalogPrefixedRepositoryID()
           
 AGRepositoryConnection getConnection()
          Create a connection to the repository.
 File getDataDir()
          Deprecated. not applicable to AllegroGraph
 String getDuplicateSuppressionPolicy()
          Returns the repository's duplicate suppression policy.
 com.franz.agraph.http.AGHTTPClient getHTTPClient()
          The http connection to AllegroGraph server.
 String getRepositoryID()
          Gets the repository id for this repository.
 String getRepositoryURL()
          The AllegroGraph URL of this repository.
 String getSpec()
           
 AGValueFactory getValueFactory()
           
 boolean isBulkMode()
          Returns the repository's bulkMode setting.
 boolean isWritable()
          Returns true iff this repository is writable.
 void setBulkMode(boolean bulkMode)
          Sets the repository's bulkMode (defaults to false).
 void setConnPool(AGConnPool pool)
          Sets the connection pool to use with this repository.
 void setDataDir(File dataDir)
          Deprecated. not applicable to AllegroGraph
 void setDuplicateSuppressionPolicy(String policy)
          Sets the repository's duplicate suppression policy.
 
Methods inherited from class org.openrdf.repository.base.RepositoryBase
initialize, isInitialized, shutDown
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.openrdf.repository.Repository
initialize, isInitialized, shutDown
 

Constructor Detail

AGRepository

public AGRepository(AGCatalog catalog,
                    String repositoryID)
Creates an AGRepository instance for a repository having the given repository id in the given catalog.

Preferred access is from AGCatalog methods such as AGCatalog.createRepository(String, boolean) or AGCatalog.openRepository(String).

Method Detail

getCatalog

public AGCatalog getCatalog()
Gets the catalog to which this repository belongs.

Specified by:
getCatalog in interface AGAbstractRepository
Returns:
the catalog.

getRepositoryID

public String getRepositoryID()
Gets the repository id for this repository.

Returns:
the repository id.

getCatalogPrefixedRepositoryID

public String getCatalogPrefixedRepositoryID()

getRepositoryURL

public String getRepositoryURL()
The AllegroGraph URL of this repository.

Returns:
the URL of this repository.

getValueFactory

public AGValueFactory getValueFactory()
Specified by:
getValueFactory in interface AGAbstractRepository
Specified by:
getValueFactory in interface org.openrdf.repository.Repository

getHTTPClient

public com.franz.agraph.http.AGHTTPClient getHTTPClient()
The http connection to AllegroGraph server.


getConnection

public AGRepositoryConnection getConnection()
                                     throws org.openrdf.repository.RepositoryException
Create a connection to the repository.

Specified by:
getConnection in interface AGAbstractRepository
Specified by:
getConnection in interface org.openrdf.repository.Repository
Throws:
org.openrdf.repository.RepositoryException

isWritable

public boolean isWritable()
                   throws org.openrdf.repository.RepositoryException
Returns true iff this repository is writable.

Specified by:
isWritable in interface org.openrdf.repository.Repository
Throws:
org.openrdf.repository.RepositoryException

getSpec

public String getSpec()
Specified by:
getSpec in interface AGAbstractRepository

getDataDir

public File getDataDir()
Deprecated. not applicable to AllegroGraph

The dataDir is not currently applicable to AllegroGraph.

Specified by:
getDataDir in interface org.openrdf.repository.Repository

setDataDir

public void setDataDir(File dataDir)
Deprecated. not applicable to AllegroGraph

The dataDir is not currently applicable to AllegroGraph.

Specified by:
setDataDir in interface org.openrdf.repository.Repository

close

public void close()
           throws org.openrdf.repository.RepositoryException
Calls Sesame method RepositoryBase.shutDown().

Specified by:
close in interface Closeable
Throws:
org.openrdf.repository.RepositoryException
See Also:
Closeable.close()

setBulkMode

public void setBulkMode(boolean bulkMode)
                 throws org.openrdf.repository.RepositoryException
Sets the repository's bulkMode (defaults to false). When in bulkMode, data can be added/loaded more quickly, but there is no guarantee of durability in the event of a crash. The bulkMode setting persists when the repository is closed.

Throws:
org.openrdf.repository.RepositoryException
See Also:
isBulkMode()

isBulkMode

public boolean isBulkMode()
                   throws org.openrdf.repository.RepositoryException
Returns the repository's bulkMode setting.

Returns:
a boolean indicating the bulkMode setting.
Throws:
org.openrdf.repository.RepositoryException
See Also:
setBulkMode(boolean)

setDuplicateSuppressionPolicy

public void setDuplicateSuppressionPolicy(String policy)
                                   throws org.openrdf.repository.RepositoryException
Sets the repository's duplicate suppression policy. This determines how/whether duplicates will be automatically removed at commit time. Legal policy names are "false" (turns automatic suppression off), "spo" (removes statements with the same s, p, and o), and "spog" (compares s, p, o, and g). For on-demand duplicate deletion, see AGRepositoryConnection.deleteDuplicates(String). See also the protocol documentation for suppressing duplicates.

Parameters:
policy - name of the suppression policy to use
Throws:
org.openrdf.repository.RepositoryException
See Also:
getDuplicateSuppressionPolicy()

getDuplicateSuppressionPolicy

public String getDuplicateSuppressionPolicy()
                                     throws org.openrdf.repository.RepositoryException
Returns the repository's duplicate suppression policy.

Returns:
the policy name.
Throws:
org.openrdf.repository.RepositoryException
See Also:
setDuplicateSuppressionPolicy(String)

setConnPool

public void setConnPool(AGConnPool pool)
Sets the connection pool to use with this repository.

Enables the repository to use a connection pool so that Sesame apps can transparently benefit from connection pooling. If pool is not null, getConnection() borrows a connection from the pool, and closing the connection returns it to the pool. The pool is closed when the Repository is shutdown.

 Note that the AGConnPool parameters:
  
                AGConnProp.serverUrl, "http://localhost:10035",
                AGConnProp.username, "test",
                AGConnProp.password, "xyzzy",
                AGConnProp.catalog, "/",
                AGConnProp.repository, "my_repo",
 
 are currently assumed to match those of this repository.
 

See Also:
AGConnPool

forceCheckpoint

public void forceCheckpoint()
                     throws org.openrdf.repository.RepositoryException
Forces a checkpoint for this repository. This is an internal and undocumented function.

Throws:
org.openrdf.repository.RepositoryException

ensureDBIdle

public void ensureDBIdle()
                  throws org.openrdf.repository.RepositoryException
Waits until background db processes have gone idle. This is an internal and undocumented function.

Throws:
org.openrdf.repository.RepositoryException

Copyright © 2008-2012 Franz Inc.