1 /*
2 * ModeShape (http://www.modeshape.org)
3 * See the COPYRIGHT.txt file distributed with this work for information
4 * regarding copyright ownership. Some portions may be licensed
5 * to Red Hat, Inc. under one or more contributor license agreements.
6 * See the AUTHORS.txt file in the distribution for a full listing of
7 * individual contributors.
8 *
9 * ModeShape is free software. Unless otherwise indicated, all code in ModeShape
10 * is licensed to you under the terms of the GNU Lesser General Public License as
11 * published by the Free Software Foundation; either version 2.1 of
12 * the License, or (at your option) any later version.
13 *
14 * ModeShape is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 * Lesser General Public License for more details.
18 *
19 * You should have received a copy of the GNU Lesser General Public
20 * License along with this software; if not, write to the Free
21 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
22 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
23 */
24 package org.modeshape.jcr.query;
25
26 import java.util.Map;
27 import javax.jcr.Node;
28 import javax.jcr.NodeIterator;
29 import javax.jcr.RepositoryException;
30 import javax.jcr.Value;
31 import org.modeshape.graph.ExecutionContext;
32 import org.modeshape.graph.Location;
33 import org.modeshape.graph.property.Name;
34 import org.modeshape.graph.query.QueryResults;
35 import org.modeshape.graph.query.model.QueryCommand;
36 import org.modeshape.graph.query.plan.PlanHints;
37 import org.modeshape.graph.query.validate.Schemata;
38
39 /**
40 * The context in which queries are executed.
41 */
42 public interface JcrQueryContext {
43
44 boolean isLive();
45
46 ExecutionContext getExecutionContext();
47
48 Schemata getSchemata();
49
50 Node store( String absolutePath,
51 Name nodeType,
52 String language,
53 String statement ) throws RepositoryException;
54
55 Node getNode( Location location ) throws RepositoryException;
56
57 Value createValue( int propertyType,
58 Object value );
59
60 QueryResults execute( QueryCommand query,
61 PlanHints hints,
62 Map<String, Object> variables ) throws RepositoryException;
63
64 QueryResults search( String searchExpression,
65 int maxRowCount,
66 int offset ) throws RepositoryException;
67
68 NodeIterator emptyNodeIterator();
69 }