X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?a=blobdiff_plain;f=yang%2Fyang-model-util%2Fsrc%2Fmain%2Fjava%2Forg%2Fopendaylight%2Fyangtools%2Fyang%2Fmodel%2Futil%2FSchemaContextUtil.java;h=132edfc347bdb7dd2405aefd755cfc832a118bd9;hb=d1dd191ea54dcd3952cf4e68aa8661fb51d2b99b;hp=14f495058152d09fcac15b1ce5edd490f3003b59;hpb=2d06830514bcdad00d6ee074b5af26d1dc8b0539;p=yangtools.git diff --git a/yang/yang-model-util/src/main/java/org/opendaylight/yangtools/yang/model/util/SchemaContextUtil.java b/yang/yang-model-util/src/main/java/org/opendaylight/yangtools/yang/model/util/SchemaContextUtil.java index 14f4950581..132edfc347 100644 --- a/yang/yang-model-util/src/main/java/org/opendaylight/yangtools/yang/model/util/SchemaContextUtil.java +++ b/yang/yang-model-util/src/main/java/org/opendaylight/yangtools/yang/model/util/SchemaContextUtil.java @@ -7,21 +7,36 @@ */ package org.opendaylight.yangtools.yang.model.util; -import java.net.URI; -import java.util.ArrayList; +import com.google.common.base.Function; +import com.google.common.base.Preconditions; +import com.google.common.base.Splitter; +import com.google.common.collect.Iterables; import java.util.Arrays; -import java.util.Collection; -import java.util.Collections; -import java.util.Date; +import java.util.Iterator; import java.util.LinkedList; import java.util.List; - -import org.opendaylight.yangtools.yang.common.QName; -import org.opendaylight.yangtools.yang.model.api.*; - -import com.google.common.base.Preconditions; - import java.util.Set; +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.model.api.ContainerSchemaNode; +import org.opendaylight.yangtools.yang.model.api.DataSchemaNode; +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; +import org.opendaylight.yangtools.yang.model.api.RevisionAwareXPath; +import org.opendaylight.yangtools.yang.model.api.RpcDefinition; +import org.opendaylight.yangtools.yang.model.api.SchemaContext; +import org.opendaylight.yangtools.yang.model.api.SchemaNode; +import org.opendaylight.yangtools.yang.model.api.SchemaPath; +import org.opendaylight.yangtools.yang.model.api.TypeDefinition; +import org.opendaylight.yangtools.yang.model.api.type.LeafrefTypeDefinition; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; /** * The Schema Context Util contains support methods for searching through Schema @@ -30,7 +45,10 @@ import java.util.Set; * instantiable. * */ -public class SchemaContextUtil { +public final class SchemaContextUtil { + private static final Logger LOG = LoggerFactory.getLogger(SchemaContextUtil.class); + private static final Splitter COLON_SPLITTER = Splitter.on(':'); + private static final Splitter SLASH_SPLITTER = Splitter.on('/'); private SchemaContextUtil() { } @@ -53,14 +71,18 @@ public class SchemaContextUtil { * @return SchemaNode from the end of the Schema Path or null * if the Node is not present. */ - public static SchemaNode findDataSchemaNode(SchemaContext context, SchemaPath schemaPath) { + public static SchemaNode findDataSchemaNode(final SchemaContext context, final SchemaPath schemaPath) { Preconditions.checkArgument(context != null, "Schema Context reference cannot be NULL"); Preconditions.checkArgument(schemaPath != null, "Schema Path reference cannot be NULL"); - List prefixedPath = (schemaPath.getPath()); - if (prefixedPath != null) { - return findNodeInSchemaContext(context, prefixedPath); + + final Iterable prefixedPath = schemaPath.getPathFromRoot(); + if (prefixedPath == null) { + LOG.debug("Schema path {} has null path", schemaPath); + return null; } - return null; + + LOG.trace("Looking for path {} in context {}", schemaPath, context); + return findNodeInSchemaContext(context, prefixedPath); } /** @@ -93,16 +115,14 @@ public class SchemaContextUtil { * Non-conditional Revision Aware XPath, or null if the * DataSchemaNode is not present in Schema Context. */ - public static SchemaNode findDataSchemaNode(SchemaContext context, Module module, RevisionAwareXPath nonCondXPath) { + public static SchemaNode findDataSchemaNode(final SchemaContext context, final Module module, final RevisionAwareXPath nonCondXPath) { Preconditions.checkArgument(context != null, "Schema Context reference cannot be NULL"); 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(); if (strXPath != null) { - if (strXPath.contains("[")) { - throw new IllegalArgumentException("Revision Aware XPath cannot contains condition"); - } + Preconditions.checkArgument(strXPath.indexOf('[') == -1, "Revision Aware XPath may not contain a condition"); if (nonCondXPath.isAbsolute()) { List qnamedPath = xpathToQNamePath(context, module, strXPath); if (qnamedPath != null) { @@ -152,8 +172,8 @@ public class SchemaContextUtil { * given relative Revision Aware XPath, otherwise will return * null. */ - public static SchemaNode findDataSchemaNodeForRelativeXPath(SchemaContext context, Module module, - SchemaNode actualSchemaNode, RevisionAwareXPath relativeXPath) { + public static SchemaNode findDataSchemaNodeForRelativeXPath(final SchemaContext context, final Module module, + final SchemaNode actualSchemaNode, final RevisionAwareXPath relativeXPath) { Preconditions.checkArgument(context != null, "Schema Context reference cannot be NULL"); Preconditions.checkArgument(module != null, "Module reference cannot be NULL"); Preconditions.checkArgument(actualSchemaNode != null, "Actual Schema Node reference cannot be NULL"); @@ -164,7 +184,7 @@ public class SchemaContextUtil { SchemaPath actualNodePath = actualSchemaNode.getPath(); if (actualNodePath != null) { - List qnamePath = resolveRelativeXPath(context, module, relativeXPath, actualSchemaNode); + Iterable qnamePath = resolveRelativeXPath(context, module, relativeXPath, actualSchemaNode); if (qnamePath != null) { return findNodeInSchemaContext(context, qnamePath); @@ -190,167 +210,214 @@ public class SchemaContextUtil { * Schema Node is NOT present, the method will returns * null */ - public static Module findParentModule(SchemaContext context, SchemaNode schemaNode) { + public static Module findParentModule(final SchemaContext context, final SchemaNode schemaNode) { Preconditions.checkArgument(context != null, "Schema Context reference cannot be NULL!"); Preconditions.checkArgument(schemaNode != null, "Schema Node cannot be NULL!"); Preconditions.checkState(schemaNode.getPath() != null, "Schema Path for Schema Node is not " + "set properly (Schema Path is NULL)"); - List qnamedPath = schemaNode.getPath().getPath(); - if (qnamedPath == null || qnamedPath.isEmpty()) { - throw new IllegalStateException("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."); - } - QName qname = qnamedPath.get(qnamedPath.size() - 1); + final QName qname = Iterables.getFirst(schemaNode.getPath().getPathTowardsRoot(), null); + 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."); return context.findModuleByNamespaceAndRevision(qname.getNamespace(), qname.getRevision()); } - public static SchemaNode findNodeInSchemaContext(SchemaContext context, List path) { - QName current = path.get(0); - Module module = context.findModuleByNamespaceAndRevision(current.getNamespace(), current.getRevision()); - if (module == null) + public static SchemaNode findNodeInSchemaContext(final SchemaContext context, final Iterable path) { + final QName current = path.iterator().next(); + + LOG.trace("Looking up module {} in context {}", current, path); + final Module module = context.findModuleByNamespaceAndRevision(current.getNamespace(), current.getRevision()); + if (module == null) { + LOG.debug("Module {} not found", current); return null; + } + return findNodeInModule(module, path); } - public static GroupingDefinition findGrouping(SchemaContext context, Module module, List path) { - QName first = path.get(0); - Module m = context.findModuleByNamespace(first.getNamespace()).iterator().next(); - DataNodeContainer currentParent = m; - for (QName qname : path) { - boolean found = false; - DataNodeContainer node = (DataNodeContainer) currentParent.getDataChildByName(qname.getLocalName()); - if (node == null) { - Set groupings = currentParent.getGroupings(); - for (GroupingDefinition gr : groupings) { - if (gr.getQName().getLocalName().equals(qname.getLocalName())) { - currentParent = gr; - found = true; - } - } - } else { - found = true; - currentParent = node; + private static SchemaNode findNodeInModule(final Module module, final Iterable path) { + final QName current = path.iterator().next(); + + LOG.trace("Looking for data container {} in module {}", current, module); + SchemaNode parent = module.getDataChildByName(current); + if (parent != null) { + final SchemaNode ret = findNode((DataSchemaNode) parent, nextLevel(path)); + if (ret != null) { + return ret; } - if (!found) { - throw new IllegalArgumentException("Failed to find referenced grouping: " + path + "(" - + qname.getLocalName() + ")"); + } + + LOG.trace("Looking for RPC {} in module {}", current, module); + parent = getRpcByName(module, current); + if (parent != null) { + final SchemaNode ret = findNodeInRpc((RpcDefinition) parent, nextLevel(path)); + if (ret != null) { + return ret; } } - return (GroupingDefinition) currentParent; - } + LOG.trace("Looking for notification {} in module {}", current, module); + parent = getNotificationByName(module, current); + if (parent != null) { + final SchemaNode ret = findNodeInNotification((NotificationDefinition) parent, nextLevel(path)); + if (ret != null) { + return ret; + } + } - private static SchemaNode findNodeInModule(Module module, List path) { - QName current = path.get(0); - SchemaNode node = module.getDataChildByName(current); - if (node != null) - return findNode((DataSchemaNode) node, nextLevel(path)); - node = getRpcByName(module, current); - if (node != null) - return findNodeInRpc((RpcDefinition) node, nextLevel(path)); - node = getNotificationByName(module, current); - if (node != null) - return findNodeInNotification((NotificationDefinition) node, nextLevel(path)); - node = getGroupingByName(module, current); - if (node != null) - return findNodeInGrouping((GroupingDefinition) node, nextLevel(path)); - return node; + LOG.trace("Looking for grouping {} in module {}", current, module); + parent = getGroupingByName(module, current); + if (parent != null) { + final SchemaNode ret = findNodeInGrouping((GroupingDefinition) parent, nextLevel(path)); + if (ret != null) { + return ret; + } + } + + LOG.debug("No node matching {} found in module {}", path, module); + return null; } - private static SchemaNode findNodeInGrouping(GroupingDefinition grouping, List path) { - if (path.isEmpty()) + private static SchemaNode findNodeInGrouping( + final GroupingDefinition grouping, final Iterable path) { + final QName current = Iterables.getFirst(path, null); + if (current == null) { + LOG.debug("Found grouping {}", grouping); return grouping; - QName current = path.get(0); - DataSchemaNode node = grouping.getDataChildByName(current); + } + + LOG.trace("Looking for path {} in grouping {}", path, grouping); + final DataSchemaNode node = grouping.getDataChildByName(current); + if (node != null) return findNode(node, nextLevel(path)); + + for (GroupingDefinition groupingDefinition : grouping.getGroupings()) { + if (groupingDefinition.getQName().equals(current)) + return findNodeInGrouping(groupingDefinition, nextLevel(path)); + } + + LOG.debug("No node matching {} found in grouping {}", current, grouping); return null; } - private static SchemaNode findNodeInRpc(RpcDefinition rpc, List path) { - if (path.isEmpty()) + private static SchemaNode findNodeInRpc(final RpcDefinition rpc, final Iterable path) { + final QName current = Iterables.getFirst(path, null); + if (current == null) { + LOG.debug("Found RPC {}", rpc); return rpc; - QName current = path.get(0); + } + + LOG.trace("Looking for path {} in rpc {}", path, rpc); switch (current.getLocalName()) { case "input": return findNode(rpc.getInput(), nextLevel(path)); case "output": return findNode(rpc.getOutput(), nextLevel(path)); + default: + LOG.debug("Invalid component {} of path {} in RPC {}", current, path, rpc); + return null; } - return null; } - private static SchemaNode findNodeInNotification(NotificationDefinition rpc, List path) { - if (path.isEmpty()) - return rpc; - QName current = path.get(0); - DataSchemaNode node = rpc.getDataChildByName(current); - if (node != null) - return findNode(node, nextLevel(path)); - return null; + private static SchemaNode findNodeInNotification(final NotificationDefinition ntf, final Iterable path) { + final QName current = Iterables.getFirst(path, null); + if (current == null) { + LOG.debug("Found notification {}", ntf); + return ntf; + } + + LOG.trace("Looking for path {} in notification {}", path, ntf); + DataSchemaNode node = ntf.getDataChildByName(current); + if (node == null) { + LOG.debug("No node matching {} found in notification {}", current, ntf); + return null; + } + + return findNode(node, nextLevel(path)); } - private static SchemaNode findNode(ChoiceNode parent, List path) { - if (path.isEmpty()) + private static SchemaNode findNode(final ChoiceNode parent, final Iterable path) { + final QName current = Iterables.getFirst(path, null); + if (current == null) { return parent; - QName current = path.get(0); + } ChoiceCaseNode node = parent.getCaseNodeByName(current); - if (node != null) + if (node != null) { return findNodeInCase(node, nextLevel(path)); + } return null; } - private static SchemaNode findNode(ContainerSchemaNode parent, List path) { - if (path.isEmpty()) + private static SchemaNode findNode(final ContainerSchemaNode parent, final Iterable path) { + final QName current = Iterables.getFirst(path, null); + if (current == null) { return parent; - QName current = path.get(0); - DataSchemaNode node = parent.getDataChildByName(current); - if (node != null) - return findNode(node, nextLevel(path)); - return null; + } + + final DataSchemaNode node = parent.getDataChildByName(current); + if (node == null) { + LOG.debug("Failed to find {} in parent {}", path, parent); + return null; + } + + return findNode(node, nextLevel(path)); } - private static SchemaNode findNode(ListSchemaNode parent, List path) { - if (path.isEmpty()) + private static SchemaNode findNode(final ListSchemaNode parent, final Iterable path) { + final QName current = Iterables.getFirst(path, null); + if (current == null) { return parent; - QName current = path.get(0); + } + DataSchemaNode node = parent.getDataChildByName(current); - if (node != null) - return findNode(node, nextLevel(path)); - return null; + if (node == null) { + LOG.debug("Failed to find {} in parent {}", path, parent); + return null; + } + return findNode(node, nextLevel(path)); } - private static SchemaNode findNode(DataSchemaNode parent, List path) { - SchemaNode result = null; - if (path.isEmpty()) { - result = parent; - } else { + private static SchemaNode findNode(final DataSchemaNode parent, final Iterable path) { + final SchemaNode node; + if (!Iterables.isEmpty(path)) { if (parent instanceof ContainerSchemaNode) { - result = findNode((ContainerSchemaNode) parent, path); + node = findNode((ContainerSchemaNode) parent, path); } else if (parent instanceof ListSchemaNode) { - result = findNode((ListSchemaNode) parent, path); + node = findNode((ListSchemaNode) parent, path); } else if (parent instanceof ChoiceNode) { - result = findNode((ChoiceNode) parent, path); + node = findNode((ChoiceNode) parent, path); } else { - throw new IllegalArgumentException("Path nesting violation"); + throw new IllegalArgumentException( + String.format("Path nesting violation in parent %s path %s", parent, path)); } + } else { + node = parent; } - return result; + + if (node == null) { + LOG.debug("Failed to find {} in parent {}", path, parent); + return null; + } + return node; } - public static SchemaNode findNodeInCase(ChoiceCaseNode parent, List path) { - if (path.isEmpty()) + private static SchemaNode findNodeInCase(final ChoiceCaseNode parent, final Iterable path) { + final QName current = Iterables.getFirst(path, null); + if (current == null) { return parent; - QName current = path.get(0); + } + DataSchemaNode node = parent.getDataChildByName(current); - if (node != null) - return findNode(node, nextLevel(path)); - return null; + if (node == null) { + LOG.debug("Failed to find {} in parent {}", path, parent); + return null; + } + return findNode(node, nextLevel(path)); } - public static RpcDefinition getRpcByName(Module module, QName name) { + private static RpcDefinition getRpcByName(final Module module, final QName name) { for (RpcDefinition rpc : module.getRpcs()) { if (rpc.getQName().equals(name)) { return rpc; @@ -359,11 +426,11 @@ public class SchemaContextUtil { return null; } - private static List nextLevel(List path) { - return path.subList(1, path.size()); + private static Iterable nextLevel(final Iterable path) { + return Iterables.skip(path, 1); } - public static NotificationDefinition getNotificationByName(Module module, QName name) { + private static NotificationDefinition getNotificationByName(final Module module, final QName name) { for (NotificationDefinition notification : module.getNotifications()) { if (notification.getQName().equals(name)) { return notification; @@ -372,7 +439,7 @@ public class SchemaContextUtil { return null; } - public static GroupingDefinition getGroupingByName(Module module, QName name) { + private static GroupingDefinition getGroupingByName(final Module module, final QName name) { for (GroupingDefinition grouping : module.getGroupings()) { if (grouping.getQName().equals(name)) { return grouping; @@ -381,244 +448,6 @@ public class SchemaContextUtil { return null; } - /** - * Utility method which search for original node defined in grouping. - * - * @param node - * @return - */ - public static DataSchemaNode findOriginal(DataSchemaNode node, SchemaContext ctx) { - DataSchemaNode result = findCorrectTargetFromGrouping(node, ctx); - if (result == null) { - result = findCorrectTargetFromAugment(node, ctx); - if (result != null) { - if (result.isAddedByUses()) { - result = findOriginal(result, ctx); - } - } - } - return result; - } - - private static DataSchemaNode findCorrectTargetFromGrouping(DataSchemaNode node, SchemaContext ctx) { - if (node.getPath().getPath().size() == 1) { - // uses is under module statement - Module m = findParentModule(ctx, node); - DataSchemaNode result = null; - for (UsesNode u : m.getUses()) { - SchemaNode targetGrouping = findNodeInSchemaContext(ctx, u.getGroupingPath().getPath()); - if (!(targetGrouping instanceof GroupingDefinition)) { - throw new IllegalArgumentException("Failed to generate code for augment in " + u); - } - GroupingDefinition gr = (GroupingDefinition) targetGrouping; - result = gr.getDataChildByName(node.getQName().getLocalName()); - } - if (result == null) { - throw new IllegalArgumentException("Failed to generate code for augment"); - } - return result; - } else { - DataSchemaNode result = null; - QName currentName = node.getQName(); - List tmpPath = new ArrayList<>(); - Object parent = null; - - SchemaPath sp = node.getPath(); - List names = sp.getPath(); - List newNames = new ArrayList<>(names); - newNames.remove(newNames.size() - 1); - SchemaPath newSp = new SchemaPath(newNames, sp.isAbsolute()); - parent = findDataSchemaNode(ctx, newSp); - - do { - tmpPath.add(currentName); - if (parent instanceof DataNodeContainer) { - DataNodeContainer dataNodeParent = (DataNodeContainer) parent; - for (UsesNode u : dataNodeParent.getUses()) { - if (result == null) { - result = getResultFromUses(u, currentName.getLocalName(), ctx); - } - } - } - if (result == null) { - currentName = ((SchemaNode) parent).getQName(); - if (parent instanceof SchemaNode) { - SchemaPath nodeSp = ((SchemaNode) parent).getPath(); - List nodeNames = nodeSp.getPath(); - List nodeNewNames = new ArrayList<>(nodeNames); - nodeNewNames.remove(nodeNewNames.size() - 1); - if (nodeNewNames.isEmpty()) { - parent = getParentModule((SchemaNode) parent, ctx); - } else { - SchemaPath nodeNewSp = new SchemaPath(nodeNewNames, nodeSp.isAbsolute()); - parent = findDataSchemaNode(ctx, nodeNewSp); - } - } else { - throw new IllegalArgumentException("Failed to generate code for augment"); - } - } - } while (result == null && !(parent instanceof Module)); - - if (result != null) { - result = getTargetNode(tmpPath, result, ctx); - } - return result; - } - } - - private static DataSchemaNode findCorrectTargetFromAugment(DataSchemaNode node, SchemaContext ctx) { - if (!node.isAugmenting()) { - return null; - } - - QName currentName = node.getQName(); - Object currentNode = node; - Object parent = node; - List tmpPath = new ArrayList(); - List tmpTree = new ArrayList(); - - AugmentationSchema augment = null; - do { - SchemaPath sp = ((SchemaNode) parent).getPath(); - List names = sp.getPath(); - List newNames = new ArrayList<>(names); - newNames.remove(newNames.size() - 1); - SchemaPath newSp = new SchemaPath(newNames, sp.isAbsolute()); - parent = findDataSchemaNode(ctx, newSp); - if (parent instanceof AugmentationTarget) { - tmpPath.add(currentName); - tmpTree.add((SchemaNode) currentNode); - augment = findNodeInAugment(((AugmentationTarget) parent).getAvailableAugmentations(), currentName); - if (augment == null) { - currentName = ((DataSchemaNode) parent).getQName(); - currentNode = parent; - } - } - } while (((DataSchemaNode) parent).isAugmenting() && augment == null); - - if (augment == null) { - return null; - } else { - Collections.reverse(tmpPath); - Collections.reverse(tmpTree); - Object actualParent = augment; - DataSchemaNode result = null; - for (QName name : tmpPath) { - if (actualParent instanceof DataNodeContainer) { - result = ((DataNodeContainer) actualParent).getDataChildByName(name.getLocalName()); - actualParent = ((DataNodeContainer) actualParent).getDataChildByName(name.getLocalName()); - } else { - if (actualParent instanceof ChoiceNode) { - result = ((ChoiceNode) actualParent).getCaseNodeByName(name.getLocalName()); - actualParent = ((ChoiceNode) actualParent).getCaseNodeByName(name.getLocalName()); - } - } - } - - if (result.isAddedByUses()) { - result = findCorrectTargetFromAugmentGrouping(result, augment, tmpTree, ctx); - } - - return result; - } - } - - private static DataSchemaNode getResultFromUses(UsesNode u, String currentName, SchemaContext ctx) { - SchemaNode targetGrouping = findNodeInSchemaContext(ctx, u.getGroupingPath().getPath()); - if (!(targetGrouping instanceof GroupingDefinition)) { - throw new IllegalArgumentException("Failed to generate code for augment in " + u); - } - GroupingDefinition gr = (GroupingDefinition) targetGrouping; - return gr.getDataChildByName(currentName); - } - - private static Module getParentModule(SchemaNode node, SchemaContext ctx) { - QName qname = node.getPath().getPath().get(0); - URI namespace = qname.getNamespace(); - Date revision = qname.getRevision(); - return ctx.findModuleByNamespaceAndRevision(namespace, revision); - } - - private static DataSchemaNode getTargetNode(List tmpPath, DataSchemaNode node, SchemaContext ctx) { - DataSchemaNode result = node; - if (tmpPath.size() == 1) { - if (result != null && result.isAddedByUses()) { - result = findOriginal(result, ctx); - } - return result; - } else { - DataSchemaNode newParent = result; - Collections.reverse(tmpPath); - - tmpPath.remove(0); - for (QName name : tmpPath) { - // searching by local name is must, because node has different - // namespace in its original location - if (newParent == null) { - break; - } - if (newParent instanceof DataNodeContainer) { - newParent = ((DataNodeContainer) newParent).getDataChildByName(name.getLocalName()); - } else { - newParent = ((ChoiceNode) newParent).getCaseNodeByName(name.getLocalName()); - } - } - if (newParent != null && newParent.isAddedByUses()) { - newParent = findOriginal(newParent, ctx); - } - return newParent; - } - } - - private static AugmentationSchema findNodeInAugment(Collection augments, QName name) { - for (AugmentationSchema augment : augments) { - DataSchemaNode node = augment.getDataChildByName(name); - if (node != null) { - return augment; - } - } - return null; - } - - private static DataSchemaNode findCorrectTargetFromAugmentGrouping(DataSchemaNode node, - AugmentationSchema parentNode, List dataTree, SchemaContext ctx) { - - DataSchemaNode result = null; - QName currentName = node.getQName(); - List tmpPath = new ArrayList<>(); - tmpPath.add(currentName); - int i = 1; - Object parent = null; - - do { - if (dataTree.size() < 2 || dataTree.size() == i) { - parent = parentNode; - } else { - parent = dataTree.get(dataTree.size() - (i + 1)); - tmpPath.add(((SchemaNode) parent).getQName()); - } - - if (parent instanceof DataNodeContainer) { - DataNodeContainer dataNodeParent = (DataNodeContainer) parent; - for (UsesNode u : dataNodeParent.getUses()) { - if (result == null) { - result = getResultFromUses(u, currentName.getLocalName(), ctx); - } - } - } - - if (result == null) { - i = i + 1; - currentName = ((SchemaNode) parent).getQName(); - } - } while (result == null); - - if (result != null) { - result = getTargetNode(tmpPath, result, ctx); - } - return result; - } - /** * Transforms string representation of XPath to Queue of QNames. The XPath * is split by "/" and for each part of XPath is assigned correct module in @@ -636,14 +465,13 @@ public class SchemaContextUtil { * XPath String * @return return a list of QName */ - private static List xpathToQNamePath(SchemaContext context, Module parentModule, String xpath) { + private static List xpathToQNamePath(final SchemaContext context, final Module parentModule, final String xpath) { Preconditions.checkArgument(context != null, "Schema Context reference cannot be NULL"); Preconditions.checkArgument(parentModule != null, "Parent Module reference cannot be NULL"); Preconditions.checkArgument(xpath != null, "XPath string reference cannot be NULL"); List path = new LinkedList(); - String[] prefixedPath = xpath.split("/"); - for (String pathComponent : prefixedPath) { + for (String pathComponent : SLASH_SPLITTER.split(xpath)) { if (!pathComponent.isEmpty()) { path.add(stringPathPartToQName(context, parentModule, pathComponent)); } @@ -672,22 +500,22 @@ public class SchemaContextUtil { * Prefixed Path Part string * @return QName from prefixed Path Part String. */ - private static QName stringPathPartToQName(SchemaContext context, Module parentModule, String prefixedPathPart) { + private static QName stringPathPartToQName(final SchemaContext context, final Module parentModule, final String prefixedPathPart) { Preconditions.checkArgument(context != null, "Schema Context reference cannot be NULL"); Preconditions.checkArgument(parentModule != null, "Parent Module reference cannot be NULL"); Preconditions.checkArgument(prefixedPathPart != null, "Prefixed Path Part cannot be NULL!"); - if (prefixedPathPart.contains(":")) { - String[] prefixedName = prefixedPathPart.split(":"); - Module module = resolveModuleForPrefix(context, parentModule, prefixedName[0]); - if (module == null) { - throw new IllegalArgumentException("Failed to resolve xpath: no module found for prefix " - + prefixedName[0] + " in module " + parentModule.getName()); - } else { - return new QName(module.getNamespace(), module.getRevision(), prefixedName[1]); - } + if (prefixedPathPart.indexOf(':') != -1) { + final Iterator prefixedName = COLON_SPLITTER.split(prefixedPathPart).iterator(); + final String modulePrefix = prefixedName.next(); + + 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 QName.create(module.getQNameModule(), prefixedName.next()); } else { - return new QName(parentModule.getNamespace(), parentModule.getRevision(), prefixedPathPart); + return QName.create(parentModule.getNamespace(), parentModule.getRevision(), prefixedPathPart); } } @@ -715,7 +543,7 @@ public class SchemaContextUtil { * @return Module for given prefix in specified Schema Context if is * present, otherwise returns null */ - private static Module resolveModuleForPrefix(SchemaContext context, Module module, String prefix) { + private static Module resolveModuleForPrefix(final SchemaContext context, final Module module, final String prefix) { Preconditions.checkArgument(context != null, "Schema Context reference cannot be NULL"); Preconditions.checkArgument(module != null, "Module reference cannot be NULL"); Preconditions.checkArgument(prefix != null, "Prefix string cannot be NULL"); @@ -742,42 +570,148 @@ public class SchemaContextUtil { * Yang Module * @param relativeXPath * Non conditional Revision Aware Relative XPath - * @param leafrefSchemaPath - * Schema Path for Leafref + * @param actualSchemaNode + * actual schema node * @return list of QName */ - private static List resolveRelativeXPath(SchemaContext context, Module module, - RevisionAwareXPath relativeXPath, SchemaNode leafrefParentNode) { + private static Iterable resolveRelativeXPath(final SchemaContext context, final Module module, + final RevisionAwareXPath relativeXPath, final SchemaNode actualSchemaNode) { Preconditions.checkArgument(context != null, "Schema Context reference cannot be NULL"); Preconditions.checkArgument(module != null, "Module reference cannot be NULL"); Preconditions.checkArgument(relativeXPath != null, "Non Conditional Revision Aware XPath cannot be NULL"); Preconditions.checkState(!relativeXPath.isAbsolute(), "Revision Aware XPath MUST be relative i.e. MUST contains ../, " + "for non relative Revision Aware XPath use findDataSchemaNode method"); - Preconditions.checkState(leafrefParentNode.getPath() != null, + Preconditions.checkState(actualSchemaNode.getPath() != null, "Schema Path reference for Leafref cannot be NULL"); - List absolutePath = new LinkedList(); - String strXPath = relativeXPath.toString(); - String[] xpaths = strXPath.split("/"); + final Iterable xpaths = SLASH_SPLITTER.split(relativeXPath.toString()); + // Find out how many "parent" components there are + // FIXME: is .contains() the right check here? + // FIXME: case ../../node1/node2/../node3/../node4 int colCount = 0; - while (xpaths[colCount].contains("..")) { - colCount = colCount + 1; - } - List path = leafrefParentNode.getPath().getPath(); - if (path != null) { - int lenght = path.size() - colCount; - absolutePath.addAll(path.subList(0, lenght)); - List xpathsList = Arrays.asList(xpaths); - List sublistedXPath = xpathsList.subList(colCount, xpaths.length); - List sublist = new ArrayList<>(); - for (String pathPart : sublistedXPath) { - sublist.add(stringPathPartToQName(context, module, pathPart)); - } - absolutePath.addAll(sublist); + for (Iterator it = xpaths.iterator(); it.hasNext() && it.next().contains(".."); ) { + ++colCount; + } + + final Iterable schemaNodePath = actualSchemaNode.getPath().getPathFromRoot(); + + if (Iterables.size(schemaNodePath) - colCount >= 0) { + return Iterables.concat(Iterables.limit(schemaNodePath, Iterables.size(schemaNodePath) - colCount), + Iterables.transform(Iterables.skip(xpaths, colCount), new Function() { + @Override + public QName apply(final String input) { + return stringPathPartToQName(context, module, input); + } + })); } + return Iterables.concat(schemaNodePath, + Iterables.transform(Iterables.skip(xpaths, colCount), new Function() { + @Override + public QName apply(final String input) { + return stringPathPartToQName(context, module, input); + } + })); + } + + /** + * Extracts the base type of node on which schema node points to. If target node is again of type LeafrefTypeDefinition, methods will be call recursively until it reach concrete + * type definition. + * + * @param typeDefinition + * type of node which will be extracted + * @param schemaContext + * Schema Context + * @param schema + * Schema Node + * @return recursively found type definition this leafref is pointing to or null if the xpath is incorrect (null is there to preserve backwards compatibility) + */ + public static TypeDefinition getBaseTypeForLeafRef(final LeafrefTypeDefinition typeDefinition, final SchemaContext schemaContext, final SchemaNode schema) { + 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); + } else { + dataSchemaNode = (DataSchemaNode) SchemaContextUtil.findDataSchemaNodeForRelativeXPath(schemaContext, parentModule, schema, pathStatement); + } + + // FIXME this is just to preserve backwards compatibility since yangtools do not mind wrong leafref xpaths + // and current expected behaviour for such cases is to just use pure string + // This should throw an exception about incorrect XPath in leafref + if(dataSchemaNode == null) { + return null; + } + + final TypeDefinition targetTypeDefinition = typeDefinition(dataSchemaNode); + + if(targetTypeDefinition instanceof LeafrefTypeDefinition) { + return getBaseTypeForLeafRef(((LeafrefTypeDefinition) targetTypeDefinition), schemaContext, dataSchemaNode); + } else { + return targetTypeDefinition; + } + } - return absolutePath; + /** + * Removes conditions from xPath pointed to target node. + * + * @param pathStatement + * xPath to target node + * @return string representation of xPath without conditions + * + */ + private static String stripConditionsFromXPathString(final RevisionAwareXPath pathStatement) { + return pathStatement.toString().replaceAll("\\[.*\\]", ""); + } + + /** + * Extracts the base type of leaf schema node until it reach concrete type of TypeDefinition. + * + * @param node + * a node representing LeafSchemaNode + * @return concrete type definition of node value + */ + private static TypeDefinition typeDefinition(final LeafSchemaNode node) { + TypeDefinition baseType = node.getType(); + while (baseType.getBaseType() != null) { + baseType = baseType.getBaseType(); + } + return baseType; + } + + /** + * Extracts the base type of leaf schema node until it reach concrete type of TypeDefinition. + * + * @param node + * a node representing LeafListSchemaNode + * @return concrete type definition of node value + */ + private static TypeDefinition typeDefinition(final LeafListSchemaNode node) { + TypeDefinition baseType = node.getType(); + while (baseType.getBaseType() != null) { + baseType = baseType.getBaseType(); + } + return baseType; + } + + /** + * Gets the base type of DataSchemaNode value. + * + * @param node + * a node representing DataSchemaNode + * @return concrete type definition of node value + */ + private static TypeDefinition typeDefinition(final DataSchemaNode node) { + if (node instanceof LeafListSchemaNode) { + return typeDefinition((LeafListSchemaNode) node); + } else if (node instanceof LeafSchemaNode) { + return typeDefinition((LeafSchemaNode) node); + } else { + throw new IllegalArgumentException("Unhandled parameter types: " + Arrays. asList(node).toString()); + } } }