From cd184f0a4226f20838c72ac1fdaf6fa19585df3b Mon Sep 17 00:00:00 2001 From: Robert Varga Date: Sat, 28 Jul 2018 10:50:19 +0200 Subject: [PATCH 1/1] Allow DataObjectModification to address grouping nodes This adds the API and implementation required to address child nodes introduced in cases by the use of a grouping. JIRA: MDSAL-342 Change-Id: I70871dcaa3441fbef81dfb15bfd965d133aa0894 Signed-off-by: Robert Varga --- .../listener/DsbenchmarkListener.java | 2 +- .../binding/api/DataObjectModification.java | 62 ++++++++++++++++++- .../impl/LazyDataObjectModification.java | 62 ++++++++++++++----- 3 files changed, 107 insertions(+), 19 deletions(-) diff --git a/benchmark/dsbenchmark/src/main/java/org/opendaylight/dsbenchmark/listener/DsbenchmarkListener.java b/benchmark/dsbenchmark/src/main/java/org/opendaylight/dsbenchmark/listener/DsbenchmarkListener.java index 14633c9ee0..197d93d0fb 100644 --- a/benchmark/dsbenchmark/src/main/java/org/opendaylight/dsbenchmark/listener/DsbenchmarkListener.java +++ b/benchmark/dsbenchmark/src/main/java/org/opendaylight/dsbenchmark/listener/DsbenchmarkListener.java @@ -49,7 +49,7 @@ public class DsbenchmarkListener implements DataTreeChangeListener { final DataObjectModification rootNode = change.getRootNode(); final ModificationType modType = rootNode.getModificationType(); final PathArgument changeId = rootNode.getIdentifier(); - final Collection> modifications = + final Collection> modifications = rootNode.getModifiedChildren(); LOG.debug(" changeId {}, modType {}, mods: {}", changeId, modType, modifications.size()); diff --git a/opendaylight/md-sal/sal-binding-api/src/main/java/org/opendaylight/controller/md/sal/binding/api/DataObjectModification.java b/opendaylight/md-sal/sal-binding-api/src/main/java/org/opendaylight/controller/md/sal/binding/api/DataObjectModification.java index 2df4f8bde0..c43d42c779 100644 --- a/opendaylight/md-sal/sal-binding-api/src/main/java/org/opendaylight/controller/md/sal/binding/api/DataObjectModification.java +++ b/opendaylight/md-sal/sal-binding-api/src/main/java/org/opendaylight/controller/md/sal/binding/api/DataObjectModification.java @@ -8,14 +8,18 @@ package org.opendaylight.controller.md.sal.binding.api; +import com.google.common.collect.Collections2; import java.util.Collection; import javax.annotation.Nonnull; import javax.annotation.Nullable; import org.opendaylight.yangtools.yang.binding.Augmentation; import org.opendaylight.yangtools.yang.binding.ChildOf; +import org.opendaylight.yangtools.yang.binding.ChoiceIn; import org.opendaylight.yangtools.yang.binding.DataObject; import org.opendaylight.yangtools.yang.binding.Identifiable; import org.opendaylight.yangtools.yang.binding.Identifier; +import org.opendaylight.yangtools.yang.binding.InstanceIdentifier.IdentifiableItem; +import org.opendaylight.yangtools.yang.binding.InstanceIdentifier.Item; import org.opendaylight.yangtools.yang.binding.InstanceIdentifier.PathArgument; /** @@ -82,7 +86,44 @@ public interface DataObjectModification * * @return unmodifiable collection of modified direct children. */ - @Nonnull Collection> getModifiedChildren(); + @Nonnull Collection> getModifiedChildren(); + + /** + * Returns child list item modification if {@code child} was modified by this modification. This method should be + * used if the child is defined in a grouping brought into a case inside this object. + * + * @param caseType Case type class + * @param childType Type of list item - must be list item with key + * @return Modification of {@code child} if {@code child} was modified, null otherwise. + * @throws IllegalArgumentException If supplied {@code childType} class is not valid child according + * to generated model. + */ + default & DataObject, C extends ChildOf> + Collection> getModifiedChildren(@Nonnull final Class caseType, + @Nonnull final Class childType) { + final Item item = Item.of(caseType, childType); + return (Collection>) Collections2.filter(getModifiedChildren(), + mod -> item.equals(mod.getIdentifier())); + } + + /** + * Returns container child modification if {@code child} was modified by this modification. This method should be + * used if the child is defined in a grouping brought into a case inside this object. + * + *

+ * For accessing all modified list items consider iterating over {@link #getModifiedChildren()}. + * + * @param caseType Case type class + * @param child Type of child - must be only container + * @return Modification of {@code child} if {@code child} was modified, null otherwise. + * @throws IllegalArgumentException If supplied {@code child} class is not valid child according + * to generated model. + */ + default @Nullable & DataObject, C extends ChildOf> + DataObjectModification getModifiedChildContainer(@Nonnull final Class caseType, + @Nonnull final Class child) { + return (DataObjectModification) getModifiedChild(Item.of(caseType, child)); + } /** * Returns container child modification if {@code child} was modified by this modification. @@ -112,18 +153,33 @@ public interface DataObjectModification @Nullable & DataObject> DataObjectModification getModifiedAugmentation( @Nonnull Class augmentation); + /** + * Returns child list item modification if {@code child} was modified by this modification. + * + * @param listItem Type of list item - must be list item with key + * @param listKey List item key + * @return Modification of {@code child} if {@code child} was modified, null otherwise. + * @throws IllegalArgumentException If supplied {@code listItem} class is not valid child according + * to generated model. + */ + & ChildOf, K extends Identifier> DataObjectModification + getModifiedChildListItem(@Nonnull Class listItem, @Nonnull K listKey); /** * Returns child list item modification if {@code child} was modified by this modification. * + * @param caseType Case type class * @param listItem Type of list item - must be list item with key * @param listKey List item key * @return Modification of {@code child} if {@code child} was modified, null otherwise. * @throws IllegalArgumentException If supplied {@code listItem} class is not valid child according * to generated model. */ - & ChildOf, K extends Identifier> DataObjectModification - getModifiedChildListItem(@Nonnull Class listItem,@Nonnull K listKey); + default & DataObject, C extends Identifiable & ChildOf, + K extends Identifier> DataObjectModification getModifiedChildListItem( + @Nonnull final Class caseType, @Nonnull final Class listItem, @Nonnull final K listKey) { + return (DataObjectModification) getModifiedChild(IdentifiableItem.of(caseType, listItem, listKey)); + } /** * Returns a child modification if a node identified by {@code childArgument} was modified by diff --git a/opendaylight/md-sal/sal-binding-broker/src/main/java/org/opendaylight/controller/md/sal/binding/impl/LazyDataObjectModification.java b/opendaylight/md-sal/sal-binding-broker/src/main/java/org/opendaylight/controller/md/sal/binding/impl/LazyDataObjectModification.java index eb2aed779e..c3aff15e7a 100644 --- a/opendaylight/md-sal/sal-binding-broker/src/main/java/org/opendaylight/controller/md/sal/binding/impl/LazyDataObjectModification.java +++ b/opendaylight/md-sal/sal-binding-broker/src/main/java/org/opendaylight/controller/md/sal/binding/impl/LazyDataObjectModification.java @@ -13,11 +13,14 @@ import java.util.Collection; import java.util.Iterator; import java.util.List; import java.util.Optional; +import java.util.stream.Collectors; +import java.util.stream.Stream; import org.opendaylight.controller.md.sal.binding.api.DataObjectModification; import org.opendaylight.mdsal.binding.dom.adapter.BindingStructuralType; import org.opendaylight.mdsal.binding.dom.codec.api.BindingCodecTreeNode; import org.opendaylight.yangtools.yang.binding.Augmentation; import org.opendaylight.yangtools.yang.binding.ChildOf; +import org.opendaylight.yangtools.yang.binding.ChoiceIn; import org.opendaylight.yangtools.yang.binding.DataObject; import org.opendaylight.yangtools.yang.binding.Identifiable; import org.opendaylight.yangtools.yang.binding.Identifier; @@ -47,7 +50,7 @@ final class LazyDataObjectModification implements DataObje private final DataTreeCandidateNode domData; private final PathArgument identifier; - private volatile Collection> childNodesCache; + private volatile Collection> childNodesCache; private volatile ModificationType modificationType; private LazyDataObjectModification(final BindingCodecTreeNode codec, final DataTreeCandidateNode domData) { @@ -56,19 +59,19 @@ final class LazyDataObjectModification implements DataObje this.identifier = codec.deserializePathArgument(domData.getIdentifier()); } - static DataObjectModification create(final BindingCodecTreeNode codec, + static LazyDataObjectModification create(final BindingCodecTreeNode codec, final DataTreeCandidateNode domData) { return new LazyDataObjectModification<>(codec,domData); } - private static Collection> from( + private static Collection> from( final BindingCodecTreeNode parentCodec, final Collection domChildNodes) { - final List> result = new ArrayList<>(domChildNodes.size()); + final List> result = new ArrayList<>(domChildNodes.size()); populateList(result, parentCodec, domChildNodes); return result; } - private static void populateList(final List> result, + private static void populateList(final List> result, final BindingCodecTreeNode parentCodec, final Collection domChildNodes) { for (final DataTreeCandidateNode domChildNode : domChildNodes) { final BindingStructuralType type = BindingStructuralType.from(domChildNode); @@ -93,7 +96,7 @@ final class LazyDataObjectModification implements DataObje } } - private static void populateList(final List> result, + private static void populateList(final List> result, final BindingStructuralType type, final BindingCodecTreeNode childCodec, final DataTreeCandidateNode domChildNode) { switch (type) { @@ -113,7 +116,7 @@ final class LazyDataObjectModification implements DataObje } } - private static void populateListWithSingleCodec(final List> result, + private static void populateListWithSingleCodec(final List> result, final BindingCodecTreeNode codec, final Collection childNodes) { for (final DataTreeCandidateNode child : childNodes) { result.add(create(codec, child)); @@ -197,14 +200,31 @@ final class LazyDataObjectModification implements DataObje } @Override - public Collection> getModifiedChildren() { - Collection> local = childNodesCache; + public Collection> getModifiedChildren() { + Collection> local = childNodesCache; if (local == null) { childNodesCache = local = from(codec, domData.getChildNodes()); } return local; } + @Override + public & DataObject, C extends ChildOf> + Collection> getModifiedChildren(final Class caseType, + final Class childType) { + return streamModifiedChildren(childType) + .filter(child -> caseType.equals(child.identifier.getCaseType().orElse(null))) + .collect(Collectors.toList()); + } + + @SuppressWarnings("unchecked") + private Stream> streamModifiedChildren( + final Class childType) { + return getModifiedChildren().stream() + .filter(child -> childType.isAssignableFrom(child.getDataType())) + .map(child -> (LazyDataObjectModification) child); + } + @Override public DataObjectModification getModifiedChild(final PathArgument arg) { final List domArgumentList = new ArrayList<>(); @@ -229,8 +249,23 @@ final class LazyDataObjectModification implements DataObje @Override @SuppressWarnings("unchecked") - public > DataObjectModification getModifiedChildContainer(final Class arg) { - return (DataObjectModification) getModifiedChild(Item.of(arg)); + public & DataObject, C extends Identifiable & ChildOf, + K extends Identifier> DataObjectModification getModifiedChildListItem(final Class caseType, + final Class listItem, final K listKey) { + return (DataObjectModification) getModifiedChild(IdentifiableItem.of(caseType, listItem, listKey)); + } + + @Override + @SuppressWarnings("unchecked") + public > DataObjectModification getModifiedChildContainer(final Class child) { + return (DataObjectModification) getModifiedChild(Item.of(child)); + } + + @Override + @SuppressWarnings("unchecked") + public & DataObject, C extends ChildOf> DataObjectModification + getModifiedChildContainer(final Class caseType, final Class child) { + return (DataObjectModification) getModifiedChild(Item.of(caseType, child)); } @Override @@ -241,10 +276,7 @@ final class LazyDataObjectModification implements DataObje } private T deserialize(final Optional> dataAfter) { - if (dataAfter.isPresent()) { - return codec.deserialize(dataAfter.get()); - } - return null; + return dataAfter.map(codec::deserialize).orElse(null); } @Override -- 2.36.6