/**
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.marmotta.kiwi.sail;
import org.apache.marmotta.kiwi.config.KiWiConfiguration;
import org.apache.marmotta.kiwi.persistence.KiWiDialect;
import org.apache.marmotta.kiwi.persistence.KiWiPersistence;
import org.openrdf.model.ValueFactory;
import org.openrdf.sail.SailException;
import org.openrdf.sail.helpers.NotifyingSailBase;
import java.sql.SQLException;
/**
* An implementation of a KiWi triple store without extended transaction support. The KiWiStore holds a reference to
* a KiWiPersistence object to access the database. Each SailConnection will be directly associated with a database
* connection and a database transaction.
* <p/>
* Note that extended KiWi functionality like the reasoner or versioning require the extended transaction support.
* In these cases, please see KiWiTransactionalStore.
* <p/>
* Author: Sebastian Schaffert
*/
public class KiWiStore extends NotifyingSailBase {
/**
* The repository-wide value factory, using the valueFactoryConnection above. Will be initialised when
* getValueFactory() is called for the first time.
*/
private KiWiValueFactory repositoryValueFactory;
private KiWiPersistence persistence;
/**
* The default context to use when no explicit context is given in createStatement. The KiWi triple store
* does not support null values for the context of a triple, so this URL must be set to an appropriate value
*/
private String defaultContext;
/**
* The context to use for storing all inferred triples. The value set here will override all contexts
* given to addInferredTriple, because KiWi always stores all inferred triples in the same context.
*/
private String inferredContext;
private boolean initialized = false;
/**
* Drop databases when shutdown is called. This option is mostly useful for testing.
*/
private boolean dropTablesOnShutdown = false;
public KiWiStore(KiWiPersistence persistence, String defaultContext, String inferredContext) {
this.persistence = persistence;
this.defaultContext = defaultContext;
this.inferredContext = inferredContext;
}
@Deprecated
public KiWiStore(String name, String jdbcUrl, String db_user, String db_password, KiWiDialect dialect, String defaultContext, String inferredContext) {
this(new KiWiConfiguration(name,jdbcUrl,db_user,db_password,dialect, defaultContext, inferredContext));
}
public KiWiStore(KiWiConfiguration configuration) {
this(new KiWiPersistence(configuration), configuration.getDefaultContext(), configuration.getInferredContext());
}
/**
* Do store-specific operations to initialize the store. The default
* implementation of this method does nothing.
*/
@Override
protected void initializeInternal() throws SailException {
try {
persistence.initialise();
persistence.initDatabase();
initialized = true;
} catch (SQLException e) {
throw new SailException("database error while initialising database",e);
}
}
public boolean isInitialized() {
return initialized;
}
/**
* The default context to use when no explicit context is given in createStatement. The KiWi triple store
* does not support null values for the context of a triple, so this URL must be set to an appropriate value
*/
public String getDefaultContext() {
return defaultContext;
}
/**
* The context to use for storing all inferred triples. The value set here will override all contexts
* given to addInferredTriple, because KiWi always stores all inferred triples in the same context.
*/
public String getInferredContext() {
return inferredContext;
}
/**
* Return a reference to the persistence object used by this KiWiStore.
* @return
*/
public KiWiPersistence getPersistence() {
return persistence;
}
/**
* Drop databases when shutdown is called. This option is mostly useful for testing.
*/
public boolean isDropTablesOnShutdown() {
return dropTablesOnShutdown;
}
/**
* Drop databases when shutdown is called. This option is mostly useful for testing.
*/
public void setDropTablesOnShutdown(boolean dropTablesOnShutdown) {
this.dropTablesOnShutdown = dropTablesOnShutdown;
}
/**
* Returns a store-specific SailConnection object.
*
* @return A connection to the store.
*/
@Override
protected KiWiSailConnection getConnectionInternal() throws SailException {
return new KiWiSailConnection(this);
}
/**
* Do store-specific operations to ensure proper shutdown of the store.
*/
@Override
protected void shutDownInternal() throws SailException {
closeValueFactory();
if(dropTablesOnShutdown) {
try {
logger.info("dropping database tables ...");
persistence.dropDatabase();
} catch (SQLException e) {
logger.error("error dropping database: {}", e.getMessage());
}
}
persistence.shutdown();
initialized = false;
}
/**
* In case there is a value factory managed by this repository directly, close it (and the underlying database
* connection)
*/
public synchronized void closeValueFactory() {
if(repositoryValueFactory != null) {
repositoryValueFactory.close();
repositoryValueFactory = null;
persistence.setValueFactory(null);
}
}
/**
* Checks whether this Sail object is writable, i.e. if the data contained in
* this Sail object can be changed.
*/
@Override
public boolean isWritable() throws SailException {
return true;
}
/**
* Gets a ValueFactory object that can be used to create URI-, blank node-,
* literal- and statement objects.
*
* @return a ValueFactory object for this Sail object.
*/
@Override
public synchronized ValueFactory getValueFactory() {
if(repositoryValueFactory == null) {
repositoryValueFactory = new KiWiValueFactory(this, defaultContext);
persistence.setValueFactory(repositoryValueFactory);
}
return repositoryValueFactory;
}
/**
* Manually call the garbage collector for the triple store. Otherwise it will run every hour.
*/
public void garbageCollect() throws SailException {
try {
persistence.garbageCollect();
} catch (SQLException e) {
throw new SailException("error calling garbage collector",e);
}
}
public boolean checkConsistency() throws SailException {
try {
return persistence.checkConsistency();
} catch (SQLException e) {
throw new SailException("error calling consistency check",e);
}
}
}