BUG-3876: Add XPath interfaces

[yangtools.git] / yang / yang-data-api / src / main / java / org / opendaylight / yangtools / yang / data / api / schema / xpath / XPathSchemaContext.java

diff --git a/yang/yang-data-api/src/main/java/org/opendaylight/yangtools/yang/data/api/schema/xpath/XPathSchemaContext.java b/yang/yang-data-api/src/main/java/org/opendaylight/yangtools/yang/data/api/schema/xpath/XPathSchemaContext.java
new file mode 100644 (file)
index 0000000..335a5ed
--- /dev/null
+++ b/yang/yang-data-api/src/main/java/org/opendaylight/yangtools/yang/data/api/schema/xpath/XPathSchemaContext.java
@@ -0,0 +1,42 @@
+/*
+ * Copyright (c) 2015 Cisco Systems, Inc. and others.  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 org.opendaylight.yangtools.yang.data.api.schema.xpath;
+
+import com.google.common.annotations.Beta;
+import javax.annotation.Nonnull;
+import javax.xml.xpath.XPathExpressionException;
+import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
+import org.opendaylight.yangtools.yang.model.api.SchemaPath;
+
+/**
+ * A schema-informed XPath context. It supports creation of {@link XPathDocument}s, which are bound to
+ * a particular root node.
+ */
+@Beta
+public interface XPathSchemaContext {
+    /**
+     * Compile an XPath expression for execution on {@link XPathDocument}s produced by this context.
+     *
+     * @param xpath XPath expression to compile
+     * @param schemaPath Schema path of the node at which this expression is expected to be evaluated
+     * @return A compiled XPath expression
+     * @throws XPathExpressionException if the provided expression is invalid, either syntactically or by referencing
+     *         namespaces unknown to this schema context.
+     */
+    @Nonnull XPathExpression compileExpression(@Nonnull String xpath, @Nonnull SchemaPath schemaPath)
+            throws XPathExpressionException;
+
+    /**
+     * Create a new document context.
+     *
+     * @param documentRoot Root node of the document
+     * @return A new {@link XPathDocument} on which queries may be executed.
+     * @throws IllegalArgumentException if the document root is not known to this schema context.
+     */
+    @Nonnull XPathDocument createDocument(@Nonnull NormalizedNode<?, ?> documentRoot);
+}