Class AbstractNotifyingSail

java.lang.Object

org.eclipse.rdf4j.sail.helpers.AbstractSail

org.eclipse.rdf4j.sail.helpers.AbstractNotifyingSail

All Implemented Interfaces:

NotifyingSail, Sail

Direct Known Subclasses:

ExtensibleStore, LmdbStore, MemoryStore, NativeStore

public abstract class AbstractNotifyingSail
extends AbstractSail
implements NotifyingSail

A base NotifyingSail implementation that takes care of common sail tasks, including proper closing of active connections and a grace period for active connections during shutdown of the store.

Author:

Herko ter Horst, jeen, Arjohn Kampman

Field Summary

Fields inherited from class AbstractSail

connectionTimeOut, DEFAULT_CONNECTION_TIMEOUT, DEFAULT_ITERATION_SYNC_THRESHOLD, initializationLock

Modifier and Type	Field	Description
protected long	connectionTimeOut	Connection timeout on shutdown (in ms).
protected static final long	DEFAULT_CONNECTION_TIMEOUT	Default connection timeout on shutdown: 20,000 milliseconds (20 seconds).
protected static final long	DEFAULT_ITERATION_SYNC_THRESHOLD	default value for the Iteration item sync threshold
protected final ReentrantReadWriteLock	initializationLock	Lock used to synchronize the initialization state of a sail.

Constructor Summary

Constructors

Constructor	Description
AbstractNotifyingSail()

Method Summary

Modifier and Type	Method	Description
void	addSailChangedListener(SailChangedListener listener)	Adds the specified SailChangedListener to receive events when the data in this Sail object changes.
NotifyingSailConnection	getConnection()	Opens a connection on the Sail which can be used to query and update data.
protected abstract NotifyingSailConnection	getConnectionInternal()	Returns a store-specific SailConnection object.
void	notifySailChanged(SailChangedEvent event)	Notifies all registered SailChangedListener's of changes to the contents of this Sail.
void	removeSailChangedListener(SailChangedListener listener)	Removes the specified SailChangedListener so that it no longer receives events from this Sail object.

Methods inherited from class AbstractSail

addSupportedIsolationLevel, connectionClosed, debugEnabled, getDataDir, getDefaultIsolationLevel, getDefaultQueryEvaluationMode, getIterationCacheSyncThreshold, getSupportedIsolationLevels, init, initializeInternal, isInitialized, isTrackResultSize, removeSupportedIsolationLevel, setConnectionTimeOut, setDataDir, setDefaultIsolationLevel, setDefaultQueryEvaluationMode, setIterationCacheSyncThreshold, setSupportedIsolationLevels, setSupportedIsolationLevels, setTrackResultSize, shutDown, shutDownInternal, toString

Modifier and Type	Method	Description
protected void	addSupportedIsolationLevel(IsolationLevels level)	Appends the provided IsolationLevels to the SAIL's list of supported isolation levels.
protected void	connectionClosed(SailConnection connection)	Signals to the store that the supplied connection has been closed; called by AbstractSailConnection.close().
protected static boolean	debugEnabled()
File	getDataDir()	Gets the Sail's data directory.
IsolationLevel	getDefaultIsolationLevel()	Retrieves the default IsolationLevel level on which transactions in this Sail operate.
QueryEvaluationMode	getDefaultQueryEvaluationMode()
long	getIterationCacheSyncThreshold()	Retrieves the currently configured threshold for syncing query evaluation iteration caches to disk.
List<IsolationLevel>	getSupportedIsolationLevels()	Retrieve the IsolationLevels supported by this SAIL, ordered by increasing complexity.
void	init()	Initializes the Sail.
protected void	initializeInternal()	Do store-specific operations to initialize the store.
protected boolean	isInitialized()	Checks whether the Sail has been initialized.
boolean	isTrackResultSize()	Returns the status of the result size tracking for the query plan.
protected void	removeSupportedIsolationLevel(IsolationLevel level)	Removes all occurrences of the provided IsolationLevels in the list of supported Isolation levels.
void	setConnectionTimeOut(long connectionTimeOut)	Set connection timeout on shutdown (in ms).
void	setDataDir(File dataDir)	Sets the data directory for the Sail.
void	setDefaultIsolationLevel(IsolationLevel defaultIsolationLevel)	Sets the default IsolationLevel on which transactions in this Sail operate.
void	setDefaultQueryEvaluationMode(QueryEvaluationMode defaultQueryEvaluationMode)
void	setIterationCacheSyncThreshold(long iterationCacheSyncThreshold)	Set the threshold for syncing query evaluation iteration caches to disk.
protected void	setSupportedIsolationLevels(List<IsolationLevel> supportedIsolationLevels)	Sets the list of supported IsolationLevelss for this SAIL.
protected void	setSupportedIsolationLevels(IsolationLevel... supportedIsolationLevels)	Sets the list of supported IsolationLevelss for this SAIL.
void	setTrackResultSize(boolean trackResultSize)	Enable or disable results size tracking for the query plan.
void	shutDown()	Shuts down the Sail, giving it the opportunity to synchronize any stale data.
protected abstract void	shutDownInternal()	Do store-specific operations to ensure proper shutdown of the store.
String	toString()

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface Sail

getCollectionFactory, getValueFactory, isWritable

Modifier and Type	Method	Description
default Supplier<CollectionFactory>	getCollectionFactory()	Gets a CollectionFactory that may be optimized for this store and may or may not use disk or other resources.
ValueFactory	getValueFactory()	Gets a ValueFactory object that can be used to create IRI-, blank node-, literal- and statement objects.
boolean	isWritable()	Checks whether this Sail object is writable, i.e. if the data contained in this Sail object can be changed.

Constructor Details

AbstractNotifyingSail

public AbstractNotifyingSail()

Method Details

getConnection

public NotifyingSailConnection getConnection()
                                      throws SailException

Description copied from interface: Sail

Opens a connection on the Sail which can be used to query and update data. Depending on how the implementation handles concurrent access, a call to this method might block when there is another open connection on this Sail.

Specified by:

getConnection in interface NotifyingSail

Specified by:

getConnection in interface Sail

Overrides:

getConnection in class AbstractSail

Throws:

SailException - If no transaction could be started, for example because the Sail is not writable.

getConnectionInternal

protected abstract NotifyingSailConnection getConnectionInternal()
                                                          throws SailException

Description copied from class: AbstractSail

Returns a store-specific SailConnection object.

Specified by:

getConnectionInternal in class AbstractSail

Returns:

A connection to the store.

Throws:

SailException

addSailChangedListener

public void addSailChangedListener(SailChangedListener listener)

Description copied from interface: NotifyingSail

Adds the specified SailChangedListener to receive events when the data in this Sail object changes.

Specified by:

addSailChangedListener in interface NotifyingSail

removeSailChangedListener

public void removeSailChangedListener(SailChangedListener listener)

Description copied from interface: NotifyingSail

Removes the specified SailChangedListener so that it no longer receives events from this Sail object.

Specified by:

removeSailChangedListener in interface NotifyingSail

notifySailChanged

public void notifySailChanged(SailChangedEvent event)

Notifies all registered SailChangedListener's of changes to the contents of this Sail.