IIndexStore (Blazegraph Database Platform 2.1.5 API)

All Known Subinterfaces:

IBigdataFederation<T>, IBTreeManager, IHAJournal, IIndexManager, IJournal

All Known Implementing Classes:

AbstractDistributedFederation, AbstractFederation, AbstractJournal, AbstractResourceManagerTestCase.MockFederation, AbstractScaleOutFederation, EmbeddedFederation, Journal, JournalDelegate, StoreManager.ManagedJournal, TemporaryStore
```
public interface IIndexStore
```
Collection of methods that are shared by both local and distributed stores.
Note: Historically, this was class was named for the ability to manage index objects in both local and distributed contexts. However, the introduction of GIST support has necessitated a refactoring of the interfaces and the name of this interface no longer reflects its function.

Author:

Bryan Thompson

Method Summary

Methods
Modifier and Type	Method and Description
`ScheduledFuture<?>`	`addScheduledTask(Runnable task, long initialDelay, long delay, TimeUnit unit)` Adds a task which will run until canceled, until it throws an exception, or until the service is shutdown.
`void`	`destroy()` Destroy the `IIndexStore`.
`boolean`	`getCollectPlatformStatistics()` `true` iff performance counters will be collected for the platform on which the client is running.
`boolean`	`getCollectQueueStatistics()` `true` iff statistics will be collected for work queues.
`ExecutorService`	`getExecutorService()` A `ExecutorService` that may be used to parallelize operations.
`BigdataFileSystem`	`getGlobalFileSystem()` Return the global file system used to store block-structured files and their metadata and as a source and sink for map/reduce processing.
`SparseRowStore`	`getGlobalRowStore()` Return an unisolated view of the global `SparseRowStore` used to store named property sets.
`SparseRowStore`	`getGlobalRowStore(long timestamp)` Return a view of the global `SparseRowStore` used to store named property sets as of the specified timestamp.
`int`	`getHttpdPort()` The port on which the optional httpd service will be run.
`long`	`getLastCommitTime()` The database wide timestamp of the most recent commit on the store or 0L iff there have been no commits.
`IResourceLocator`	`getResourceLocator()` Return the default locator for resources that are logical index containers (relations and relation containers).
`IResourceLockService`	`getResourceLockService()` The service that may be used to acquire synchronous distributed locks without deadlock detection.
`TemporaryStore`	`getTempStore()` A factory for `TemporaryStore`s.

- Method Detail
  - getGlobalRowStore
```
SparseRowStore getGlobalRowStore()
```
    Return an unisolated view of the global SparseRowStore used to store named property sets.
    
    See Also:
    GlobalRowStoreSchema
  - getGlobalRowStore
```
SparseRowStore getGlobalRowStore(long timestamp)
```
    Return a view of the global SparseRowStore used to store named property sets as of the specified timestamp.
    The SparseRowStore only permits ITx.UNISOLATED writes, so you MUST specify ITx.UNISOLATED as the timestamp if you intend to write on the global row store!
    You can request the most recent committed state of the global row store by specifying ITx.READ_COMMITTED.
    
    Parameters:
    timestamp - The timestamp of the view.
    
    Returns:
    The global row store view -or- null if no view exists as of that timestamp.
  - getGlobalFileSystem
```
BigdataFileSystem getGlobalFileSystem()
```
    Return the global file system used to store block-structured files and their metadata and as a source and sink for map/reduce processing.
    
    See Also:
    BigdataFileSystem
  - getTempStore
```
TemporaryStore getTempStore()
```
    A factory for TemporaryStores. TemporaryStores are thread-safe and may be used by multiple processes at once. Old TemporaryStores are eventually retired by the factory and their storage is reclaimed once they are finalized (after they are no longer in use by any process). The decision to retire a TemporaryStore is either made implicitly, when it is no longer weakly reachable, or explicitly, when it has grown large enough that no new processes should begin using that TemporaryStore. In the latter case, the TemporaryStore will remain available to the process(es) using it and a new TemporaryStore will be allocated and made available to the caller.
    It is important that processes do not hold a hard reference to a TemporaryStore beyond the end of the process as that will prevent the TemporaryStore from being finalized. Holding reference to an AbstractBTree created on a TemporaryStore is equivalent to holding a hard reference to the TemporaryStore itself since the AbstractBTree holds onto the backing IRawStore using a hard reference.
    
    Returns:
    A TemporaryStore.
  - getResourceLocator
```
IResourceLocator getResourceLocator()
```
    Return the default locator for resources that are logical index containers (relations and relation containers).
  - getExecutorService
```
ExecutorService getExecutorService()
```
    A ExecutorService that may be used to parallelize operations. This service is automatically used when materializing located resources. While the service does not impose concurrency controls, tasks run on this service may submit operations to a ConcurrencyManager.
  - addScheduledTask
```
ScheduledFuture<?> addScheduledTask(Runnable task,
                                  long initialDelay,
                                  long delay,
                                  TimeUnit unit)
```
    Adds a task which will run until canceled, until it throws an exception, or until the service is shutdown.
    
    Parameters:
    task - The task.
    initialDelay - The initial delay.
    delay - The delay between invocations.
    unit - The units for the delay parameters.
    
    Returns:
    The ScheduledFuture for that task.
  - getCollectPlatformStatistics
```
boolean getCollectPlatformStatistics()
```
    true iff performance counters will be collected for the platform on which the client is running.
  - getCollectQueueStatistics
```
boolean getCollectQueueStatistics()
```
    true iff statistics will be collected for work queues.
  - getHttpdPort
```
int getHttpdPort()
```
    The port on which the optional httpd service will be run. The httpd service exposes statistics about the client, its work queues, the platform on which it is running, etc. If this is ZERO (0), then the port will be chosen randomly.
  - getResourceLockService
```
IResourceLockService getResourceLockService()
```
    The service that may be used to acquire synchronous distributed locks without deadlock detection.
  - getLastCommitTime
```
long getLastCommitTime()
```
    The database wide timestamp of the most recent commit on the store or 0L iff there have been no commits. In a local database, this timestamp is generated by a local timestamp service. In a distributed database, this timestamp is generated by a shared timestamp service. The timestamps returned by this method are strictly increasing for a given store and for a given database.
    This method is useful if you plan to issue a series of read-consistent requests against the most current commit point of the database.
    
    Returns:
    The timestamp of the most recent commit on the store or 0L iff there have been no commits.
    See Also:
    IRootBlockView.getLastCommitTime()
  - destroy
```
void destroy()
```
    Destroy the IIndexStore.

Interface IIndexStore

Method Summary

Method Detail

getGlobalRowStore

getGlobalRowStore

getGlobalFileSystem

getTempStore

getResourceLocator

getExecutorService

addScheduledTask

getCollectPlatformStatistics

getCollectQueueStatistics

getHttpdPort

getResourceLockService

getLastCommitTime

destroy