org.opendaylight.yangtools.yang.data.api.schema.xpath

Interface XPathSchemaContext

@Beta
public interface XPathSchemaContext

A schema-informed XPath context. It supports creation of XPathDocuments, which are bound to a particular root node.

Method Summary

Modifier and Type	Method and Description
XPathExpression	compileExpression(SchemaPath schemaPath, com.google.common.base.Converter<String,QNameModule> prefixes, String xpath) Compile an XPath expression for execution on XPathDocuments produced by this context.
XPathDocument	createDocument(NormalizedNode<?,?> documentRoot) Create a new document context.

Method Detail

compileExpression

@Nonnull
XPathExpression compileExpression(@Nonnull
                                           SchemaPath schemaPath,
                                           com.google.common.base.Converter<String,QNameModule> prefixes,
                                           @Nonnull
                                           String xpath)
                                    throws XPathExpressionException

Compile an XPath expression for execution on XPathDocuments produced by this context.

The user must provide a prefix-to-mapping Converter, which will be used to convert any prefixes found in the XPath expression being compiled in the resulting context.

Parameters:

schemaPath - Schema path of the node at which this expression is expected to be evaluated

prefixes - Prefix-to-namespace converter

xpath - XPath expression to compile

Returns:

A compiled XPath expression

Throws:

XPathExpressionException - if the provided expression is invalid, either syntactically or by referencing namespaces unknown to this schema context.

createDocument

@Nonnull
XPathDocument createDocument(@Nonnull
                                      NormalizedNode<?,?> documentRoot)

Create a new document context.

Parameters:

documentRoot - Root node of the document

Returns:

A new XPathDocument on which queries may be executed.

Throws:

IllegalArgumentException - if the document root is not known to this schema context.