You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@isis.apache.org by ah...@apache.org on 2021/01/23 18:00:57 UTC

[isis] branch master updated: ISIS-2492: refactor recursive member lookup code into its own class: ObjectMemberContainer

This is an automated email from the ASF dual-hosted git repository.

ahuber pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/isis.git


The following commit(s) were added to refs/heads/master by this push:
     new 2c8c7c1  ISIS-2492: refactor recursive member lookup code into its own class: ObjectMemberContainer
2c8c7c1 is described below

commit 2c8c7c16451c70846e9c70bef3c1222577e38951
Author: Andi Huber <ah...@apache.org>
AuthorDate: Sat Jan 23 19:00:42 2021 +0100

    ISIS-2492: refactor recursive member lookup code into its own class:
    ObjectMemberContainer
    
    separation of concerns
---
 .../isis/core/metamodel/spec/Hierarchical.java     |   4 +
 .../core/metamodel/spec/ObjectSpecification.java   |  14 +--
 .../spec/feature/ObjectActionContainer.java        |   4 +-
 .../spec/feature/ObjectAssociationContainer.java   |   8 +-
 .../specloader/specimpl/ObjectMemberContainer.java | 122 +++++++++++++++++++++
 .../specimpl/ObjectSpecificationAbstract.java      |  40 +------
 .../specimpl/dflt/ObjectSpecificationDefault.java  |  34 ------
 7 files changed, 141 insertions(+), 85 deletions(-)

diff --git a/core/metamodel/src/main/java/org/apache/isis/core/metamodel/spec/Hierarchical.java b/core/metamodel/src/main/java/org/apache/isis/core/metamodel/spec/Hierarchical.java
index 0df42c2..c30ac93 100644
--- a/core/metamodel/src/main/java/org/apache/isis/core/metamodel/spec/Hierarchical.java
+++ b/core/metamodel/src/main/java/org/apache/isis/core/metamodel/spec/Hierarchical.java
@@ -61,5 +61,9 @@ public interface Hierarchical {
      * Get the specification for this specification's class's superclass.
      */
     ObjectSpecification superclass();
+    
+    default boolean isTypeHierarchyRoot() {
+        return superclass()==null;
+    }
 
 }
diff --git a/core/metamodel/src/main/java/org/apache/isis/core/metamodel/spec/ObjectSpecification.java b/core/metamodel/src/main/java/org/apache/isis/core/metamodel/spec/ObjectSpecification.java
index ccef4ae..0b7958a 100644
--- a/core/metamodel/src/main/java/org/apache/isis/core/metamodel/spec/ObjectSpecification.java
+++ b/core/metamodel/src/main/java/org/apache/isis/core/metamodel/spec/ObjectSpecification.java
@@ -84,8 +84,13 @@ import lombok.val;
  * first, and then later work out its internals. Hence we create
  * {@link ObjectSpecification}s as we need them, and then introspect them later.
  */
-public interface ObjectSpecification extends Specification, ObjectActionContainer,
-        ObjectAssociationContainer, Hierarchical, DefaultProvider {
+public interface ObjectSpecification 
+extends 
+    Specification, 
+    ObjectActionContainer,
+    ObjectAssociationContainer, 
+    Hierarchical, 
+    DefaultProvider {
 
     final class Comparators{
         private Comparators(){}
@@ -540,9 +545,4 @@ public interface ObjectSpecification extends Specification, ObjectActionContaine
                 || Externalizable.class.isAssignableFrom(getCorrespondingClass());
     }
 
-    default boolean isTypeHierarchyRoot() {
-        return getCorrespondingClass().getSuperclass()==null;
-    }
-    
-
 }
diff --git a/core/metamodel/src/main/java/org/apache/isis/core/metamodel/spec/feature/ObjectActionContainer.java b/core/metamodel/src/main/java/org/apache/isis/core/metamodel/spec/feature/ObjectActionContainer.java
index 32a88fd..e74fa90 100644
--- a/core/metamodel/src/main/java/org/apache/isis/core/metamodel/spec/feature/ObjectActionContainer.java
+++ b/core/metamodel/src/main/java/org/apache/isis/core/metamodel/spec/feature/ObjectActionContainer.java
@@ -31,7 +31,7 @@ import org.apache.isis.core.metamodel.spec.ActionType;
 
 public interface ObjectActionContainer {
 
-    // -- ACTION LOOKUP (INHERITENCE CONSIDERED)
+    // -- ACTION LOOKUP (INHERITANCE CONSIDERED)
     
     /**
      * Same as {@link #getDeclaredAction(String, ActionType)}, but also considering any inherited object members.
@@ -61,7 +61,7 @@ public interface ObjectActionContainer {
     }
     
     
-    // -- ACTION LOOKUP, DECLARED ACTIONS (NO INHERITENCE CONSIDERED)
+    // -- ACTION LOOKUP, DECLARED ACTIONS (NO INHERITANCE CONSIDERED)
     
     /**
      * Get the action object represented by the specified identity string.
diff --git a/core/metamodel/src/main/java/org/apache/isis/core/metamodel/spec/feature/ObjectAssociationContainer.java b/core/metamodel/src/main/java/org/apache/isis/core/metamodel/spec/feature/ObjectAssociationContainer.java
index bf9b0e6..b573310 100644
--- a/core/metamodel/src/main/java/org/apache/isis/core/metamodel/spec/feature/ObjectAssociationContainer.java
+++ b/core/metamodel/src/main/java/org/apache/isis/core/metamodel/spec/feature/ObjectAssociationContainer.java
@@ -27,7 +27,7 @@ import org.apache.isis.core.metamodel.spec.ObjectSpecificationException;
 
 public interface ObjectAssociationContainer {
     
-    // -- ASSOCIATION LOOKUP, PROPERTIES/COLLECTIONS (INHERITENCE CONSIDERED)
+    // -- ASSOCIATION LOOKUP, PROPERTIES/COLLECTIONS (INHERITANCE CONSIDERED)
     
     /**
      * Same as {@link #getDeclaredAssociation(String)}, but also considering any inherited object members.
@@ -43,7 +43,7 @@ public interface ObjectAssociationContainer {
                 .orElseThrow(()->_Exceptions.noSuchElement("id=%s", id));
     }
 
-    // -- ASSOCIATION LOOKUP, DECLARED PROPERTIES/COLLECTIONS (NO INHERITENCE CONSIDERED)
+    // -- ASSOCIATION LOOKUP, DECLARED PROPERTIES/COLLECTIONS (NO INHERITANCE CONSIDERED)
 
     /**
      * Get the field object representing the field with the specified field
@@ -54,7 +54,7 @@ public interface ObjectAssociationContainer {
      */
     Optional<ObjectAssociation> getDeclaredAssociation(String id);
     
-    // -- ASSOCIATION STREAMS (INHERITENCE CONSIDERED)
+    // -- ASSOCIATION STREAMS (INHERITANCE CONSIDERED)
 
     /**
      * Same as {@link #streamDeclaredAssociations(MixedIn)}, but also considering any inherited object members.
@@ -90,7 +90,7 @@ public interface ObjectAssociationContainer {
                 .map(OneToManyAssociation.class::cast);
     }
     
-    // -- ASSOCIATION STREAMS (INHERITENCE NOT CONSIDERED)
+    // -- ASSOCIATION STREAMS (INHERITANCE NOT CONSIDERED)
     
     /**
      * Return all the fields that exist in an object of this specification,
diff --git a/core/metamodel/src/main/java/org/apache/isis/core/metamodel/specloader/specimpl/ObjectMemberContainer.java b/core/metamodel/src/main/java/org/apache/isis/core/metamodel/specloader/specimpl/ObjectMemberContainer.java
new file mode 100644
index 0000000..ac66936
--- /dev/null
+++ b/core/metamodel/src/main/java/org/apache/isis/core/metamodel/specloader/specimpl/ObjectMemberContainer.java
@@ -0,0 +1,122 @@
+/*
+ *  Licensed to the Apache Software Foundation (ASF) under one
+ *  or more contributor license agreements.  See the NOTICE file
+ *  distributed with this work for additional information
+ *  regarding copyright ownership.  The ASF licenses this file
+ *  to you under the Apache License, Version 2.0 (the
+ *  "License"); you may not use this file except in compliance
+ *  with the License.  You may obtain a copy of the License at
+ *
+ *        http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *  Unless required by applicable law or agreed to in writing,
+ *  software distributed under the License is distributed on an
+ *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ *  KIND, either express or implied.  See the License for the
+ *  specific language governing permissions and limitations
+ *  under the License.
+ */
+package org.apache.isis.core.metamodel.specloader.specimpl;
+
+import java.util.Optional;
+import java.util.stream.Stream;
+
+import javax.annotation.Nullable;
+
+import org.apache.isis.commons.collections.ImmutableEnumSet;
+import org.apache.isis.core.metamodel.facetapi.FacetHolderImpl;
+import org.apache.isis.core.metamodel.spec.ActionType;
+import org.apache.isis.core.metamodel.spec.Hierarchical;
+import org.apache.isis.core.metamodel.spec.feature.MixedIn;
+import org.apache.isis.core.metamodel.spec.feature.ObjectAction;
+import org.apache.isis.core.metamodel.spec.feature.ObjectActionContainer;
+import org.apache.isis.core.metamodel.spec.feature.ObjectAssociation;
+import org.apache.isis.core.metamodel.spec.feature.ObjectAssociationContainer;
+
+import lombok.val;
+
+/**
+ * Responsibility: member lookup and streaming with support for inheritance, 
+ * based on access to declared members, super-classes and interfaces.
+ */
+public abstract class ObjectMemberContainer
+extends FacetHolderImpl 
+implements 
+    ObjectActionContainer,
+    ObjectAssociationContainer, 
+    Hierarchical {
+
+    // -- ACTIONS
+    
+    @Override
+    public Optional<ObjectAction> getAction(String id, @Nullable ActionType type) {
+
+        if(isTypeHierarchyRoot()) {
+            return Optional.empty(); // stop search as we reached the Object class, which does not contribute actions 
+        }
+        
+        val declaredAction = getDeclaredAction(id); // no inheritance nor type considered
+                
+        if(declaredAction.isPresent()) {
+            // action found but if its not the right type, stop searching
+            if(type!=null
+                    && declaredAction.get().getType() != type) {
+                return Optional.empty();
+            }
+            return declaredAction; 
+        }
+        
+        if(superclass()==null) {
+            // guard against unexpected reach of type hierarchy root
+            return Optional.empty();
+        }
+        
+        return superclass().getAction(id, type);
+        
+        //XXX future extensions should also search the interfaces, 
+        // but avoid doing redundant work when walking the type-hierarchy;
+        // (this elegant recursive solution will then need some tweaks to be efficient)
+    }
+    
+    @Override
+    public Stream<ObjectAction> streamActions(
+            final ImmutableEnumSet<ActionType> types, 
+            final MixedIn contributed) {
+        //FIXME poorly implemented, inheritance not supported
+        return streamDeclaredActions(contributed);
+    }
+    
+    // -- ASSOCIATIONS
+    
+    @Override
+    public Optional<ObjectAssociation> getAssociation(String id) {
+
+        if(isTypeHierarchyRoot()) {
+            return Optional.empty(); // stop search as we reached the Object class, which does not contribute actions 
+        }
+        
+        val declaredAssociation = getDeclaredAssociation(id); // no inheritance considered
+                
+        if(declaredAssociation.isPresent()) {
+            return declaredAssociation; 
+        }
+        
+        if(superclass()==null) {
+            // guard against unexpected reach of type hierarchy root
+            return Optional.empty();
+        }
+        
+        return superclass().getAssociation(id);
+        
+        //XXX future extensions should also search the interfaces, 
+        // but avoid doing redundant work when walking the type-hierarchy;
+        // (this elegant recursive solution will then need some tweaks to be efficient)
+    }
+    
+    @Override
+    public Stream<ObjectAssociation> streamAssociations(MixedIn contributed) {
+        //FIXME poorly implemented, inheritance not supported
+        return streamDeclaredAssociations(contributed);
+    }
+    
+}
diff --git a/core/metamodel/src/main/java/org/apache/isis/core/metamodel/specloader/specimpl/ObjectSpecificationAbstract.java b/core/metamodel/src/main/java/org/apache/isis/core/metamodel/specloader/specimpl/ObjectSpecificationAbstract.java
index 9408d20..0dec42d 100644
--- a/core/metamodel/src/main/java/org/apache/isis/core/metamodel/specloader/specimpl/ObjectSpecificationAbstract.java
+++ b/core/metamodel/src/main/java/org/apache/isis/core/metamodel/specloader/specimpl/ObjectSpecificationAbstract.java
@@ -51,7 +51,6 @@ import org.apache.isis.core.metamodel.consent.Consent;
 import org.apache.isis.core.metamodel.consent.InteractionInitiatedBy;
 import org.apache.isis.core.metamodel.consent.InteractionResult;
 import org.apache.isis.core.metamodel.facetapi.Facet;
-import org.apache.isis.core.metamodel.facetapi.FacetHolderImpl;
 import org.apache.isis.core.metamodel.facetapi.FeatureType;
 import org.apache.isis.core.metamodel.facets.all.describedas.DescribedAsFacet;
 import org.apache.isis.core.metamodel.facets.all.help.HelpFacet;
@@ -94,7 +93,7 @@ import lombok.extern.log4j.Log4j2;
 @lombok.ToString(of = {"correspondingClass", "fullName", "beanSort"})
 @Log4j2 
 public abstract class ObjectSpecificationAbstract 
-extends FacetHolderImpl 
+extends ObjectMemberContainer
 implements ObjectSpecification {
 
 
@@ -677,12 +676,6 @@ implements ObjectSpecification {
     }
 
     // -- ASSOCIATIONS
-    
-    @Override
-    public Stream<ObjectAssociation> streamAssociations(MixedIn contributed) {
-        //FIXME poorly implemented, inheritance not supported
-        return streamDeclaredAssociations(contributed);
-    }
 
     @Override
     public Stream<ObjectAssociation> streamDeclaredAssociations(final MixedIn contributed) {
@@ -717,30 +710,7 @@ implements ObjectSpecification {
         return Optional.empty();
     }
 
-    @Override
-    public Optional<ObjectAssociation> getAssociation(String id) {
 
-        if(isTypeHierarchyRoot()) {
-            return Optional.empty(); // stop search as we reached the Object class, which does not contribute actions 
-        }
-        
-        val declaredAssociation = getDeclaredAssociation(id); // no inheritance considered
-                
-        if(declaredAssociation.isPresent()) {
-            return declaredAssociation; 
-        }
-        
-        if(superclass()==null) {
-            // guard against unexpected reach of type hierarchy root
-            return Optional.empty();
-        }
-        
-        return superclass().getAssociation(id);
-        
-        //XXX future extensions should also search the interfaces, 
-        // but avoid doing redundant work when walking the type-hierarchy;
-        // (this elegant recursive solution will then need some tweaks to be efficient)
-    }
 
     /**
      * The association with the given {@link ObjectAssociation#getId() id}.
@@ -753,13 +723,7 @@ implements ObjectSpecification {
                 .findFirst();
     }
     
-    @Override
-    public Stream<ObjectAction> streamActions(
-            final ImmutableEnumSet<ActionType> types, 
-            final MixedIn contributed) {
-        //FIXME poorly implemented, inheritance not supported
-        return streamDeclaredActions(contributed);
-    }
+
 
     @Override
     public Stream<ObjectAction> streamDeclaredActions(
diff --git a/core/metamodel/src/main/java/org/apache/isis/core/metamodel/specloader/specimpl/dflt/ObjectSpecificationDefault.java b/core/metamodel/src/main/java/org/apache/isis/core/metamodel/specloader/specimpl/dflt/ObjectSpecificationDefault.java
index b8e4d1e..68034f2 100644
--- a/core/metamodel/src/main/java/org/apache/isis/core/metamodel/specloader/specimpl/dflt/ObjectSpecificationDefault.java
+++ b/core/metamodel/src/main/java/org/apache/isis/core/metamodel/specloader/specimpl/dflt/ObjectSpecificationDefault.java
@@ -26,8 +26,6 @@ import java.util.Optional;
 import java.util.function.BiConsumer;
 import java.util.stream.Stream;
 
-import javax.annotation.Nullable;
-
 import org.apache.isis.applib.Identifier;
 import org.apache.isis.applib.services.metamodel.BeanSort;
 import org.apache.isis.commons.collections.ImmutableEnumSet;
@@ -270,38 +268,6 @@ implements FacetHolder {
         return nameIfIsManagedBean;
     }
     
-    // -- findObjectAction
-    
-    @Override
-    public Optional<ObjectAction> getAction(String id, @Nullable ActionType type) {
-
-        if(isTypeHierarchyRoot()) {
-            return Optional.empty(); // stop search as we reached the Object class, which does not contribute actions 
-        }
-        
-        val declaredAction = getDeclaredAction(id); // no inheritance nor type considered
-                
-        if(declaredAction.isPresent()) {
-            // action found but if its not the right type, stop searching
-            if(type!=null
-                    && declaredAction.get().getType() != type) {
-                return Optional.empty();
-            }
-            return declaredAction; 
-        }
-        
-        if(superclass()==null) {
-            // guard against unexpected reach of type hierarchy root
-            return Optional.empty();
-        }
-        
-        return superclass().getAction(id, type);
-        
-        //XXX future extensions should also search the interfaces, 
-        // but avoid doing redundant work when walking the type-hierarchy;
-        // (this elegant recursive solution will then need some tweaks to be efficient)
-    }
-    
     // -- getObjectAction
 
     @Override