Package tech.oxfordsemantic.jrdfox.client

Interface DataStoreConnection

All Superinterfaces:
java.lang.AutoCloseable
public interface DataStoreConnection
extends java.lang.AutoCloseable
Encapsulates a connection to an RDFox data store. All instances of this class are single-threaded — that is, methods should not be called simultaneously on distinct threads, and an JRDFoxException will be thrown if this requirement is violated. However, there is no thread affinity — that is, methods on one connection can be called from different threads as long as the calls are serialized externally. The interrupt() and duplicate() methods are exceptions: they can be invoked in parallel with any other method apart from close(). Calling close() in parallel with any other method is considered a serious bug in the client code; however, to safeguard against JVM crashes and aid debugging, RDFox will throw an IllegalStateException. A data store connection uses transactions to coordinate concurrent access. A connection must be closed after use to release the resources associated with it.

  • Field Summary

    Fields 
    Modifier and Type Field Description
    static long WAIT_FOREVER
    Specifies that the system should wait forever when it needs to acquire a lock on a data store (see setLockTimeout(long)).

  • Method Summary

    Modifier and Type Method Description
    long addRule​(Rule rule)
    Adds a rule to the data store.
    long addRules​(java.util.Collection<Rule> datalogProgram)
    Adds a collection of rules to the data store.
    void beginTransaction​(TransactionType transactionType)
    Starts a new transaction on this connection.
    void clear​(int dataStoreParts)
    Clears the specified parts of the data store.
    void clearRulesAxiomsExplicateFacts()
    Clears all rules and turns all facts in the data store into EDB facts.
    void close()
    Closes the data store connection by freeing all resources associated with it.
    void commitTransaction()
    Commits the transaction associated with this connection.
    void compact()
    Compact the data in the data store.
    boolean containsDataSource​(java.lang.String dataSourceName)
    Checks whether the data store contains a data source with the specified name.
    boolean containsDataSourceTable​(java.lang.String dataSourceName, java.lang.String dataSourceTableName)
    Checks whether the specified data source in the data store contains a data source table with the specified name.
    boolean containsDeltaQuery​(java.lang.String deltaQueryName)
    Checks whether the data store contains a delta query with the specified name.
    boolean containsStatistics​(java.lang.String statisticsName)
    Checks whether the data store contains the statistics with the specified name.
    boolean containsTupleTable​(java.lang.String tupleTableName)
    Checks whether the data store contains a tuple table with the specified name.
    Cursor createCursor​(java.lang.String queryText, java.util.Map<java.lang.String,​java.lang.String> compilationParameters)
    Creates a cursor over the results of the given query with the default fetch window size of 100.
    Cursor createCursor​(java.lang.String queryText, java.util.Map<java.lang.String,​java.lang.String> compilationParameters, int fetchWindowSize)
    Creates a cursor over the results of the given query.
    Cursor createCursor​(Query query, java.util.Map<java.lang.String,​java.lang.String> compilationParameters)
    Creates a cursor over the results of the given query with the default fetch window size of 100.
    Cursor createCursor​(Query query, java.util.Map<java.lang.String,​java.lang.String> compilationParameters, int fetchWindowSize)
    Creates a cursor over the results of the given query.
    void createExplanation​(java.lang.String factText, int maxDistanceFromRoot, int maxRuleInstancesPerFact, ExplanationType explanationType, java.io.OutputStream outputStream)
    Computes an explanation for a given fact and saves it in JSON format to the given output stream.
    void createExplanation​(TupleTableAtom fact, int maxDistanceFromRoot, int maxRuleInstancesPerFact, ExplanationType explanationType, java.io.OutputStream outputStream)
    Computes an explanation for a given fact and saves it in JSON format to the given output stream.
    void createStatistics​(java.lang.String statisticsName, java.util.Map<java.lang.String,​java.lang.String> statisticsParameters)
    Creates the statistics in a data store.
    void createTupleTable​(java.lang.String tupleTableName, java.util.Map<java.lang.String,​java.lang.String> tupleTableParameters)
    Creates a tuple table in a data store.
    long deleteDeltaQueryAnswers​(java.util.Optional<java.lang.String> deltaQueryName, java.util.Optional<java.lang.Long> fromDataStoreVersion, java.util.Optional<java.lang.Long> toDataStoreVersion, java.util.Optional<DeltaQueryAnswerType> deltaQueryAnswerType)
    Deletes the delta query answers that match the specified delta query name, the data store version range, and delta query answer type.
    long deleteRule​(Rule rule)
    Deletes a rule to the data store.
    long deleteRules​(java.util.Collection<Rule> datalogProgram)
    Deletes a collection of rules to the data store.
    void deleteStatistics​(java.lang.String statisticsName)
    Deletes the data store statistics with the specified name from the data store.
    void deleteTupleTable​(java.lang.String tupleTableName)
    Deletes the tuple table with the specified name from the data store.
    void deregisterDataSource​(java.lang.String dataSourceName)
    Deregisters the data source table with the specified name from the data store.
    void deregisterDeltaQuery​(java.lang.String deltaQueryName)
    Deregisters the delta query with the specified name from the data store.
    DataSourceInfo describeDataSource​(java.lang.String dataSourceName)
    Returns information about the data source with the given name.
    DataSourceTableInfo describeDataSourceTable​(java.lang.String dataSourceName, java.lang.String dataSourceTableName)
    Returns information about the data source table of the specified data source in the data store.
    DeltaQueryInfo describeDeltaQuery​(java.lang.String deltaQueryName)
    Returns information about the delta query with the given name.
    StatisticsInfo describeStatistics​(java.lang.String statisticsName)
    Returns information about the specific statistics of the data store.
    TupleTableInfo describeTupleTable​(java.lang.String tupleTableName)
    Returns information about the tuple table with the given name.
    DataStoreConnection duplicate()
    Creates a new connection to the same data store.
    StatementResult evaluateQuery​(java.lang.String queryText, java.util.Map<java.lang.String,​java.lang.String> compilationParameters, QueryAnswerMonitor queryAnswerMonitor)
    Evaluates a query and calls the supplied QueryAnswerMonitor instance for each tuple in the result.
    StatementResult evaluateQuery​(Query query, java.util.Map<java.lang.String,​java.lang.String> compilationParameters, QueryAnswerMonitor queryAnswerMonitor)
    Evaluates a query and calls the supplied QueryAnswerMonitor instance for each tuple in the result.
    StatementResult evaluateStatement​(java.lang.String statementText, java.util.Map<java.lang.String,​java.lang.String> compilationParameters, java.io.File file, java.lang.String queryAnswerFormatName)
    Evaluates a statement and serializes the result to the supplied file using the specified format.
    StatementResult evaluateStatement​(java.lang.String statementText, java.util.Map<java.lang.String,​java.lang.String> compilationParameters, java.io.OutputStream outputStream, java.lang.String queryAnswerFormatName)
    Evaluates a statement and serializes the result to the supplied output stream using the specified format.
    StatementResult evaluateStatement​(Statement statement, java.util.Map<java.lang.String,​java.lang.String> compilationParameters, java.io.File file, java.lang.String queryAnswerFormatName)
    Evaluates a statement and serializes the result to the supplied file using the specified format.
    StatementResult evaluateStatement​(Statement statement, java.util.Map<java.lang.String,​java.lang.String> compilationParameters, java.io.OutputStream outputStream, java.lang.String queryAnswerFormatName)
    Evaluates a statement and serializes the result to the supplied output stream using the specified format.
    StatementResult evaluateUpdate​(java.lang.String updateText, java.util.Map<java.lang.String,​java.lang.String> compilationParameters)
    Evaluates an update.
    StatementResult evaluateUpdate​(Update update, java.util.Map<java.lang.String,​java.lang.String> compilationParameters)
    Evaluates an update.
    StatementResult evaluateUpdates​(java.util.List<Update> updates, java.util.Map<java.lang.String,​java.lang.String> compilationParameters)
    Evaluates a list of updates.
    void exportData​(java.io.File file, java.lang.String encryptionAlgorithm, java.lang.String encryptionKey, java.lang.String formatName, java.util.Map<java.lang.String,​java.lang.String> parameters)
    Exports the data in the data store using the given format.
    void exportData​(java.io.File file, java.lang.String formatName, java.util.Map<java.lang.String,​java.lang.String> parameters)
    Exports the data in the data store using the given format.
    void exportData​(java.io.OutputStream outputStream, java.lang.String formatName, java.util.Map<java.lang.String,​java.lang.String> parameters)
    Exports the data in the data store using the given format.
    void exportDeltaQueryAnswer​(java.io.OutputStream outputStream, java.lang.String deltaQueryName, long dataStoreVersion, DeltaQueryAnswerType deltaQueryAnswerType)
    Exports the delta query answer with the specified name, data store version, and delta query answer type.
    java.lang.String getAgentName()
    Returns the name of the agent currently associated with this connection.
    CommitProcedureInfo getCommitProcedure()
    Returns the data store's commit procedure.
    ComponentInfo getComponentInfo​(boolean extended)
    Returns diagnostic information about the data store as a tree of objects each providing detailed information about the data store.
    ResourceValue[][] getDataSourceTableData​(java.lang.String dataSourceName, java.lang.String dataSourceTableName, int numberOfRows)
    Returns a sample of the data from the specified data source table.
    DataStoreOperationStartMonitor getDataStoreOperationStartMonitor()
    Returns the current callback interface that will be called whenever an operation starts on this data store connection.
    java.util.Map<java.lang.String,​java.lang.String> getDataStoreProperties()
    Returns all data store properties as key-value pairs.
    java.lang.String getDataStoreProperty​(java.lang.String propertyName)
    Returns the specified property of the data store.
    long getDataStoreVersion()
    If a transaction is active, the data store version associated with the transaction is returned; otherwise, the last committed data store version is returned.
    long getDataStoreVersionAfterLastOperation()
    Returns the version that the data store had after the last operation on this connection.
    long getLastSnapshotDataStoreVersion()
    Returns the data store version of the most recent snapshot.
    long getLockTimeout()
    Returns the time in milliseconds that the system will wait for when it needs to acquire a lock on a data store.
    java.lang.String getName()
    Returns the name of the data store inside the server.
    java.util.Map<java.lang.String,​java.lang.String> getParameters()
    Returns the parameters that the data store was created with.
    Prefixes getPrefixes()
    Returns the prefixes of the data store.
    TransactionState getTransactionState()
    Returns the state of the transaction associated with this connection.
    java.lang.String getUniqueID()
    Returns a string that uniquely identifies the data store.
    ImportResult importAxiomsFromTriples​(ResourceValue sourceGraph, boolean translateAssertions, ResourceValue destinationGraph, UpdateType updateType)
    Parses the given source graph into OWL axioms, and imports the axioms into the destination graph.
    ImportResult importAxiomsFromTriples​(ResourceValue sourceGraph, boolean translateAssertions, ResourceValue destinationGraph, UpdateType updateType, ImportNotificationMonitor importNotificationMonitor)
    Parses the given source graph into OWL axioms, and imports the axioms into the destination graph.
    ImportResult importData​(ResourceValue defaultGraph, UpdateType updateType, java.io.File file)
    Imports the data from the given file into the current data store.
    ImportResult importData​(ResourceValue defaultGraph, UpdateType updateType, java.io.InputStream inputStream)
    Imports the data from the given input stream into the current data store.
    ImportResult importData​(ResourceValue defaultGraph, UpdateType updateType, java.lang.String content)
    Imports the data from the given string into the current data store.
    ImportResult importData​(ResourceValue defaultGraph, UpdateType updateType, java.util.Collection<InputSourceFactory> inputSourceFactories, java.lang.String formatName, ImportNotificationMonitor importNotificationMonitor)
    Imports the data described by the given input source factories into the current data store.
    ImportResult importData​(ResourceValue defaultGraph, UpdateType updateType, InputSourceFactory inputSourceFactory, java.lang.String formatName, ImportNotificationMonitor importNotificationMonitor)
    Imports the data described by the given input source factory into the current data store Triples in the default graph will be put into the named graph specified using the defaultGraph parameter.
    ImportResult importData​(UpdateType updateType, java.io.File file)
    Imports the data from the given file into the current data store.
    ImportResult importData​(UpdateType updateType, java.io.InputStream inputStream)
    Imports the data from the given input stream into the current data store.
    ImportResult importData​(UpdateType updateType, java.lang.String content)
    Imports the data from the given string into the current data store.
    ImportResult importData​(UpdateType updateType, java.util.Collection<InputSourceFactory> inputSourceFactories, java.lang.String formatName, ImportNotificationMonitor importNotificationMonitor)
    Imports the data described by the given input source factories into the current data store.
    ImportResult importData​(UpdateType updateType, InputSourceFactory inputSourceFactory, java.lang.String formatName, ImportNotificationMonitor importNotificationMonitor)
    Imports the data described by the given input source factory into the current data store.
    void interrupt()
    Tries to interrupt an operation that is running in parallel on this connection.
    boolean isPersistent()
    Returns true if the data store is persistent.
    java.util.Map<java.lang.String,​java.util.Optional<DataSourceInfo>> listDataSources()
    Returns the list of data sources currently present in the data store.
    java.util.List<DataSourceTableInfo> listDataSourceTables​(java.lang.String dataSourceName)
    Returns information about the data source tables of the specified data source in the data store.
    java.util.Map<java.lang.String,​java.util.Optional<DeltaQueryInfo>> listDeltaQueries()
    Returns information about the delta queries currently registered with the data store.
    java.util.List<DeltaQueryAnswerInfo> listDeltaQueryAnswers​(java.util.Optional<java.lang.String> deltaQueryName, java.util.Optional<java.lang.Long> fromDataStoreVersion, java.util.Optional<java.lang.Long> toDataStoreVersion, java.util.Optional<DeltaQueryAnswerType> deltaQueryAnswerType)
    Lists the delta query answers that match the specified delta query name, the data store version range, and delta query answer type.
    java.util.List<RuleInfo> listRules()
    Returns the information about the rules currently loaded into the data store.
    java.util.List<StatisticsInfo> listStatistics()
    Returns information about all statistics currently managed by the data store.
    java.util.Map<java.lang.String,​java.util.Optional<TupleTableInfo>> listTupleTables()
    Returns the list of tuple tables currently present in the data store.
    void recompile()
    Recompiles the rules and commit procedure using the currently available statistics.
    void recomputeMaterialization()
    Recomputes the materialization from scratch — that is, deletes all derived facts and applies all rules as if the data had just been freshly imported.
    void registerDataSource​(java.lang.String dataSourceName, java.util.Map<java.lang.String,​java.lang.String> dataSourceParameters)
    Registers a data source with a data store.
    void registerDeltaQuery​(java.lang.String deltaQueryName, java.lang.String queryText, java.lang.String formatName, long snapshotsMaxSize, long deletionsMaxSize, long additionsMaxSize)
    Registers a delta query with a data store.
    void registerDeltaQuery​(java.lang.String deltaQueryName, Query query, java.lang.String formatName, long snapshotsMaxSize, long deletionsMaxSize, long additionsMaxSize)
    Registers a delta query with a data store.
    boolean requiresIncrementalReasoning()
    Returns true if the next data store update must be performed using incremental reasoning (rather than standard using the standard datalog materialization "from scratch" algorithm).
    void rollbackTransaction()
    Rolls back the transaction associated with this connection.
    boolean setCommitProcedure​(java.lang.String commitProcedure)
    Sets the data store's commit procedure.
    boolean setCommitProcedure​(java.util.List<Update> steps)
    Sets the data store's commit procedure.
    void setDataStoreOperationStartMonitor​(DataStoreOperationStartMonitor dataStoreOperationStartMonitor)
    Sets a callback interface that will be called whenever an operation starts on this data store connection.
    boolean setDataStoreProperty​(java.lang.String propertyName, java.lang.String propertyValue)
    Sets the specified property of the data store to the given value.
    void setDeltaQueryEvaluationMode​(java.lang.String deltaQueryName, DeltaQueryEvaluationMode deltaQueryEvaluationMode)
    Deregisters the delta query with the specified name from the data store.
    void setLockTimeout​(long timeout)
    Sets the time in milliseconds that the system will wait for when it needs to acquire a lock on a data store.
    boolean setPrefix​(java.lang.String prefixName, java.lang.String prefixIRI)
    Sets the given prefix name to the given prefix IRI in the collection of the data store prefixes.
    boolean setPrefixes​(Prefixes prefixes)
    Replaces all mappings of the prefix names to IRIs maintained by the data store to the collection given in the argument.
    boolean transactionRequiresRollback()
    Returns true if a transaction is active on this connection and this transaction must be rolled back (i.e., it cannot be committed).
    boolean unsetPrefix​(java.lang.String prefixName)
    Removes the mapping of the given prefix name in the collection of the data store prefixes.
    void updateMaterialization()
    Updates the materialization so that all and only the consequences of the explicitly stated facts and the rules are derived.
    void updateStatistics()
    Updates all statistics that the data store uses to plan queries and rules.
    void updateStatistics​(java.lang.String statisticsName)
    Updates the statistics with the given name that the data store uses to plan queries and rules.

  • Field Details

  • Method Details

    • close

      void close()
      Closes the data store connection by freeing all resources associated with it. Once a connection is closed, it cannot be used any further. Calling this method in parallel with any other method runs a very high risk of crashing the JVM.
      Specified by:
      close in interface java.lang.AutoCloseable

    • interrupt

      void interrupt() throws JRDFoxException
      Tries to interrupt an operation that is running in parallel on this connection. RDFox will make a best effort to interrupt an operation, but there are no guarantees that the operation will indeed be interrupted. An operation will throw an OperationInterruptedException exception. This method can be called concurrently with any other method apart from close().
      Throws:
      JRDFoxException - thrown if an error is encountered

    • getAgentName

      java.lang.String getAgentName() throws JRDFoxException
      Returns the name of the agent currently associated with this connection.
      Returns:
      the name of the agent currently associated with this connection
      Throws:
      JRDFoxException - thrown if there is an error

    • getLockTimeout

      long getLockTimeout() throws JRDFoxException
      Returns the time in milliseconds that the system will wait for when it needs to acquire a lock on a data store. See setLockTimeout(long) for more detail.
      Returns:
      the current timeout value
      Throws:
      JRDFoxException - thrown if an error is encountered

    • setLockTimeout

      void setLockTimeout​(long timeout) throws JRDFoxException
      Sets the time in milliseconds that the system will wait for when it needs to acquire a lock on a data store. The value of WAIT_FOREVER specifies that the system should wait indefinitely. When successful completion of an operation (e.g., adding data to a data store) requires locking a store and the lock cannot be acquired within the timeout period, a LockTimeoutException is thrown.
      Parameters:
      timeout - the new timeout value
      Throws:
      JRDFoxException - thrown if an error is encountered

    • getDataStoreOperationStartMonitor

      DataStoreOperationStartMonitor getDataStoreOperationStartMonitor() throws JRDFoxException
      Returns the current callback interface that will be called whenever an operation starts on this data store connection.
      Returns:
      the current callback interface that will intercept operations, or null if no callback interface is set
      Throws:
      JRDFoxException - thrown if an error is encountered

    • setDataStoreOperationStartMonitor

      void setDataStoreOperationStartMonitor​(DataStoreOperationStartMonitor dataStoreOperationStartMonitor) throws JRDFoxException
      Sets a callback interface that will be called whenever an operation starts on this data store connection. This allows one to intercept and potentially block operations (e.g., depending on the data store version).
      Parameters:
      dataStoreOperationStartMonitor - the callback interface that will intercept operations, or null if callbacks are not required
      Throws:
      JRDFoxException - thrown if an error is encountered

    • duplicate

      DataStoreConnection duplicate() throws JRDFoxException
      Creates a new connection to the same data store. The new connection inherits the role name and the lock timeout from this one. Regardless of whether a transaction is active on this connection, the new connection will not have an active transaction. The main use of this method is to avoid having to specify the user credentials again.
      Returns:
      a new connection to the same data store
      Throws:
      JRDFoxException - thrown if an error is encountered

    • getName

      java.lang.String getName() throws JRDFoxException
      Returns the name of the data store inside the server.
      Returns:
      the name of the data store
      Throws:
      JRDFoxException - thrown if an error is encountered

    • getUniqueID

      java.lang.String getUniqueID() throws JRDFoxException
      Returns a string that uniquely identifies the data store. Each time a data store is created, a fresh random string is associated to the data store. This string aims to be unique across servers and data stores.
      Returns:
      a string that uniquely identifies this data store
      Throws:
      JRDFoxException - thrown if an error is encountered

    • isPersistent

      boolean isPersistent() throws JRDFoxException
      Returns true if the data store is persistent.
      Returns:
      true if the data store is persistent
      Throws:
      JRDFoxException - thrown if an error is encountered

    • getParameters

      java.util.Map<java.lang.String,​java.lang.String> getParameters() throws JRDFoxException
      Returns the parameters that the data store was created with.
      Returns:
      the parameters of the data store
      Throws:
      JRDFoxException - thrown if an error is encountered

    • getComponentInfo

      ComponentInfo getComponentInfo​(boolean extended) throws JRDFoxException
      Returns diagnostic information about the data store as a tree of objects each providing detailed information about the data store. Note: This information should be used for diagnostics purposes only. The content of ComponentInfo is subject to change in future version. Callers should not rely on named property or a specific subcomponent being present. This operation can be invoked only if no transaction is active on the connection.
      Parameters:
      extended - if true, returns extensive information about various subcomponents about the data store (mainly used for troubleshooting)
      Returns:
      information about the data store
      Throws:
      JRDFoxException - thrown if an error is encountered

    • getDataStoreProperties

      java.util.Map<java.lang.String,​java.lang.String> getDataStoreProperties() throws JRDFoxException
      Returns all data store properties as key-value pairs.
      Returns:
      all data store properties as key-value pairs
      Throws:
      JRDFoxException - thrown if an error is encountered

    • getDataStoreProperty

      java.lang.String getDataStoreProperty​(java.lang.String propertyName) throws JRDFoxException
      Returns the specified property of the data store.
      Parameters:
      propertyName - the name of the property
      Returns:
      the value of the property with the given name
      Throws:
      JRDFoxException - thrown if an error is encountered

    • setDataStoreProperty

      boolean setDataStoreProperty​(java.lang.String propertyName, java.lang.String propertyValue) throws JRDFoxException
      Sets the specified property of the data store to the given value.
      Parameters:
      propertyName - the name of the property
      propertyValue - the value of the property
      Returns:
      true if the data store property value changed
      Throws:
      JRDFoxException - thrown if an error is encountered

    • getPrefixes

      Prefixes getPrefixes() throws JRDFoxException
      Returns the prefixes of the data store.
      Returns:
      the prefixes of the data store
      Throws:
      JRDFoxException - thrown if an error is encountered

    • setPrefixes

      boolean setPrefixes​(Prefixes prefixes) throws JRDFoxException
      Replaces all mappings of the prefix names to IRIs maintained by the data store to the collection given in the argument.
      Parameters:
      prefixes - the new prefixes
      Returns:
      true if the collection of prefixes changed
      Throws:
      JRDFoxException - thrown if an error is encountered

    • setPrefix

      boolean setPrefix​(java.lang.String prefixName, java.lang.String prefixIRI) throws JRDFoxException
      Sets the given prefix name to the given prefix IRI in the collection of the data store prefixes.
      Parameters:
      prefixName - the prefix name to set
      prefixIRI - the IRI to which the prefix name is set
      Returns:
      true if the collection of prefixes changed
      Throws:
      JRDFoxException - thrown if an error is encountered

    • unsetPrefix

      boolean unsetPrefix​(java.lang.String prefixName) throws JRDFoxException
      Removes the mapping of the given prefix name in the collection of the data store prefixes.
      Parameters:
      prefixName - the prefix name whose mapping is to be removed
      Returns:
      true if the collection of prefixes changed
      Throws:
      JRDFoxException - thrown if an error is encountered

    • listDataSources

      java.util.Map<java.lang.String,​java.util.Optional<DataSourceInfo>> listDataSources() throws JRDFoxException
      Returns the list of data sources currently present in the data store. The result is a map from data source names to optional objects containing data source information. If the user has sufficient privileges to access a particular data sources, the optional will contain the information about the data source; otherwise, the optional will be empty.
      Returns:
      information about the tuple tables currently present in the data store
      Throws:
      JRDFoxException - thrown if an error is encountered

    • containsDataSource

      boolean containsDataSource​(java.lang.String dataSourceName) throws JRDFoxException
      Checks whether the data store contains a data source with the specified name.
      Parameters:
      dataSourceName - the name of the data source to be checked
      Returns:
      true if the data store contains a data source with the given name
      Throws:
      JRDFoxException - thrown if an error is encountered

    • describeDataSource

      DataSourceInfo describeDataSource​(java.lang.String dataSourceName) throws JRDFoxException
      Returns information about the data source with the given name.
      Parameters:
      dataSourceName - the name of the data source whose information is to be returned
      Returns:
      information about the data source
      Throws:
      JRDFoxException - thrown if an error is encountered

    • registerDataSource

      void registerDataSource​(java.lang.String dataSourceName, java.util.Map<java.lang.String,​java.lang.String> dataSourceParameters) throws JRDFoxException
      Registers a data source with a data store. The new data source is described using the supplied key-value pairs. This operation can be invoked only if no transaction is active on the connection.
      Parameters:
      dataSourceName - the name of the data source to be created
      dataSourceParameters - the key-value pairs that describe the data source to be created
      Throws:
      JRDFoxException - thrown if an error is encountered

    • deregisterDataSource

      void deregisterDataSource​(java.lang.String dataSourceName) throws JRDFoxException
      Deregisters the data source table with the specified name from the data store. This operation can be invoked only if no transaction is active on the connection.
      Parameters:
      dataSourceName - the name of the data source to be deleted
      Throws:
      JRDFoxException - thrown if an error is encountered

    • listDataSourceTables

      java.util.List<DataSourceTableInfo> listDataSourceTables​(java.lang.String dataSourceName) throws JRDFoxException
      Returns information about the data source tables of the specified data source in the data store.
      Parameters:
      dataSourceName - the name of the data source whose tables are to be listed
      Returns:
      information about the data source tables of the specified data source
      Throws:
      JRDFoxException - thrown if an error is encountered

    • containsDataSourceTable

      boolean containsDataSourceTable​(java.lang.String dataSourceName, java.lang.String dataSourceTableName) throws JRDFoxException
      Checks whether the specified data source in the data store contains a data source table with the specified name.
      Parameters:
      dataSourceName - the name of the data source
      dataSourceTableName - the name of the data source table
      Returns:
      true if the specified data source contains the specified data source table
      Throws:
      JRDFoxException - thrown if an error is encountered

    • describeDataSourceTable

      DataSourceTableInfo describeDataSourceTable​(java.lang.String dataSourceName, java.lang.String dataSourceTableName) throws JRDFoxException
      Returns information about the data source table of the specified data source in the data store.
      Parameters:
      dataSourceName - the name of the data source
      dataSourceTableName - the name of the data source table
      Returns:
      information about the data source table
      Throws:
      JRDFoxException - thrown if an error is encountered

    • getDataSourceTableData

      ResourceValue[][] getDataSourceTableData​(java.lang.String dataSourceName, java.lang.String dataSourceTableName, int numberOfRows) throws JRDFoxException
      Returns a sample of the data from the specified data source table. This method is not designed for efficient importation of data from a data source. Rather, its main purpose is to allow applications to view the data in the source before mounting an appropriate tuple table.
      Parameters:
      dataSourceName - the name of the data source
      dataSourceTableName - the name of the data source table
      numberOfRows - the maximum number of rows to be returned
      Returns:
      a sample of the data from the data source table
      Throws:
      JRDFoxException - thrown if an error is encountered

    • listTupleTables

      java.util.Map<java.lang.String,​java.util.Optional<TupleTableInfo>> listTupleTables() throws JRDFoxException
      Returns the list of tuple tables currently present in the data store. The result is a map from tuple table names to optional objects containing tuple table information. If the user has sufficient privileges to access a particular tuple table, the optional will contain the information about the tuple table; otherwise, the optional will be empty.
      Returns:
      information about the tuple tables currently present in the data store
      Throws:
      JRDFoxException - thrown if an error is encountered

    • containsTupleTable

      boolean containsTupleTable​(java.lang.String tupleTableName) throws JRDFoxException
      Checks whether the data store contains a tuple table with the specified name.
      Parameters:
      tupleTableName - the name of the tuple table to be checked
      Returns:
      true if the data store contains a tuple table with the given name
      Throws:
      JRDFoxException - thrown if an error is encountered

    • describeTupleTable

      TupleTableInfo describeTupleTable​(java.lang.String tupleTableName) throws JRDFoxException
      Returns information about the tuple table with the given name.
      Parameters:
      tupleTableName - the name of the tuple table whose information is to be returned
      Returns:
      information about the tuple table
      Throws:
      JRDFoxException - thrown if an error is encountered

    • createTupleTable

      void createTupleTable​(java.lang.String tupleTableName, java.util.Map<java.lang.String,​java.lang.String> tupleTableParameters) throws JRDFoxException
      Creates a tuple table in a data store. The type of the tuple table is described by the supplied parameters. By using appropriate parameters, this method can be used to mount a tuple table from a data source. This operation can be invoked only if no transaction is active on the connection.
      Parameters:
      tupleTableName - the name of the tuple table to be created
      tupleTableParameters - the key-value pairs that describe the tuple table to be created
      Throws:
      JRDFoxException - thrown if an error is encountered

    • deleteTupleTable

      void deleteTupleTable​(java.lang.String tupleTableName) throws JRDFoxException
      Deletes the tuple table with the specified name from the data store. A tuple table can be deleted only if it is not used in the body or head of any rule currently loaded in the data store. This operation can be invoked only if no transaction is active on the connection.
      Parameters:
      tupleTableName - the name of the tuple table to be deleted
      Throws:
      JRDFoxException - thrown if an error is encountered

    • listStatistics

      java.util.List<StatisticsInfo> listStatistics() throws JRDFoxException
      Returns information about all statistics currently managed by the data store.
      Returns:
      information about all statistics that the data store currently manages
      Throws:
      JRDFoxException - thrown if an error is encountered

    • containsStatistics

      boolean containsStatistics​(java.lang.String statisticsName) throws JRDFoxException
      Checks whether the data store contains the statistics with the specified name.
      Parameters:
      statisticsName - the name of the statistics
      Returns:
      true if the data store contains the specified statistics
      Throws:
      JRDFoxException - thrown if an error is encountered

    • describeStatistics

      StatisticsInfo describeStatistics​(java.lang.String statisticsName) throws JRDFoxException
      Returns information about the specific statistics of the data store.
      Parameters:
      statisticsName - the name of the statistics whose information should be returned
      Returns:
      information about the statistics
      Throws:
      JRDFoxException - thrown if an error is encountered

    • createStatistics

      void createStatistics​(java.lang.String statisticsName, java.util.Map<java.lang.String,​java.lang.String> statisticsParameters) throws JRDFoxException
      Creates the statistics in a data store. The name of the statistics determines their type; thus, a data store can contain at most one statistics of a particular type, and the type corresponds to the statistics name. The way in which the statistics are gathered is influenced by the the supplied key-value pairs. This operation can be invoked only if no transaction is active on the connection.
      Parameters:
      statisticsName - the name of the data source to be created
      statisticsParameters - the key-value pairs that describe the statistics to be created
      Throws:
      JRDFoxException - thrown if an error is encountered

    • deleteStatistics

      void deleteStatistics​(java.lang.String statisticsName) throws JRDFoxException
      Deletes the data store statistics with the specified name from the data store. This operation can be invoked only if no transaction is active on the connection.
      Parameters:
      statisticsName - the name of the data store statistics to be deleted
      Throws:
      JRDFoxException - thrown if an error is encountered

    • updateStatistics

      void updateStatistics() throws JRDFoxException
      Updates all statistics that the data store uses to plan queries and rules. This operation should be invoked after large additions to the data store, or after a large number of facts has been derived. This operation can be invoked if either no transaction is active, or a read/write transaction is active. In the latter case, rolling back a transaction does not restore the statistics to their original state.
      Throws:
      JRDFoxException - thrown if an error is encountered

    • getDataStoreVersionAfterLastOperation

      long getDataStoreVersionAfterLastOperation() throws JRDFoxException
      Returns the version that the data store had after the last operation on this connection. If a transaction is active, the current data store version is returned. Note that rolling back a transaction does not restore the data store version.
      Returns:
      the version that the data store had after the last transaction on this connection (or 0 if no transaction was performed on this connection)
      Throws:
      JRDFoxException - thrown if an error is encountered

    • getDataStoreVersion

      long getDataStoreVersion() throws JRDFoxException
      If a transaction is active, the data store version associated with the transaction is returned; otherwise, the last committed data store version is returned.
      Returns:
      the version of the data store
      Throws:
      JRDFoxException - thrown if an error is encountered

    • getLastSnapshotDataStoreVersion

      long getLastSnapshotDataStoreVersion() throws JRDFoxException
      Returns the data store version of the most recent snapshot.
      Returns:
      the data store version of the most recent snapshot
      Throws:
      JRDFoxException - thrown if an error is encountered

    • updateStatistics

      void updateStatistics​(java.lang.String statisticsName) throws JRDFoxException
      Updates the statistics with the given name that the data store uses to plan queries and rules. This operation should be invoked after large additions to the data store, or after a large number of facts has been derived. This operation can be invoked if either no transaction is active, or a read/write transaction is active. In the latter case, rolling back a transaction does not restore the statistics to their original state.
      Parameters:
      statisticsName - the name of the statistics that should be updated
      Throws:
      JRDFoxException - thrown if an error is encountered

    • getCommitProcedure

      CommitProcedureInfo getCommitProcedure() throws JRDFoxException
      Returns the data store's commit procedure.
      Returns:
      the data store's commit procedure.
      Throws:
      JRDFoxException - thrown if an error is encountered

    • setCommitProcedure

      boolean setCommitProcedure​(java.lang.String commitProcedure) throws JRDFoxException
      Sets the data store's commit procedure.
      Parameters:
      commitProcedure - a SPARQL update request string
      Returns:
      true if the commit procedure was changed
      Throws:
      JRDFoxException - thrown if an error is encountered

    • setCommitProcedure

      boolean setCommitProcedure​(java.util.List<Update> steps) throws JRDFoxException
      Sets the data store's commit procedure.
      Parameters:
      steps - a list of update steps that form the commit procedure
      Returns:
      true if the commit procedure was changed
      Throws:
      JRDFoxException - thrown if an error is encountered

    • listDeltaQueries

      java.util.Map<java.lang.String,​java.util.Optional<DeltaQueryInfo>> listDeltaQueries() throws JRDFoxException
      Returns information about the delta queries currently registered with the data store.
      Returns:
      A Map from delta query names to optional objects containing delta query information. If the user has sufficient privileges to access a particular delta query, the optional will contain the information about the delta query; otherwise, the optional will be empty.
      Throws:
      JRDFoxException - thrown if an error is encountered

    • containsDeltaQuery

      boolean containsDeltaQuery​(java.lang.String deltaQueryName) throws JRDFoxException
      Checks whether the data store contains a delta query with the specified name.
      Parameters:
      deltaQueryName - the name of the delta query to be checked
      Returns:
      true if the data store contains a delta query with the given name
      Throws:
      JRDFoxException - thrown if an error is encountered

    • describeDeltaQuery

      DeltaQueryInfo describeDeltaQuery​(java.lang.String deltaQueryName) throws JRDFoxException
      Returns information about the delta query with the given name.
      Parameters:
      deltaQueryName - the name of the delta query whose information is to be returned
      Returns:
      information about the delta query
      Throws:
      JRDFoxException - thrown if an error is encountered

    • registerDeltaQuery

      void registerDeltaQuery​(java.lang.String deltaQueryName, java.lang.String queryText, java.lang.String formatName, long snapshotsMaxSize, long deletionsMaxSize, long additionsMaxSize) throws JRDFoxException
      Registers a delta query with a data store.
      Parameters:
      deltaQueryName - the name of the delta query to be created
      queryText - the string representation of the query
      formatName - the format that the query results should be stored and returned in
      snapshotsMaxSize - the maximum number of answers that a snapshot delta query answer can contain (0 means no answers are stored, and Long.MAX_VALUE means no limit)
      deletionsMaxSize - the maximum number of answers that a deletion delta query answer can contain (0 means no answers are stored, and Long.MAX_VALUE means no limit)
      additionsMaxSize - the maximum number of answers that a addition delta query answer can contain (0 means no answers are stored, and Long.MAX_VALUE means no limit)
      Throws:
      JRDFoxException - thrown if an error is encountered

    • registerDeltaQuery

      void registerDeltaQuery​(java.lang.String deltaQueryName, Query query, java.lang.String formatName, long snapshotsMaxSize, long deletionsMaxSize, long additionsMaxSize) throws JRDFoxException
      Registers a delta query with a data store.
      Parameters:
      deltaQueryName - the name of the delta query to be created
      query - the query object
      formatName - the format that the query results should be stored and returned in
      snapshotsMaxSize - the maximum number of answers that a snapshot delta query answer can contain (0 means no answers are stored, and Long.MAX_VALUE means no limit)
      deletionsMaxSize - the maximum number of answers that a deletion delta query answer can contain (0 means no answers are stored, and Long.MAX_VALUE means no limit)
      additionsMaxSize - the maximum number of answers that a addition delta query answer can contain (0 means no answers are stored, and Long.MAX_VALUE means no limit)
      Throws:
      JRDFoxException - thrown if an error is encountered

    • deregisterDeltaQuery

      void deregisterDeltaQuery​(java.lang.String deltaQueryName) throws JRDFoxException
      Deregisters the delta query with the specified name from the data store.
      Parameters:
      deltaQueryName - the name of the delta query to be deleted
      Throws:
      JRDFoxException - thrown if an error is encountered

    • setDeltaQueryEvaluationMode

      void setDeltaQueryEvaluationMode​(java.lang.String deltaQueryName, DeltaQueryEvaluationMode deltaQueryEvaluationMode) throws JRDFoxException
      Deregisters the delta query with the specified name from the data store.
      Parameters:
      deltaQueryName - the name of the delta query to be deleted.
      deltaQueryEvaluationMode - the desired mode of evaluation of the delta query.
      Throws:
      JRDFoxException - thrown if an error is encountered

    • listDeltaQueryAnswers

      java.util.List<DeltaQueryAnswerInfo> listDeltaQueryAnswers​(java.util.Optional<java.lang.String> deltaQueryName, java.util.Optional<java.lang.Long> fromDataStoreVersion, java.util.Optional<java.lang.Long> toDataStoreVersion, java.util.Optional<DeltaQueryAnswerType> deltaQueryAnswerType) throws JRDFoxException
      Lists the delta query answers that match the specified delta query name, the data store version range, and delta query answer type.
      Parameters:
      deltaQueryName - the name of the delta query for which answers are provided.
      fromDataStoreVersion - the lower bound on the data store version of the delta query answers.
      toDataStoreVersion - the upper bound on the data store version of the delta query answers.
      deltaQueryAnswerType - the type of the delta query answers.
      Returns:
      a list of delta query answer information objects
      Throws:
      JRDFoxException - thrown if an error is encountered

    • deleteDeltaQueryAnswers

      long deleteDeltaQueryAnswers​(java.util.Optional<java.lang.String> deltaQueryName, java.util.Optional<java.lang.Long> fromDataStoreVersion, java.util.Optional<java.lang.Long> toDataStoreVersion, java.util.Optional<DeltaQueryAnswerType> deltaQueryAnswerType) throws JRDFoxException
      Deletes the delta query answers that match the specified delta query name, the data store version range, and delta query answer type.
      Parameters:
      deltaQueryName - the name of the delta query for which answers are provided.
      fromDataStoreVersion - the lower bound on the data store version of the delta query answers.
      toDataStoreVersion - the upper bound on the data store version of the delta query answers.
      deltaQueryAnswerType - the type of the delta query answers.
      Returns:
      the number of delta query answers that were deleted
      Throws:
      JRDFoxException - thrown if an error is encountered

    • exportDeltaQueryAnswer

      void exportDeltaQueryAnswer​(java.io.OutputStream outputStream, java.lang.String deltaQueryName, long dataStoreVersion, DeltaQueryAnswerType deltaQueryAnswerType) throws JRDFoxException
      Exports the delta query answer with the specified name, data store version, and delta query answer type.
      Parameters:
      outputStream - the output stream to which the delta query answer is written
      deltaQueryName - the name of the delta query
      dataStoreVersion - the data store version of the delta query answer to be returned
      deltaQueryAnswerType - the type of the delta query answer to be returned
      Throws:
      JRDFoxException - thrown if an error is encountered

    • getTransactionState

      TransactionState getTransactionState() throws JRDFoxException
      Returns the state of the transaction associated with this connection.
      Returns:
      the state of the transaction
      Throws:
      JRDFoxException - thrown if an error is encountered

    • transactionRequiresRollback

      boolean transactionRequiresRollback() throws JRDFoxException
      Returns true if a transaction is active on this connection and this transaction must be rolled back (i.e., it cannot be committed). This happens when certain operations invoked in a transaction result in an error.
      Returns:
      true if the currently active transaction must be committed
      Throws:
      JRDFoxException - thrown if an error is encountered

    • beginTransaction

      void beginTransaction​(TransactionType transactionType) throws JRDFoxException
      Starts a new transaction on this connection.
      Parameters:
      transactionType - determines the type of the transaction (i.e., whether a read-only or a read/write transaction is requested)
      Throws:
      JRDFoxException - thrown if an error is encountered

    • commitTransaction

      void commitTransaction() throws JRDFoxException
      Commits the transaction associated with this connection. If an exception is thrown during a commit operation, transactionRequiresRollback() will return true, and the transaction should be explicitly rolled back using rollbackTransaction().
      Throws:
      JRDFoxException - thrown if an error is encountered

    • rollbackTransaction

      void rollbackTransaction() throws JRDFoxException
      Rolls back the transaction associated with this connection.
      Throws:
      JRDFoxException - thrown if an error is encountered

    • compact

      void compact() throws JRDFoxException
      Compact the data in the data store. This involves removing all deleted triples, and possibly sorting the data in order to facilitate faster access. This may result in reduced memory usage and/or disk usage for persisted data stores. This operation can be invoked only if no transaction is active.
      Throws:
      JRDFoxException - thrown if an error is encountered

    • clear

      void clear​(int dataStoreParts) throws JRDFoxException
      Clears the specified parts of the data store.
      Parameters:
      dataStoreParts - a bit-mask constructed from DataStorePart values specifying what to clear
      Throws:
      JRDFoxException

    • clearRulesAxiomsExplicateFacts

      void clearRulesAxiomsExplicateFacts() throws JRDFoxException
      Clears all rules and turns all facts in the data store into EDB facts. After this operation, the data store is in the same state as if all derived facts have been imported from a file. This operation can be invoked only if no transaction is active.
      Throws:
      JRDFoxException - thrown if an error is encountered

    • exportData

      void exportData​(java.io.OutputStream outputStream, java.lang.String formatName, java.util.Map<java.lang.String,​java.lang.String> parameters) throws JRDFoxException
      Exports the data in the data store using the given format. The format determines which subset of the store data is to be exported; for example, the Turtle format can store triples, but not facts in other tuple tables or the rules.
      Parameters:
      outputStream - receives the exported data
      formatName - the name of the output format
      parameters - key-value pairs that, depending on the format, customize the export process
      Throws:
      JRDFoxException - thrown if an error is encountered

    • exportData

      void exportData​(java.io.File file, java.lang.String formatName, java.util.Map<java.lang.String,​java.lang.String> parameters) throws JRDFoxException
      Exports the data in the data store using the given format. The format determines which subset of the store data is to be exported; for example, the Turtle format can store triples, but not facts in other tuple tables or the rules.
      Parameters:
      file - receives the exported data
      formatName - the name of the output format
      parameters - key-value pairs that, depending on the format, customize the export process
      Throws:
      JRDFoxException - thrown if an error is encountered

    • exportData

      void exportData​(java.io.File file, java.lang.String encryptionAlgorithm, java.lang.String encryptionKey, java.lang.String formatName, java.util.Map<java.lang.String,​java.lang.String> parameters) throws JRDFoxException
      Exports the data in the data store using the given format. The format determines which subset of the store data is to be exported; for example, the Turtle format can store triples, but not facts in other tuple tables or the rules.
      Parameters:
      file - receives the exported data
      encryptionAlgorithm - the name of the encryption algorithm to use (or null if no encryption should be used)
      encryptionKey - the key to use for encryption (or null if no encryption should be used)
      formatName - the name of the output format
      parameters - key-value pairs that, depending on the format, customize the export process
      Throws:
      JRDFoxException - thrown if an error is encountered

    • importData

      ImportResult importData​(UpdateType updateType, InputSourceFactory inputSourceFactory, java.lang.String formatName, ImportNotificationMonitor importNotificationMonitor) throws JRDFoxException
      Imports the data described by the given input source factory into the current data store.
      Parameters:
      updateType - specifies whether the imported data should be added or removed from the data store
      inputSourceFactory - the content being imported
      formatName - the name of the format of the data
      importNotificationMonitor - receives errors/warnings encountered during import
      Returns:
      provides information about the importation process
      Throws:
      JRDFoxException - thrown if an error is encountered

    • importData

      ImportResult importData​(UpdateType updateType, java.util.Collection<InputSourceFactory> inputSourceFactories, java.lang.String formatName, ImportNotificationMonitor importNotificationMonitor) throws JRDFoxException
      Imports the data described by the given input source factories into the current data store. If this server is configured to use more than one thread, then sources are parsed and imported in parallel.
      Parameters:
      updateType - specifies whether the imported data should be added or removed from the data store
      inputSourceFactories - the content being imported
      formatName - the name of the format of the data
      importNotificationMonitor - receives errors/warnings encountered during import
      Returns:
      provides information about the importation process
      Throws:
      JRDFoxException - thrown if an error is encountered

    • importData

      ImportResult importData​(UpdateType updateType, java.io.File file) throws JRDFoxException
      Imports the data from the given file into the current data store.
      Parameters:
      updateType - specifies whether the imported data should be added or removed from the data store
      file - the content being imported
      Returns:
      provides information about the importation process
      Throws:
      JRDFoxException - thrown if an error is encountered

    • importData

      ImportResult importData​(UpdateType updateType, java.lang.String content) throws JRDFoxException
      Imports the data from the given string into the current data store.
      Parameters:
      updateType - specifies whether the imported data should be added or removed from the data store
      content - the content being imported
      Returns:
      provides information about the importation process
      Throws:
      JRDFoxException - thrown if an error is encountered

    • importData

      ImportResult importData​(UpdateType updateType, java.io.InputStream inputStream) throws JRDFoxException
      Imports the data from the given input stream into the current data store.
      Parameters:
      updateType - specifies whether the imported data should be added or removed from the data store
      inputStream - the content being imported
      Returns:
      provides information about the importation process
      Throws:
      JRDFoxException - thrown if an error is encountered

    • importData

      ImportResult importData​(ResourceValue defaultGraph, UpdateType updateType, InputSourceFactory inputSourceFactory, java.lang.String formatName, ImportNotificationMonitor importNotificationMonitor) throws JRDFoxException
      Imports the data described by the given input source factory into the current data store Triples in the default graph will be put into the named graph specified using the defaultGraph parameter.
      Parameters:
      defaultGraph - the resource identifying the default graph
      updateType - specifies whether the imported data should be added or removed from the data store
      inputSourceFactory - the content being imported
      formatName - the name of the format of the data
      importNotificationMonitor - receives errors/warnings encountered during import
      Returns:
      provides information about the importation process
      Throws:
      JRDFoxException - thrown if an error is encountered

    • importData

      ImportResult importData​(ResourceValue defaultGraph, UpdateType updateType, java.util.Collection<InputSourceFactory> inputSourceFactories, java.lang.String formatName, ImportNotificationMonitor importNotificationMonitor) throws JRDFoxException
      Imports the data described by the given input source factories into the current data store. Triples in the default graph will be put into the named graph specified using the defaultGraph parameter. If this server is configured to use more than one thread, then sources are parsed and imported in parallel.
      Parameters:
      defaultGraph - the resource identifying the default graph
      updateType - specifies whether the imported data should be added or removed from the data store
      inputSourceFactories - the content being imported
      formatName - the name of the format of the data
      importNotificationMonitor - receives errors/warnings encountered during import
      Returns:
      provides information about the importation process
      Throws:
      JRDFoxException - thrown if an error is encountered

    • importData

      ImportResult importData​(ResourceValue defaultGraph, UpdateType updateType, java.io.File file) throws JRDFoxException
      Imports the data from the given file into the current data store. Triples in the default graph will be put into the named graph specified using the defaultGraph parameter.
      Parameters:
      defaultGraph - the resource identifying the default graph
      updateType - specifies whether the imported data should be added or removed from the data store
      file - the content being imported
      Returns:
      provides information about the importation process
      Throws:
      JRDFoxException - thrown if an error is encountered

    • importData

      ImportResult importData​(ResourceValue defaultGraph, UpdateType updateType, java.lang.String content) throws JRDFoxException
      Imports the data from the given string into the current data store. Triples in the default graph will be put into the named graph specified using the defaultGraph parameter.
      Parameters:
      defaultGraph - the resource identifying the default graph
      updateType - specifies whether the imported data should be added or removed from the data store
      content - the content being imported
      Returns:
      provides information about the importation process
      Throws:
      JRDFoxException - thrown if an error is encountered

    • importData

      ImportResult importData​(ResourceValue defaultGraph, UpdateType updateType, java.io.InputStream inputStream) throws JRDFoxException
      Imports the data from the given input stream into the current data store. Triples in the default graph will be put into the named graph specified using the defaultGraph parameter.
      Parameters:
      defaultGraph - the resource identifying the default graph
      updateType - specifies whether the imported data should be added or removed from the data store
      inputStream - the content being imported
      Returns:
      provides information about the importation process
      Throws:
      JRDFoxException - thrown if an error is encountered

    • importAxiomsFromTriples

      ImportResult importAxiomsFromTriples​(ResourceValue sourceGraph, boolean translateAssertions, ResourceValue destinationGraph, UpdateType updateType, ImportNotificationMonitor importNotificationMonitor) throws JRDFoxException
      Parses the given source graph into OWL axioms, and imports the axioms into the destination graph.
      Parameters:
      sourceGraph - the resource identifying the source graph
      translateAssertions - assertions are translated if this parameter is true
      destinationGraph - the resource identifying the destination graph
      updateType - specifies whether the imported data should be added or removed from the data store
      importNotificationMonitor - receives errors/warnings encountered during import
      Returns:
      provides information about the importation process
      Throws:
      JRDFoxException - thrown if an error is encountered

    • importAxiomsFromTriples

      ImportResult importAxiomsFromTriples​(ResourceValue sourceGraph, boolean translateAssertions, ResourceValue destinationGraph, UpdateType updateType) throws JRDFoxException
      Parses the given source graph into OWL axioms, and imports the axioms into the destination graph.
      Parameters:
      sourceGraph - the resource identifying the source graph
      translateAssertions - assertions are translated if this parameter is true
      destinationGraph - the resource identifying the destination graph
      updateType - specifies whether the imported data should be added or removed from the data store
      Returns:
      provides information about the importation process
      Throws:
      JRDFoxException - thrown if an error is encountered

    • listRules

      java.util.List<RuleInfo> listRules() throws JRDFoxException
      Returns the information about the rules currently loaded into the data store.
      Returns:
      information about the rules currently loaded into the data store
      Throws:
      JRDFoxException - thrown if an error is encountered

    • addRule

      long addRule​(Rule rule) throws JRDFoxException
      Adds a rule to the data store.
      Parameters:
      rule - the rule to be added
      Returns:
      the number of rules that were changed
      Throws:
      JRDFoxException - thrown if an error is encountered

    • addRules

      long addRules​(java.util.Collection<Rule> datalogProgram) throws JRDFoxException
      Adds a collection of rules to the data store.
      Parameters:
      datalogProgram - the rules to be added
      Returns:
      the number of rules that were changed
      Throws:
      JRDFoxException - thrown if an error is encountered

    • deleteRule

      long deleteRule​(Rule rule) throws JRDFoxException
      Deletes a rule to the data store.
      Parameters:
      rule - the rule to be deleted
      Returns:
      the number of rules that were changed
      Throws:
      JRDFoxException - thrown if an error is encountered

    • deleteRules

      long deleteRules​(java.util.Collection<Rule> datalogProgram) throws JRDFoxException
      Deletes a collection of rules to the data store.
      Parameters:
      datalogProgram - the rules to be deleted
      Returns:
      the number of rules that were changed
      Throws:
      JRDFoxException - thrown if an error is encountered

    • recompile

      void recompile() throws JRDFoxException
      Recompiles the rules and commit procedure using the currently available statistics. This method should be called after bulk updates to a data store in order to ensure that the rules are evaluated using efficient query plans. This operation can be invoked if either no transaction is active, or a read/write transaction is active.
      Throws:
      JRDFoxException - thrown if an error is encountered

    • requiresIncrementalReasoning

      boolean requiresIncrementalReasoning() throws JRDFoxException
      Returns true if the next data store update must be performed using incremental reasoning (rather than standard using the standard datalog materialization "from scratch" algorithm).
      Returns:
      true if the next data store update must be performed using incremental reasoning
      Throws:
      JRDFoxException - thrown if an error is encountered

    • updateMaterialization

      void updateMaterialization() throws JRDFoxException
      Updates the materialization so that all and only the consequences of the explicitly stated facts and the rules are derived. This operation is automatically applied internally so that all queries are always evaluated with respect to the updated materialization. However, requesting an update explicitly can be beneficial in some cases (e.g., when benchmarking reasoning algorithms). This operation can be invoked only if a read/write transaction is active.
      Throws:
      JRDFoxException - thrown if an error is encountered

    • recomputeMaterialization

      void recomputeMaterialization() throws JRDFoxException
      Recomputes the materialization from scratch — that is, deletes all derived facts and applies all rules as if the data had just been freshly imported. This operation can be used when the data in a data source attached to a data store changes: since there is no way for an external data source to notify the data store of data changes, the only option is to recompute everything afresh. This operation can be invoked only if no transaction is active.
      Throws:
      JRDFoxException - thrown if an error is encountered

    • createExplanation

      void createExplanation​(java.lang.String factText, int maxDistanceFromRoot, int maxRuleInstancesPerFact, ExplanationType explanationType, java.io.OutputStream outputStream) throws JRDFoxException
      Computes an explanation for a given fact and saves it in JSON format to the given output stream.
      Parameters:
      factText - the fact to be explained
      maxDistanceFromRoot - specifies how far in the proof tree to look
      maxRuleInstancesPerFact - specifies the maximum number of rule instances deriving a particular fact to consider
      explanationType - determines the type of explanation that should be produced
      outputStream - receives the explanation
      Throws:
      JRDFoxException - thrown if an error is encountered

    • createExplanation

      void createExplanation​(TupleTableAtom fact, int maxDistanceFromRoot, int maxRuleInstancesPerFact, ExplanationType explanationType, java.io.OutputStream outputStream) throws JRDFoxException
      Computes an explanation for a given fact and saves it in JSON format to the given output stream.
      Parameters:
      maxDistanceFromRoot - specifies how far in the proof tree to look
      maxRuleInstancesPerFact - specifies the maximum number of rule instances deriving a particular fact to consider
      explanationType - determines the type of explanation that should be produced
      outputStream - receives the explanation
      Throws:
      JRDFoxException - thrown if an error is encountered

    • createCursor

      Cursor createCursor​(java.lang.String queryText, java.util.Map<java.lang.String,​java.lang.String> compilationParameters, int fetchWindowSize) throws JRDFoxException
      Creates a cursor over the results of the given query. Since calling C++ from Java is expensive, JRDFox cursors have the option to retrieve answers in batches, and the batch size is governed by the fetchWindowSize parameter. Please note that data store version checking is performed only on each access to the C++ cursor; thus, if the batch size is different from one, then a JRDFox cursor might detect a data store change with a delay.
      Parameters:
      queryText - the query to be evaluated
      compilationParameters - the key-value pairs guiding query compilation
      fetchWindowSize - the number of answers that will be retrieved from C++ in each cursor operation
      Returns:
      the cursor over the query results
      Throws:
      JRDFoxException - thrown if an error is encountered

    • createCursor

      Cursor createCursor​(java.lang.String queryText, java.util.Map<java.lang.String,​java.lang.String> compilationParameters) throws JRDFoxException
      Creates a cursor over the results of the given query with the default fetch window size of 100.
      Parameters:
      queryText - the query to be evaluated
      compilationParameters - the key-value pairs guiding query compilation
      Returns:
      the cursor over the query results
      Throws:
      JRDFoxException - thrown if an error is encountered

    • createCursor

      Cursor createCursor​(Query query, java.util.Map<java.lang.String,​java.lang.String> compilationParameters, int fetchWindowSize) throws JRDFoxException
      Creates a cursor over the results of the given query. Since calling C++ from Java is expensive, JRDFox cursors have the option to retrieve answers in batches, and the batch size is governed by the fetchWindowSize parameter. Please note that data store version checking is performed only on each access to the C++ cursor; thus, if the batch size is different from one, then a JRDFox cursor might detect a data store change with a delay.
      Parameters:
      query - the query to be evaluated
      compilationParameters - the key-value pairs guiding query compilation
      fetchWindowSize - the number of answers that will be retrieved from C++ in each cursor operation
      Returns:
      the cursor over the query results
      Throws:
      JRDFoxException - thrown if an error is encountered

    • createCursor

      Cursor createCursor​(Query query, java.util.Map<java.lang.String,​java.lang.String> compilationParameters) throws JRDFoxException
      Creates a cursor over the results of the given query with the default fetch window size of 100.
      Parameters:
      query - the query to be evaluated
      compilationParameters - the key-value pairs guiding query compilation
      Returns:
      the cursor over the query results
      Throws:
      JRDFoxException - thrown if an error is encountered

    • evaluateQuery

      StatementResult evaluateQuery​(java.lang.String queryText, java.util.Map<java.lang.String,​java.lang.String> compilationParameters, QueryAnswerMonitor queryAnswerMonitor) throws JRDFoxException
      Evaluates a query and calls the supplied QueryAnswerMonitor instance for each tuple in the result.
      Parameters:
      queryText - the query to be evaluated
      compilationParameters - the key-value pairs guiding query compilation
      queryAnswerMonitor - an interface containing a callback method that is called for each tuple in the result
      Returns:
      provides information about the number of results produced
      Throws:
      JRDFoxException - thrown if an error is encountered

    • evaluateQuery

      StatementResult evaluateQuery​(Query query, java.util.Map<java.lang.String,​java.lang.String> compilationParameters, QueryAnswerMonitor queryAnswerMonitor) throws JRDFoxException
      Evaluates a query and calls the supplied QueryAnswerMonitor instance for each tuple in the result.
      Parameters:
      query - the query to be evaluated
      compilationParameters - the key-value pairs guiding query compilation
      queryAnswerMonitor - an interface containing a callback method that is called for each tuple in the result
      Returns:
      provides information about the number of results produced
      Throws:
      JRDFoxException - thrown if an error is encountered

    • evaluateUpdate

      StatementResult evaluateUpdate​(java.lang.String updateText, java.util.Map<java.lang.String,​java.lang.String> compilationParameters) throws JRDFoxException
      Evaluates an update.
      Parameters:
      updateText - the update to be evaluated
      compilationParameters - the key-value pairs guiding statement compilation
      Returns:
      provides information about the number of results produced
      Throws:
      JRDFoxException - thrown if an error is encountered

    • evaluateUpdate

      StatementResult evaluateUpdate​(Update update, java.util.Map<java.lang.String,​java.lang.String> compilationParameters) throws JRDFoxException
      Evaluates an update.
      Parameters:
      update - the update to be evaluated
      compilationParameters - the key-value pairs guiding statement compilation
      Returns:
      provides information about the number of results produced
      Throws:
      JRDFoxException - thrown if an error is encountered

    • evaluateUpdates

      StatementResult evaluateUpdates​(java.util.List<Update> updates, java.util.Map<java.lang.String,​java.lang.String> compilationParameters) throws JRDFoxException
      Evaluates a list of updates.
      Parameters:
      updates - the list of updates to be evaluated
      compilationParameters - the key-value pairs guiding statement compilation
      Returns:
      provides information about the number of results produced
      Throws:
      JRDFoxException - thrown if an error is encountered

    • evaluateStatement

      StatementResult evaluateStatement​(java.lang.String statementText, java.util.Map<java.lang.String,​java.lang.String> compilationParameters, java.io.OutputStream outputStream, java.lang.String queryAnswerFormatName) throws JRDFoxException
      Evaluates a statement and serializes the result to the supplied output stream using the specified format.
      Parameters:
      statementText - the statement to be evaluated
      compilationParameters - the key-value pairs guiding statement compilation
      outputStream - receives the statement result
      queryAnswerFormatName - specifies the name of the answer format in case of a query
      Returns:
      provides information about the number of results produced
      Throws:
      JRDFoxException - thrown if an error is encountered

    • evaluateStatement

      StatementResult evaluateStatement​(Statement statement, java.util.Map<java.lang.String,​java.lang.String> compilationParameters, java.io.OutputStream outputStream, java.lang.String queryAnswerFormatName) throws JRDFoxException
      Evaluates a statement and serializes the result to the supplied output stream using the specified format.
      Parameters:
      statement - the statement to be evaluated
      compilationParameters - the key-value pairs guiding statement compilation
      outputStream - receives the query result
      queryAnswerFormatName - specifies the name of the answer format in case of a query
      Returns:
      provides information about the number of results produced
      Throws:
      JRDFoxException - thrown if an error is encountered

    • evaluateStatement

      StatementResult evaluateStatement​(java.lang.String statementText, java.util.Map<java.lang.String,​java.lang.String> compilationParameters, java.io.File file, java.lang.String queryAnswerFormatName) throws JRDFoxException
      Evaluates a statement and serializes the result to the supplied file using the specified format.
      Parameters:
      statementText - the statement to be evaluated
      compilationParameters - the key-value pairs guiding statement compilation
      file - receives the query result
      queryAnswerFormatName - specifies the name of the answer format in case of a query
      Returns:
      provides information about the number of results produced
      Throws:
      JRDFoxException - thrown if an error is encountered

    • evaluateStatement

      StatementResult evaluateStatement​(Statement statement, java.util.Map<java.lang.String,​java.lang.String> compilationParameters, java.io.File file, java.lang.String queryAnswerFormatName) throws JRDFoxException
      Evaluates a statement and serializes the result to the supplied file using the specified format.
      Parameters:
      statement - the statement to be evaluated
      compilationParameters - the key-value pairs guiding statement compilation
      file - receives the query result
      queryAnswerFormatName - specifies the name of the answer format in case of a query
      Returns:
      provides information about the number of results produced
      Throws:
      JRDFoxException - thrown if an error is encountered