package org.neo4j.rdf.sail;

import java.util.Map;

import info.aduna.iteration.CloseableIteration;

import org.openrdf.model.Literal;
import org.openrdf.model.Resource;
import org.openrdf.model.Statement;
import org.openrdf.model.URI;
import org.openrdf.model.Value;
import org.openrdf.sail.NotifyingSailConnection;
import org.openrdf.sail.SailConnection;
import org.openrdf.sail.SailException;

/**
 * An extended {@link SailConnection} with a method for fulltext search.
 * The format is very basic word search with AND logics between them, f.ex:
 * (without quotation marks)
 * 
 * "computer science" will return statements with computer and science in them
 * "comput* science" will return statement with computer, computational (and
 * other words beginning with comput) and science in them.
 * 
 */
public interface GraphDatabaseSailConnection extends NotifyingSailConnection
{
    CloseableIteration<? extends FulltextQueryResult, SailException>
        evaluate( String query ) throws SailException;
    
    CloseableIteration<? extends FulltextQueryResult, SailException>
        evaluateWithSnippets( String query, int snippetCountLimit )
        throws SailException;
    
    void setStatementMetadata( Statement statement,
        Map<String, Literal> metadata ) throws SailException;
    
    Statement addStatement( Map<String, Literal> metadata, Resource subject,
        URI predicate, Value object, Resource... contexts )
        throws SailException;
    
    void reindexFulltextIndex() throws SailException;
}