com.franz.agraph.repository.AGVirtualRepository Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of agraph-java-client Show documentation
Java client API for Franz AllegroGraph
There is a newer version: 5.0.2
/******************************************************************************
** Copyright (c) 2008-2016 Franz Inc.
** All rights reserved. This program and the accompanying materials
** are made available under the terms of the Eclipse Public License v1.0
** which accompanies this distribution, and is available at
** http://www.eclipse.org/legal/epl-v10.html
******************************************************************************/

package com.franz.agraph.repository;

import java.io.File;
import java.util.concurrent.ScheduledExecutorService;

import org.openrdf.model.Resource;
import org.openrdf.repository.RepositoryException;
import org.openrdf.repository.base.RepositoryBase;

import com.franz.agraph.http.AGHTTPClient;
import com.franz.agraph.http.AGHttpRepoClient;
import com.franz.agraph.http.exception.AGHttpException;

/**
 * A class for virtual repositories, used for working with federations, 
 * graph-filtered stores, reasoning stores, and compositions thereof. 
 * 
 * Virtual repositories don't reside on disk (their component stores do); 
 * they don't have a catalog.
 *  
 * Applications normally create a virtual repository via an AGServer instance. 
 *  
 * @see AGServer#virtualRepository(String)
 * @see AGServer#federate(AGAbstractRepository...)
 */
public class AGVirtualRepository extends RepositoryBase implements AGAbstractRepository {
	private final AGServer server;
	final AGRepository wrapped;
	private final String spec;
	private final AGValueFactory vf;

	/**
	 * Applications normally create a virtual repository via an AGServer instance. 
	 *  
	 * @see AGServer#virtualRepository(String)
	 * @see AGServer#federate(AGAbstractRepository...)
	 */
	public AGVirtualRepository(AGServer server, String spec, AGRepository wrapped) {
		this.server = server;
		this.spec = spec;
		this.wrapped = wrapped;
		vf = new AGValueFactory(wrapped);
	}

	public AGServer getServer() {
		return server;
	}
	
	/**
	 * Virtual repositories don't reside on disk (their component stores do);
	 * they don't have a catalog.
	 * 
	 * @return null
	 */
	public AGCatalog getCatalog() {
		return null;
	}
	
	/**
	 * Gets the store specification used to create this virtual repository.
	 * 
	 * @see AGServer#virtualRepository(String)
	 */
	public String getSpec() {
		return spec;
	}

	// interface
	
	public boolean isWritable() {
		return wrapped != null;
	}
	
	public AGValueFactory getValueFactory() {
		return vf;
	}
	
	public AGRepositoryConnection getConnection(final ScheduledExecutorService executor)
			throws RepositoryException {
		AGHTTPClient client = server.getHTTPClient();
		AGHttpRepoClient repoclient;
		try {
			repoclient = new AGHttpRepoClient(
					this, client, null, client.openSession(spec, true), executor);
		} catch (AGHttpException e) {
			throw new RepositoryException(e);
		}
		return new AGRepositoryConnection(this, repoclient);
	}

	public AGRepositoryConnection getConnection() throws RepositoryException {
		return this.getConnection(server.getExecutor());
	}

	/**
	 * Calls Sesame method {@link #shutDown()}.
	 */
    @Override
	public void close() throws RepositoryException {
        shutDown();
    }

	@Override
	protected void initializeInternal() throws RepositoryException {
	}

	
    @Override
	protected void shutDownInternal() throws RepositoryException {}

    
	/**
	 * The dataDir is not currently applicable to AllegroGraph. 
	 * @deprecated not applicable to AllegroGraph
	 * @throws UnsupportedOperationException
	 */
	public void setDataDir(File dataDir) {
		throw new UnsupportedOperationException("setDataDir is inapplicable for AG repositories");
	}
	
	/**
	 * The dataDir is not currently applicable to AllegroGraph. 
	 * @deprecated not applicable to AllegroGraph
	 * @throws UnsupportedOperationException
	 */
	public File getDataDir() {
		throw new UnsupportedOperationException("getDataDir is inapplicable for AG repositories");
	}

	// string-mangling utilities for creating sessions
	public static String federatedSpec(String[] repoSpecs) {
		String spec = "";
		for (int i = 0; i < repoSpecs.length; i++) {
			if (spec.length() > 0) spec += " + ";
			spec += repoSpecs[i];
		}
		return spec;
	}
	
	public static String reasoningSpec(String repoSpec, String reasoner) {
		return reasoningSpec(repoSpec,reasoner,null);
	}
	
	public static String reasoningSpec(String repoSpec, String reasoner, Resource inferredGraph) {
		String reasoningSpec = repoSpec + "[" + reasoner;
		if (inferredGraph != null) {
			reasoningSpec += ("#<" + inferredGraph.stringValue() + ">");
		}
		return reasoningSpec + "]";
	}

	public static String filteredSpec(AGAbstractRepository repo, Resource[] contexts) {
		String[] graphs = new String[contexts.length];
		for (int i=0;i";
			}
		}
		return filteredSpec(repo.getSpec(),graphs);
	}
	
	public static String filteredSpec(String repoSpec, String[] graphs) {
		repoSpec += "{";
		for (String graph : graphs) repoSpec += " " + graph;
		return repoSpec + "}";
	}
}