*/
package org.opendaylight.yangtools.yang.model.util;
+import com.google.common.annotations.Beta;
import com.google.common.base.Function;
+import com.google.common.base.Optional;
import com.google.common.base.Preconditions;
import com.google.common.base.Splitter;
import com.google.common.collect.Iterables;
import java.util.LinkedList;
import java.util.List;
import java.util.Set;
-
+import java.util.regex.Pattern;
+import javax.annotation.Nonnull;
+import javax.annotation.Nullable;
import org.opendaylight.yangtools.yang.common.QName;
-import org.opendaylight.yangtools.yang.model.api.ChoiceCaseNode;
-import org.opendaylight.yangtools.yang.model.api.ChoiceNode;
+import org.opendaylight.yangtools.yang.common.QNameModule;
+import org.opendaylight.yangtools.yang.model.api.ChoiceSchemaNode;
import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode;
import org.opendaylight.yangtools.yang.model.api.DataNodeContainer;
import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
+import org.opendaylight.yangtools.yang.model.api.DerivableSchemaNode;
import org.opendaylight.yangtools.yang.model.api.GroupingDefinition;
import org.opendaylight.yangtools.yang.model.api.LeafListSchemaNode;
import org.opendaylight.yangtools.yang.model.api.LeafSchemaNode;
-import org.opendaylight.yangtools.yang.model.api.ListSchemaNode;
import org.opendaylight.yangtools.yang.model.api.Module;
import org.opendaylight.yangtools.yang.model.api.ModuleImport;
import org.opendaylight.yangtools.yang.model.api.NotificationDefinition;
Preconditions.checkArgument(module != null, "Module reference cannot be NULL");
Preconditions.checkArgument(nonCondXPath != null, "Non Conditional Revision Aware XPath cannot be NULL");
- String strXPath = nonCondXPath.toString();
+ final String strXPath = nonCondXPath.toString();
if (strXPath != null) {
Preconditions.checkArgument(strXPath.indexOf('[') == -1, "Revision Aware XPath may not contain a condition");
if (nonCondXPath.isAbsolute()) {
- List<QName> qnamedPath = xpathToQNamePath(context, module, strXPath);
+ final List<QName> qnamedPath = xpathToQNamePath(context, module, strXPath);
if (qnamedPath != null) {
return findNodeInSchemaContext(context, qnamedPath);
}
"Revision Aware XPath MUST be relative i.e. MUST contains ../, "
+ "for non relative Revision Aware XPath use findDataSchemaNode method");
- SchemaPath actualNodePath = actualSchemaNode.getPath();
+ final SchemaPath actualNodePath = actualSchemaNode.getPath();
if (actualNodePath != null) {
- Iterable<QName> qnamePath = resolveRelativeXPath(context, module, relativeXPath, actualSchemaNode);
+ final Iterable<QName> qnamePath = resolveRelativeXPath(context, module, relativeXPath, actualSchemaNode);
if (qnamePath != null) {
return findNodeInSchemaContext(context, qnamePath);
Preconditions.checkState(schemaNode.getPath() != null, "Schema Path for Schema Node is not "
+ "set properly (Schema Path is NULL)");
- final QName qname = Iterables.getFirst(schemaNode.getPath().getPathTowardsRoot(), null);
+ final QName qname = schemaNode.getPath().getLastComponent();
Preconditions.checkState(qname != null,
"Schema Path contains invalid state of path parts. " +
- "The Schema Path MUST contain at least ONE QName which defines namespace and Local name of path.");
+ "The Schema Path MUST contain at least ONE QName which defines namespace and Local name of path.");
return context.findModuleByNamespaceAndRevision(qname.getNamespace(), qname.getRevision());
}
return findNodeInModule(module, path);
}
- private static SchemaNode findNodeInModule(Module module, Iterable<QName> path) {
+ /**
+ * Returns NotificationDefinition from Schema Context
+ *
+ * @param schema SchemaContext in which lookup should be performed.
+ * @param path Schema Path of notification
+ * @return Notification schema or null, if notification is not present in schema context.
+ */
+ @Beta
+ @Nullable public static NotificationDefinition getNotificationSchema(@Nonnull final SchemaContext schema, @Nonnull final SchemaPath path) {
+ Preconditions.checkNotNull(schema, "Schema context must not be null.");
+ Preconditions.checkNotNull(path, "Schema path must not be null.");
+ for (final NotificationDefinition potential : schema.getNotifications()) {
+ if (path.equals(potential.getPath())) {
+ return potential;
+ }
+ }
+ return null;
+ }
+
+ /**
+ * Returns RPC Input or Output Data container from RPC definition.
+ *
+ * @param schema SchemaContext in which lookup should be performed.
+ * @param path Schema path of RPC input/output data container
+ * @return Notification schema or null, if notification is not present in schema context.
+ */
+ @Beta
+ @Nullable public static ContainerSchemaNode getRpcDataSchema(@Nonnull final SchemaContext schema, @Nonnull final SchemaPath path) {
+ Preconditions.checkNotNull(schema, "Schema context must not be null.");
+ Preconditions.checkNotNull(path, "Schema path must not be null.");
+ final Iterator<QName> it = path.getPathFromRoot().iterator();
+ Preconditions.checkArgument(it.hasNext(), "Rpc must have QName.");
+ final QName rpcName = it.next();
+ Preconditions.checkArgument(it.hasNext(), "input or output must be part of path.");
+ final QName inOrOut = it.next();
+ for (final RpcDefinition potential : schema.getOperations()) {
+ if (rpcName.equals(potential.getQName())) {
+ return SchemaNodeUtils.getRpcDataSchema(potential, inOrOut);
+ }
+ }
+ return null;
+ }
+
+ private static SchemaNode findNodeInModule(final Module module, final Iterable<QName> path) {
Preconditions.checkArgument(module != null, "Parent reference cannot be NULL");
Preconditions.checkArgument(path != null, "Path reference cannot be NULL");
return null;
}
- QName current = path.iterator().next();
+ final QName current = path.iterator().next();
LOG.trace("Looking for node {} in module {}", current, module);
SchemaNode foundNode = null;
- Iterable<QName> nextPath = nextLevel(path);
+ final Iterable<QName> nextPath = nextLevel(path);
foundNode = module.getDataChildByName(current);
- if (foundNode != null && nextPath.iterator().hasNext())
+ if (foundNode != null && nextPath.iterator().hasNext()) {
foundNode = findNodeIn(foundNode, nextPath);
+ }
if (foundNode == null) {
foundNode = getGroupingByName(module, current);
- if (foundNode != null && nextPath.iterator().hasNext())
+ if (foundNode != null && nextPath.iterator().hasNext()) {
foundNode = findNodeIn(foundNode, nextPath);
+ }
}
if (foundNode == null) {
foundNode = getRpcByName(module, current);
- if (foundNode != null && nextPath.iterator().hasNext())
+ if (foundNode != null && nextPath.iterator().hasNext()) {
foundNode = findNodeIn(foundNode, nextPath);
+ }
}
if (foundNode == null) {
foundNode = getNotificationByName(module, current);
- if (foundNode != null && nextPath.iterator().hasNext())
+ if (foundNode != null && nextPath.iterator().hasNext()) {
foundNode = findNodeIn(foundNode, nextPath);
+ }
}
- if (foundNode == null)
+ if (foundNode == null) {
LOG.debug("No node matching {} found in node {}", path, module);
+ }
return foundNode;
}
- private static SchemaNode findNodeIn(SchemaNode parent, Iterable<QName> path) {
+ private static SchemaNode findNodeIn(final SchemaNode parent, final Iterable<QName> path) {
Preconditions.checkArgument(parent != null, "Parent reference cannot be NULL");
Preconditions.checkArgument(path != null, "Path reference cannot be NULL");
return null;
}
- QName current = path.iterator().next();
+ final QName current = path.iterator().next();
LOG.trace("Looking for node {} in node {}", current, parent);
SchemaNode foundNode = null;
- Iterable<QName> nextPath = nextLevel(path);
+ final Iterable<QName> nextPath = nextLevel(path);
if (parent instanceof DataNodeContainer) {
- DataNodeContainer parentDataNodeContainer = (DataNodeContainer) parent;
+ final DataNodeContainer parentDataNodeContainer = (DataNodeContainer) parent;
foundNode = parentDataNodeContainer.getDataChildByName(current);
- if (foundNode != null && nextPath.iterator().hasNext())
+ if (foundNode != null && nextPath.iterator().hasNext()) {
foundNode = findNodeIn(foundNode, nextPath);
+ }
if (foundNode == null) {
foundNode = getGroupingByName(parentDataNodeContainer, current);
- if (foundNode != null && nextPath.iterator().hasNext())
+ if (foundNode != null && nextPath.iterator().hasNext()) {
foundNode = findNodeIn(foundNode, nextPath);
+ }
}
}
if (foundNode == null && parent instanceof RpcDefinition) {
- RpcDefinition parentRpcDefinition = (RpcDefinition) parent;
+ final RpcDefinition parentRpcDefinition = (RpcDefinition) parent;
if (current.getLocalName().equals("input")) {
foundNode = parentRpcDefinition.getInput();
- if (foundNode != null && nextPath.iterator().hasNext())
+ if (foundNode != null && nextPath.iterator().hasNext()) {
foundNode = findNodeIn(foundNode, nextPath);
+ }
}
if (current.getLocalName().equals("output")) {
foundNode = parentRpcDefinition.getOutput();
- if (foundNode != null && nextPath.iterator().hasNext())
+ if (foundNode != null && nextPath.iterator().hasNext()) {
foundNode = findNodeIn(foundNode, nextPath);
+ }
}
if (foundNode == null) {
foundNode = getGroupingByName(parentRpcDefinition, current);
- if (foundNode != null && nextPath.iterator().hasNext())
+ if (foundNode != null && nextPath.iterator().hasNext()) {
foundNode = findNodeIn(foundNode, nextPath);
+ }
}
}
- if (foundNode == null && parent instanceof ChoiceNode) {
- foundNode = ((ChoiceNode) parent).getCaseNodeByName(current);
- if (foundNode != null && nextPath.iterator().hasNext())
+ if (foundNode == null && parent instanceof ChoiceSchemaNode) {
+ foundNode = ((ChoiceSchemaNode) parent).getCaseNodeByName(current);
+ if (foundNode != null && nextPath.iterator().hasNext()) {
foundNode = findNodeIn(foundNode, nextPath);
+ }
}
- if (foundNode == null)
+ if (foundNode == null) {
LOG.debug("No node matching {} found in node {}", path, parent);
+ }
return foundNode;
}
private static RpcDefinition getRpcByName(final Module module, final QName name) {
- for (RpcDefinition rpc : module.getRpcs()) {
+ for (final RpcDefinition rpc : module.getRpcs()) {
if (rpc.getQName().equals(name)) {
return rpc;
}
}
private static NotificationDefinition getNotificationByName(final Module module, final QName name) {
- for (NotificationDefinition notification : module.getNotifications()) {
+ for (final NotificationDefinition notification : module.getNotifications()) {
if (notification.getQName().equals(name)) {
return notification;
}
}
private static GroupingDefinition getGroupingByName(final DataNodeContainer dataNodeContainer, final QName name) {
- for (GroupingDefinition grouping : dataNodeContainer.getGroupings()) {
+ for (final GroupingDefinition grouping : dataNodeContainer.getGroupings()) {
if (grouping.getQName().equals(name)) {
return grouping;
}
}
private static GroupingDefinition getGroupingByName(final RpcDefinition rpc, final QName name) {
- for (GroupingDefinition grouping : rpc.getGroupings()) {
+ for (final GroupingDefinition grouping : rpc.getGroupings()) {
if (grouping.getQName().equals(name)) {
return grouping;
}
Preconditions.checkArgument(parentModule != null, "Parent Module reference cannot be NULL");
Preconditions.checkArgument(xpath != null, "XPath string reference cannot be NULL");
- List<QName> path = new LinkedList<QName>();
- for (String pathComponent : SLASH_SPLITTER.split(xpath)) {
+ final List<QName> path = new LinkedList<QName>();
+ for (final String pathComponent : SLASH_SPLITTER.split(xpath)) {
if (!pathComponent.isEmpty()) {
path.add(stringPathPartToQName(context, parentModule, pathComponent));
}
final Iterator<String> prefixedName = COLON_SPLITTER.split(prefixedPathPart).iterator();
final String modulePrefix = prefixedName.next();
- Module module = resolveModuleForPrefix(context, parentModule, modulePrefix);
+ final Module module = resolveModuleForPrefix(context, parentModule, modulePrefix);
Preconditions.checkArgument(module != null, "Failed to resolve xpath: no module found for prefix %s in module %s",
modulePrefix, parentModule.getName());
return module;
}
- Set<ModuleImport> imports = module.getImports();
- for (ModuleImport mi : imports) {
+ final Set<ModuleImport> imports = module.getImports();
+ for (final ModuleImport mi : imports) {
if (prefix.equals(mi.getPrefix())) {
return context.findModuleByName(mi.getModuleName(), mi.getRevision());
}
// FIXME: is .contains() the right check here?
// FIXME: case ../../node1/node2/../node3/../node4
int colCount = 0;
- for (Iterator<String> it = xpaths.iterator(); it.hasNext() && it.next().contains(".."); ) {
+ for (final Iterator<String> it = xpaths.iterator(); it.hasNext() && it.next().contains(".."); ) {
++colCount;
}
RevisionAwareXPath pathStatement = typeDefinition.getPathStatement();
pathStatement = new RevisionAwareXPathImpl(stripConditionsFromXPathString(pathStatement), pathStatement.isAbsolute());
- final Module parentModule = SchemaContextUtil.findParentModule(schemaContext, schema);
-
final DataSchemaNode dataSchemaNode;
- if(pathStatement.isAbsolute()) {
- dataSchemaNode = (DataSchemaNode) SchemaContextUtil.findDataSchemaNode(schemaContext, parentModule, pathStatement);
+ if (pathStatement.isAbsolute()) {
+ SchemaNode baseSchema = schema;
+ while (baseSchema instanceof DerivableSchemaNode) {
+ final Optional<? extends SchemaNode> basePotential = ((DerivableSchemaNode) baseSchema).getOriginal();
+ if (basePotential.isPresent()) {
+ baseSchema = basePotential.get();
+ } else {
+ break;
+ }
+ }
+
+ Module parentModule = findParentModuleOfReferencingType(schemaContext, baseSchema);
+ dataSchemaNode = (DataSchemaNode) SchemaContextUtil.findDataSchemaNode(schemaContext, parentModule,
+ pathStatement);
} else {
- dataSchemaNode = (DataSchemaNode) SchemaContextUtil.findDataSchemaNodeForRelativeXPath(schemaContext, parentModule, schema, pathStatement);
+ Module parentModule = findParentModule(schemaContext, schema);
+ dataSchemaNode = (DataSchemaNode) SchemaContextUtil.findDataSchemaNodeForRelativeXPath(schemaContext,
+ parentModule, schema, pathStatement);
}
// FIXME this is just to preserve backwards compatibility since yangtools do not mind wrong leafref xpaths
}
}
+ private static Module findParentModuleOfReferencingType(final SchemaContext schemaContext,
+ final SchemaNode schemaNode) {
+ Preconditions.checkArgument(schemaContext != null, "Schema Context reference cannot be NULL!");
+ Preconditions.checkArgument(schemaNode != null, "Schema Node cannot be NULL!");
+ TypeDefinition<?> nodeType = null;
+
+ if (schemaNode instanceof LeafSchemaNode) {
+ nodeType = ((LeafSchemaNode) schemaNode).getType();
+ } else if (schemaNode instanceof LeafListSchemaNode) {
+ nodeType = ((LeafListSchemaNode) schemaNode).getType();
+ }
+
+ if (nodeType.getBaseType() != null) {
+ while (nodeType.getBaseType() != null) {
+ nodeType = nodeType.getBaseType();
+ }
+
+ final QNameModule typeDefModuleQname = nodeType.getQName().getModule();
+ return schemaContext.findModuleByNamespaceAndRevision(typeDefModuleQname.getNamespace(),
+ typeDefModuleQname.getRevision());
+ }
+
+ return SchemaContextUtil.findParentModule(schemaContext, schemaNode);
+ }
+
+ /**
+ * @deprecated due to expensive lookup
+ * Returns parent Yang Module for specified Schema Context in which Schema
+ * Node is declared. If Schema Node is of type 'ExtendedType' it tries to find parent module
+ * in which the type was originally declared (needed for correct leafref path resolution). <br>
+ * If the Schema Node is not present in Schema Context the
+ * operation will return <code>null</code>. <br>
+ * If Schema Context or Schema Node contains <code>null</code> references
+ * the method will throw IllegalArgumentException
+ *
+ * @throws IllegalArgumentException
+ *
+ * @param schemaContext
+ * Schema Context
+ * @param schemaNode
+ * Schema Node
+ * @return Yang Module for specified Schema Context and Schema Node, if
+ * Schema Node is NOT present, the method will returns
+ * <code>null</code>
+ */
+ @Deprecated
+ public static Module findParentModuleByType(final SchemaContext schemaContext, final SchemaNode schemaNode) {
+ Preconditions.checkArgument(schemaContext != null, "Schema Context reference cannot be NULL!");
+ Preconditions.checkArgument(schemaNode != null, "Schema Node cannot be NULL!");
+ TypeDefinition<?> nodeType = null;
+
+ if (schemaNode instanceof LeafSchemaNode) {
+ nodeType = ((LeafSchemaNode) schemaNode).getType();
+ } else if (schemaNode instanceof LeafListSchemaNode) {
+ nodeType = ((LeafListSchemaNode) schemaNode).getType();
+ }
+
+ if (!BaseTypes.isYangBuildInType(nodeType) && nodeType.getBaseType() != null) {
+ while (nodeType.getBaseType() != null && !BaseTypes.isYangBuildInType(nodeType.getBaseType())) {
+ nodeType = nodeType.getBaseType();
+ }
+
+ QNameModule typeDefModuleQname = nodeType.getQName().getModule();
+
+ return schemaContext.findModuleByNamespaceAndRevision(typeDefModuleQname.getNamespace(),
+ typeDefModuleQname.getRevision());
+ }
+
+ return SchemaContextUtil.findParentModule(schemaContext, schemaNode);
+ }
+
+ /**
+ * Returns base type for {@code typeDefinition} which belongs to module specified via {@code qName}. This handle case
+ * when leafref type isn't specified as type substatement of leaf or leaf-list but is defined in other module as typedef
+ * which is then imported to referenced module.
+ *
+ * Because {@code typeDefinition} is definied via typedef statement, only absolute path is meaningful.
+ *
+ * @param typeDefinition
+ * @param schemaContext
+ * @param qName
+ * @return
+ */
+ public static TypeDefinition<?> getBaseTypeForLeafRef(final LeafrefTypeDefinition typeDefinition,
+ final SchemaContext schemaContext, final QName qName) {
+ final RevisionAwareXPath pathStatement = typeDefinition.getPathStatement();
+ final RevisionAwareXPath strippedPathStatement = new RevisionAwareXPathImpl(stripConditionsFromXPathString(pathStatement), pathStatement.isAbsolute());
+ if (!strippedPathStatement.isAbsolute()) {
+ return null;
+ }
+
+ final Module parentModule = schemaContext.findModuleByNamespaceAndRevision(qName.getNamespace(),qName.getRevision());
+ final DataSchemaNode dataSchemaNode = (DataSchemaNode) SchemaContextUtil.findDataSchemaNode(schemaContext, parentModule, strippedPathStatement);
+ final TypeDefinition<?> targetTypeDefinition = typeDefinition(dataSchemaNode);
+ if (targetTypeDefinition instanceof LeafrefTypeDefinition) {
+ return getBaseTypeForLeafRef(((LeafrefTypeDefinition) targetTypeDefinition), schemaContext, dataSchemaNode);
+ } else {
+ return targetTypeDefinition;
+ }
+ }
+
+ private static final Pattern STRIP_PATTERN = Pattern.compile("\\[.*\\]");
+
/**
* Removes conditions from xPath pointed to target node.
*
*
*/
private static String stripConditionsFromXPathString(final RevisionAwareXPath pathStatement) {
- return pathStatement.toString().replaceAll("\\[.*\\]", "");
+ return STRIP_PATTERN.matcher(pathStatement.toString()).replaceAll("");
}
/**
Code Review / yangtools.git / blobdiff