You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@isis.apache.org by da...@apache.org on 2021/04/23 14:59:15 UTC

[isis] branch ISIS-2619 updated: ISIS-2619: extracts DeriveTypicalLengthFromTypePostProcessor into its own class

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

danhaywood pushed a commit to branch ISIS-2619
in repository https://gitbox.apache.org/repos/asf/isis.git


The following commit(s) were added to refs/heads/ISIS-2619 by this push:
     new 7a39741  ISIS-2619: extracts DeriveTypicalLengthFromTypePostProcessor into its own class
7a39741 is described below

commit 7a3974124b3d3049c6ba1ef7309f8bdc29ca5922
Author: danhaywood <da...@haywood-associates.co.uk>
AuthorDate: Fri Apr 23 15:58:41 2021 +0100

    ISIS-2619: extracts DeriveTypicalLengthFromTypePostProcessor into its own class
---
 .../postprocessors/DeriveFacetsPostProcessor.java  |  29 ----
 .../DeriveTypicalLengthFromTypePostProcessor.java  | 183 +++++++++++++++++++++
 .../dflt/ProgrammingModelFacetsJava8.java          |   2 +
 3 files changed, 185 insertions(+), 29 deletions(-)

diff --git a/core/metamodel/src/main/java/org/apache/isis/core/metamodel/postprocessors/DeriveFacetsPostProcessor.java b/core/metamodel/src/main/java/org/apache/isis/core/metamodel/postprocessors/DeriveFacetsPostProcessor.java
index fe77d1e..c1a14a7 100644
--- a/core/metamodel/src/main/java/org/apache/isis/core/metamodel/postprocessors/DeriveFacetsPostProcessor.java
+++ b/core/metamodel/src/main/java/org/apache/isis/core/metamodel/postprocessors/DeriveFacetsPostProcessor.java
@@ -127,7 +127,6 @@ implements ObjectSpecificationPostProcessor, MetaModelContextAware {
             .forEach(parameter -> {
                 deriveParameterDefaultFacetFromType(parameter);
                 deriveParameterChoicesFromExistingChoices(parameter);
-                deriveParameterTypicalLengthFromType(parameter);
             });
 
         // for each action, ...
@@ -144,7 +143,6 @@ implements ObjectSpecificationPostProcessor, MetaModelContextAware {
         objectSpecification.streamProperties(MixedIn.INCLUDED).forEach(property -> {
             derivePropertyChoicesFromExistingChoices(property);
             derivePropertyDefaultsFromType(property);
-            derivePropertyTypicalLengthFromType(property);
             derivePropertyDisabledFromViewModel(property);
             derivePropertyDisabledFromImmutable(property);
             tweakPropertyMixinDomainEvent(objectSpecification, property);
@@ -373,19 +371,6 @@ implements ObjectSpecificationPostProcessor, MetaModelContextAware {
 
 
     /**
-     * Replaces {@link TypicalLengthFacetOnParameterDerivedFromTypeFacetFactory}
-     */
-    private static void deriveParameterTypicalLengthFromType(final ObjectActionParameter parameter) {
-        if(parameter.containsNonFallbackFacet(TypicalLengthFacet.class)) {
-            return;
-        }
-        parameter.getSpecification()
-        .lookupNonFallbackFacet(TypicalLengthFacet.class)
-        .ifPresent(specFacet -> FacetUtil.addFacet(new TypicalLengthFacetOnParameterDerivedFromType(specFacet,
-                                    peerFor(parameter))));
-    }
-
-    /**
      * Replaces {@link PropertyChoicesFacetDerivedFromChoicesFacetFactory}
      */
     private static void derivePropertyChoicesFromExistingChoices(final OneToOneAssociation property) {
@@ -411,20 +396,6 @@ implements ObjectSpecificationPostProcessor, MetaModelContextAware {
                                     specFacet, facetedMethodFor(property))));
     }
 
-    /**
-     * replaces {@link TypicalLengthFacetOnPropertyDerivedFromTypeFacetFactory}
-     */
-    private static void derivePropertyTypicalLengthFromType(final OneToOneAssociation property) {
-        if(property.containsNonFallbackFacet(TypicalLengthFacet.class)) {
-            return;
-        }
-        property.getSpecification()
-        .lookupNonFallbackFacet(TypicalLengthFacet.class)
-        .ifPresent(specFacet -> FacetUtil.addFacet(new TypicalLengthFacetOnPropertyDerivedFromType(
-                                    specFacet, facetedMethodFor(property))));
-
-    }
-
 
     /**
      * Replaces {@link DisabledFacetOnPropertyDerivedFromRecreatableObjectFacetFactory}
diff --git a/core/metamodel/src/main/java/org/apache/isis/core/metamodel/postprocessors/DeriveTypicalLengthFromTypePostProcessor.java b/core/metamodel/src/main/java/org/apache/isis/core/metamodel/postprocessors/DeriveTypicalLengthFromTypePostProcessor.java
new file mode 100644
index 0000000..1dfd8e7
--- /dev/null
+++ b/core/metamodel/src/main/java/org/apache/isis/core/metamodel/postprocessors/DeriveTypicalLengthFromTypePostProcessor.java
@@ -0,0 +1,183 @@
+/*
+ *  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.postprocessors;
+
+import java.lang.reflect.Method;
+import java.util.stream.Stream;
+
+import org.apache.isis.applib.annotation.Collection;
+import org.apache.isis.applib.annotation.Property;
+import org.apache.isis.applib.events.domain.ActionDomainEvent;
+import org.apache.isis.applib.events.domain.CollectionDomainEvent;
+import org.apache.isis.applib.events.domain.PropertyDomainEvent;
+import org.apache.isis.commons.collections.ImmutableEnumSet;
+import org.apache.isis.commons.internal.reflection._Annotations;
+import org.apache.isis.core.metamodel.context.MetaModelContext;
+import org.apache.isis.core.metamodel.context.MetaModelContextAware;
+import org.apache.isis.core.metamodel.facetapi.Facet;
+import org.apache.isis.core.metamodel.facetapi.FacetUtil;
+import org.apache.isis.core.metamodel.facets.FacetedMethod;
+import org.apache.isis.core.metamodel.facets.TypedHolder;
+import org.apache.isis.core.metamodel.facets.actions.action.invocation.ActionDomainEventFacet;
+import org.apache.isis.core.metamodel.facets.actions.action.invocation.ActionDomainEventFacetAbstract;
+import org.apache.isis.core.metamodel.facets.actions.defaults.ActionDefaultsFacet;
+import org.apache.isis.core.metamodel.facets.collections.collection.CollectionAnnotationFacetFactory;
+import org.apache.isis.core.metamodel.facets.collections.collection.modify.CollectionDomainEventFacet;
+import org.apache.isis.core.metamodel.facets.collections.collection.modify.CollectionDomainEventFacetAbstract;
+import org.apache.isis.core.metamodel.facets.collections.collection.modify.CollectionDomainEventFacetForCollectionAnnotation;
+import org.apache.isis.core.metamodel.facets.members.cssclass.CssClassFacet;
+import org.apache.isis.core.metamodel.facets.members.disabled.DisabledFacet;
+import org.apache.isis.core.metamodel.facets.members.disabled.DisabledFacetAbstract;
+import org.apache.isis.core.metamodel.facets.object.defaults.DefaultedFacet;
+import org.apache.isis.core.metamodel.facets.object.domainobject.domainevents.ActionDomainEventDefaultFacetForDomainObjectAnnotation;
+import org.apache.isis.core.metamodel.facets.object.domainobject.domainevents.CollectionDomainEventDefaultFacetForDomainObjectAnnotation;
+import org.apache.isis.core.metamodel.facets.object.domainobject.domainevents.PropertyDomainEventDefaultFacetForDomainObjectAnnotation;
+import org.apache.isis.core.metamodel.facets.object.domainobject.editing.ImmutableFacetFromConfiguration;
+import org.apache.isis.core.metamodel.facets.object.icon.IconFacet;
+import org.apache.isis.core.metamodel.facets.object.immutable.EditingEnabledFacet;
+import org.apache.isis.core.metamodel.facets.object.immutable.ImmutableFacet;
+import org.apache.isis.core.metamodel.facets.object.projection.ProjectionFacetFromProjectingProperty;
+import org.apache.isis.core.metamodel.facets.object.projection.ident.IconFacetDerivedFromProjectionFacet;
+import org.apache.isis.core.metamodel.facets.object.projection.ident.TitleFacetDerivedFromProjectionFacet;
+import org.apache.isis.core.metamodel.facets.object.recreatable.DisabledFacetOnPropertyDerivedFromRecreatableObject;
+import org.apache.isis.core.metamodel.facets.object.recreatable.DisabledFacetOnPropertyDerivedFromRecreatableObjectFacetFactory;
+import org.apache.isis.core.metamodel.facets.object.title.TitleFacet;
+import org.apache.isis.core.metamodel.facets.object.viewmodel.ViewModelFacet;
+import org.apache.isis.core.metamodel.facets.objectvalue.choices.ChoicesFacet;
+import org.apache.isis.core.metamodel.facets.objectvalue.typicallen.TypicalLengthFacet;
+import org.apache.isis.core.metamodel.facets.param.autocomplete.ActionParameterAutoCompleteFacet;
+import org.apache.isis.core.metamodel.facets.param.choices.ActionParameterChoicesFacet;
+import org.apache.isis.core.metamodel.facets.param.choices.enums.ActionParameterChoicesFacetDerivedFromChoicesFacet;
+import org.apache.isis.core.metamodel.facets.param.choices.enums.ActionParameterChoicesFacetDerivedFromChoicesFacetFactory;
+import org.apache.isis.core.metamodel.facets.param.defaults.ActionParameterDefaultsFacet;
+import org.apache.isis.core.metamodel.facets.param.defaults.fromtype.ActionParameterDefaultFacetDerivedFromTypeFacets;
+import org.apache.isis.core.metamodel.facets.param.defaults.fromtype.ActionParameterDefaultFacetDerivedFromTypeFactory;
+import org.apache.isis.core.metamodel.facets.param.typicallen.fromtype.TypicalLengthFacetOnParameterDerivedFromType;
+import org.apache.isis.core.metamodel.facets.param.typicallen.fromtype.TypicalLengthFacetOnParameterDerivedFromTypeFacetFactory;
+import org.apache.isis.core.metamodel.facets.propcoll.accessor.PropertyOrCollectionAccessorFacet;
+import org.apache.isis.core.metamodel.facets.properties.choices.PropertyChoicesFacet;
+import org.apache.isis.core.metamodel.facets.properties.choices.enums.PropertyChoicesFacetDerivedFromChoicesFacet;
+import org.apache.isis.core.metamodel.facets.properties.choices.enums.PropertyChoicesFacetDerivedFromChoicesFacetFactory;
+import org.apache.isis.core.metamodel.facets.properties.defaults.PropertyDefaultFacet;
+import org.apache.isis.core.metamodel.facets.properties.defaults.fromtype.PropertyDefaultFacetDerivedFromDefaultedFacet;
+import org.apache.isis.core.metamodel.facets.properties.defaults.fromtype.PropertyDefaultFacetDerivedFromTypeFactory;
+import org.apache.isis.core.metamodel.facets.properties.disabled.fromimmutable.DisabledFacetOnPropertyDerivedFromImmutable;
+import org.apache.isis.core.metamodel.facets.properties.disabled.fromimmutable.DisabledFacetOnPropertyDerivedFromImmutableFactory;
+import org.apache.isis.core.metamodel.facets.properties.property.PropertyAnnotationFacetFactory;
+import org.apache.isis.core.metamodel.facets.properties.property.modify.PropertyDomainEventFacet;
+import org.apache.isis.core.metamodel.facets.properties.property.modify.PropertyDomainEventFacetAbstract;
+import org.apache.isis.core.metamodel.facets.properties.property.modify.PropertyDomainEventFacetForPropertyAnnotation;
+import org.apache.isis.core.metamodel.facets.properties.typicallen.fromtype.TypicalLengthFacetOnPropertyDerivedFromType;
+import org.apache.isis.core.metamodel.facets.properties.typicallen.fromtype.TypicalLengthFacetOnPropertyDerivedFromTypeFacetFactory;
+import org.apache.isis.core.metamodel.progmodel.ObjectSpecificationPostProcessor;
+import org.apache.isis.core.metamodel.spec.ActionType;
+import org.apache.isis.core.metamodel.spec.ObjectSpecification;
+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.ObjectActionParameter;
+import org.apache.isis.core.metamodel.spec.feature.ObjectMember;
+import org.apache.isis.core.metamodel.spec.feature.OneToManyAssociation;
+import org.apache.isis.core.metamodel.spec.feature.OneToOneAssociation;
+import org.apache.isis.core.metamodel.specloader.specimpl.ObjectActionMixedIn;
+import org.apache.isis.core.metamodel.specloader.specimpl.ObjectActionParameterAbstract;
+import org.apache.isis.core.metamodel.specloader.specimpl.ObjectMemberAbstract;
+import org.apache.isis.core.metamodel.specloader.specimpl.OneToManyAssociationMixedIn;
+import org.apache.isis.core.metamodel.specloader.specimpl.OneToOneAssociationMixedIn;
+
+import lombok.Setter;
+import lombok.val;
+
+/**
+ * Sets up all the {@link Facet}s for an action in a single shot.
+ */
+public class DeriveTypicalLengthFromTypePostProcessor
+implements ObjectSpecificationPostProcessor, MetaModelContextAware {
+
+    @Setter(onMethod = @__(@Override))
+    private MetaModelContext metaModelContext;
+
+    @Override
+    public void postProcess(final ObjectSpecification objectSpecification) {
+
+        //XXX in principle it would be sufficient to just process declared members; can optimize if worth the effort
+
+        // all the actions of this type
+        val actionTypes = inferActionTypes();
+        final Stream<ObjectAction> objectActions = objectSpecification.streamActions(actionTypes, MixedIn.INCLUDED);
+
+        // for each action, ...
+        objectActions.flatMap(ObjectAction::streamParameters)
+            .forEach(parameter -> {
+                deriveParameterTypicalLengthFromType(parameter);
+            });
+
+        objectSpecification.streamProperties(MixedIn.INCLUDED).forEach(property -> {
+            derivePropertyTypicalLengthFromType(property);
+        });
+    }
+
+
+    /**
+     * Replaces {@link TypicalLengthFacetOnParameterDerivedFromTypeFacetFactory}
+     */
+    private static void deriveParameterTypicalLengthFromType(final ObjectActionParameter parameter) {
+        if(parameter.containsNonFallbackFacet(TypicalLengthFacet.class)) {
+            return;
+        }
+        parameter.getSpecification()
+        .lookupNonFallbackFacet(TypicalLengthFacet.class)
+        .ifPresent(specFacet -> FacetUtil.addFacet(new TypicalLengthFacetOnParameterDerivedFromType(specFacet,
+                                    peerFor(parameter))));
+    }
+
+    /**
+     * replaces {@link TypicalLengthFacetOnPropertyDerivedFromTypeFacetFactory}
+     */
+    private static void derivePropertyTypicalLengthFromType(final OneToOneAssociation property) {
+        if(property.containsNonFallbackFacet(TypicalLengthFacet.class)) {
+            return;
+        }
+        property.getSpecification()
+        .lookupNonFallbackFacet(TypicalLengthFacet.class)
+        .ifPresent(specFacet -> FacetUtil.addFacet(new TypicalLengthFacetOnPropertyDerivedFromType(
+                                    specFacet, facetedMethodFor(property))));
+
+    }
+
+
+    private ImmutableEnumSet<ActionType> inferActionTypes() {
+        return metaModelContext.getSystemEnvironment().isPrototyping()
+                ? ActionType.USER_AND_PROTOTYPE
+                : ActionType.USER_ONLY;
+    }
+
+    private static FacetedMethod facetedMethodFor(final ObjectMember objectMember) {
+        // TODO: hacky, need to copy facet onto underlying peer, not to the action/association itself.
+        final ObjectMemberAbstract objectActionImpl = (ObjectMemberAbstract) objectMember;
+        return objectActionImpl.getFacetedMethod();
+    }
+    private static TypedHolder peerFor(final ObjectActionParameter param) {
+        // TODO: hacky, need to copy facet onto underlying peer, not to the param itself.
+        final ObjectActionParameterAbstract objectActionImpl = (ObjectActionParameterAbstract) param;
+        return objectActionImpl.getPeer();
+    }
+
+
+}
diff --git a/core/metamodel/src/main/java/org/apache/isis/core/metamodel/progmodels/dflt/ProgrammingModelFacetsJava8.java b/core/metamodel/src/main/java/org/apache/isis/core/metamodel/progmodels/dflt/ProgrammingModelFacetsJava8.java
index 5b05e18..2a0d75b 100644
--- a/core/metamodel/src/main/java/org/apache/isis/core/metamodel/progmodels/dflt/ProgrammingModelFacetsJava8.java
+++ b/core/metamodel/src/main/java/org/apache/isis/core/metamodel/progmodels/dflt/ProgrammingModelFacetsJava8.java
@@ -145,6 +145,7 @@ import org.apache.isis.core.metamodel.methods.OrphanedSupportingMethodValidator;
 import org.apache.isis.core.metamodel.postprocessors.DeriveDescribedAsFromTypePostProcessor;
 import org.apache.isis.core.metamodel.postprocessors.DeriveFacetsPostProcessor;
 import org.apache.isis.core.metamodel.postprocessors.DeriveMixinMembersPostProcessor;
+import org.apache.isis.core.metamodel.postprocessors.DeriveTypicalLengthFromTypePostProcessor;
 import org.apache.isis.core.metamodel.progmodel.ProgrammingModelAbstract;
 import org.apache.isis.core.metamodel.services.title.TitlesAndTranslationsValidator;
 
@@ -356,6 +357,7 @@ public final class ProgrammingModelFacetsJava8 extends ProgrammingModelAbstract
         addPostProcessor(PostProcessingOrder.A0_BEFORE_BUILTIN, DeriveMixinMembersPostProcessor.class);
         addPostProcessor(PostProcessingOrder.A1_BUILTIN, DeriveFacetsPostProcessor.class);
         addPostProcessor(PostProcessingOrder.A1_BUILTIN, DeriveDescribedAsFromTypePostProcessor.class);
+        addPostProcessor(PostProcessingOrder.A1_BUILTIN, DeriveTypicalLengthFromTypePostProcessor.class);
 
         addValidator(new MemberSupportAnnotationEnforcesSupportingMethodValidator());
         addValidator(new OrphanedSupportingMethodValidator());