You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@causeway.apache.org by ah...@apache.org on 2024/11/13 10:52:49 UTC
(causeway) branch v3 updated: CAUSEWAY-2297: cleaning up BeanSort
This is an automated email from the ASF dual-hosted git repository.
ahuber pushed a commit to branch v3
in repository https://gitbox.apache.org/repos/asf/causeway.git
The following commit(s) were added to refs/heads/v3 by this push:
new 28104d9e706 CAUSEWAY-2297: cleaning up BeanSort
28104d9e706 is described below
commit 28104d9e70631892a568caf27239b8e47e321a4d
Author: Andi Huber <ah...@apache.org>
AuthorDate: Wed Nov 13 11:52:45 2024 +0100
CAUSEWAY-2297: cleaning up BeanSort
---
.../applib/services/metamodel/BeanSort.java | 40 ++++++++--------------
.../config/beans/CausewayComponentCollector.java | 2 +-
.../core/metamodel/commons/MetaModelVisitor.java | 2 +-
.../metamodel/object/_ManagedObjectService.java | 2 +-
.../memento/ObjectDementifierFactory.java | 2 +-
.../postprocessors/all/SanityChecksValidator.java | 4 +--
.../param/ChoicesAndDefaultsPostProcessor.java | 4 +--
.../ClassSubstitutorForDomainObjects.java | 24 ++++++-------
.../core/metamodel/spec/ObjectSpecification.java | 12 +++----
.../specloader/SpecificationLoaderDefault.java | 7 ++--
.../wrapper/WrapperFactoryDefault.java | 2 +-
.../viewer/wicket/ui/pages/PageAbstract.java | 2 +-
12 files changed, 41 insertions(+), 62 deletions(-)
diff --git a/api/applib/src/main/java/org/apache/causeway/applib/services/metamodel/BeanSort.java b/api/applib/src/main/java/org/apache/causeway/applib/services/metamodel/BeanSort.java
index 4709285caa3..e32527f4e4d 100644
--- a/api/applib/src/main/java/org/apache/causeway/applib/services/metamodel/BeanSort.java
+++ b/api/applib/src/main/java/org/apache/causeway/applib/services/metamodel/BeanSort.java
@@ -39,7 +39,7 @@ public enum BeanSort {
* Includes classes annotated with {@code @DomainObject}, when *not* associated
* with a persistence layer. <p> see also {@link #ENTITY}
*/
- VIEW_MODEL(new BeanPolicy(BeanPolicy.INTROSPECTION | BeanPolicy.WRAPPING)),
+ VIEW_MODEL(new BeanPolicy(BeanPolicy.INTROSPECTION | BeanPolicy.WRAPPING | BeanPolicy.ELEMENTTYPE | BeanPolicy.NON_SUBSTITUTABLE)),
/**
* Persistable object, associated with a persistence layer/context.
* <p>
@@ -47,7 +47,7 @@ public enum BeanSort {
* with a persistence layer. <p> see also {@link #VIEW_MODEL}
*
*/
- ENTITY(new BeanPolicy(BeanPolicy.INTROSPECTION | BeanPolicy.WRAPPING)),
+ ENTITY(new BeanPolicy(BeanPolicy.INTROSPECTION | BeanPolicy.WRAPPING | BeanPolicy.ELEMENTTYPE | BeanPolicy.NON_SUBSTITUTABLE)),
/**
* Injectable object, associated with a lifecycle context
* (application-scoped, request-scoped, ...).
@@ -59,7 +59,7 @@ public enum BeanSort {
* <p>
* to be introspected: YES
*/
- MANAGED_BEAN_CONTRIBUTING(new BeanPolicy(BeanPolicy.INTROSPECTION | BeanPolicy.INJECTABLE | BeanPolicy.WRAPPING)),
+ MANAGED_BEAN_CONTRIBUTING(new BeanPolicy(BeanPolicy.INTROSPECTION | BeanPolicy.INJECTABLE | BeanPolicy.WRAPPING | BeanPolicy.NON_SUBSTITUTABLE)),
/**
* Injectable object, associated with a lifecycle context
* (application-scoped, request-scoped, ...).
@@ -74,7 +74,7 @@ public enum BeanSort {
* <p>
* to be introspected: NO
*/
- MANAGED_BEAN_NOT_CONTRIBUTING(new BeanPolicy(BeanPolicy.INJECTABLE | BeanPolicy.WRAPPING)),
+ MANAGED_BEAN_NOT_CONTRIBUTING(new BeanPolicy(BeanPolicy.INJECTABLE | BeanPolicy.WRAPPING | BeanPolicy.NON_SUBSTITUTABLE)),
/**
* Object associated with an <i>entity</i>, <i>viewmodel</i> or <i>domain-service</i>
* to act as contributer of a single <i>domain-action</i> or
@@ -85,7 +85,7 @@ public enum BeanSort {
* Immutable, serializable object.
* Values (including enums) my have object support methods, hence needs introspection.
*/
- VALUE(new BeanPolicy(BeanPolicy.INTROSPECTION)),
+ VALUE(new BeanPolicy(BeanPolicy.INTROSPECTION | BeanPolicy.ELEMENTTYPE)),
/**
* Container of objects.
*/
@@ -96,7 +96,7 @@ public enum BeanSort {
* E.g. action return types or collection element types could be interfaces or abstract types
* (as discovered by reflection during introspection)
*/
- ABSTRACT(new BeanPolicy(BeanPolicy.INTROSPECTION)),
+ ABSTRACT(new BeanPolicy(BeanPolicy.INTROSPECTION | BeanPolicy.ELEMENTTYPE)),
/**
* Type must NOT be added to the meta-model, eg. by means of
* {@link org.apache.causeway.applib.annotation.Domain.Exclude} or {@link Programmatic}.
@@ -130,23 +130,28 @@ public enum BeanSort {
final static int INTROSPECTION = 0x01;
final static int INJECTABLE = 0x02;
final static int WRAPPING = 0x04;
+ final static int ELEMENTTYPE = 0x08;
+ final static int NON_SUBSTITUTABLE = 0x10;
/**
* Enables meta-model introspection.
* Potentially contributes to the UI or Web API.
*/
- boolean isIntrospectionAllowed() { return (flags & INTROSPECTION) !=0; }
+ public boolean isIntrospectionAllowed() { return (flags & INTROSPECTION) !=0; }
/**
* Contributes actions, members and/or object support to the UI or Web API.
*/
- boolean contributesToUiOrWebApi() { return isIntrospectionAllowed(); } // seems to be just a synonym
- boolean isInjectable() { return (flags & INJECTABLE) !=0; }
- boolean isWrappingSupported() { return (flags & WRAPPING) !=0; }
+ public boolean contributesToUiOrWebApi() { return isIntrospectionAllowed(); } // seems to be just a synonym
+ public boolean isInjectable() { return (flags & INJECTABLE) !=0; }
+ public boolean isWrappingSupported() { return (flags & WRAPPING) !=0; }
+ public boolean isAllowedAsMemberElementType() { return (flags & ELEMENTTYPE) !=0; }
+ public boolean isNotSubstitutable() { return (flags & NON_SUBSTITUTABLE) !=0; }
}
// -- POLICY
private final BeanPolicy policy;
private BeanSort(final BeanPolicy policy) { this.policy = policy;}
+ public BeanPolicy policy() { return policy; }
// -- PREDICATES
@@ -162,19 +167,4 @@ public enum BeanSort {
public boolean isVetoed() { return this == VETOED; }
public boolean isUnknown() { return this == UNKNOWN; }
- // -- DEPRECATED
-
- @Deprecated public boolean isToBeIntrospected() { return policy.isIntrospectionAllowed(); }
- @Deprecated public boolean isWrappingSupported() {
- return policy.isWrappingSupported();
- //return isMixin() || isViewModel() || isEntity() || isInjectable();
- }
- @Deprecated public boolean isManagedBeanAny() {
- return policy.isInjectable();
- }
- @Deprecated public boolean isInjectable() {
- return this == MANAGED_BEAN_CONTRIBUTING
- || this == MANAGED_BEAN_NOT_CONTRIBUTING;
- }
-
}
diff --git a/core/config/src/main/java/org/apache/causeway/core/config/beans/CausewayComponentCollector.java b/core/config/src/main/java/org/apache/causeway/core/config/beans/CausewayComponentCollector.java
index bd16af4db73..9986fabf021 100644
--- a/core/config/src/main/java/org/apache/causeway/core/config/beans/CausewayComponentCollector.java
+++ b/core/config/src/main/java/org/apache/causeway/core/config/beans/CausewayComponentCollector.java
@@ -95,7 +95,7 @@ record CausewayComponentCollector(
private CausewayBeanMetaData collectBeanClass(final LogicalType logicalType) {
var typeMeta = causewayBeanTypeClassifier.classify(logicalType, DiscoveredBy.SPRING);
var beanSort = typeMeta.beanSort();
- if(beanSort.isToBeIntrospected()) {
+ if(beanSort.policy().isIntrospectionAllowed()) {
var beanClass = logicalType.correspondingClass();
introspectableTypes.put(beanClass, typeMeta);
if(log.isDebugEnabled()) {
diff --git a/core/metamodel/src/main/java/org/apache/causeway/core/metamodel/commons/MetaModelVisitor.java b/core/metamodel/src/main/java/org/apache/causeway/core/metamodel/commons/MetaModelVisitor.java
index d24f8f73400..aebc1317115 100644
--- a/core/metamodel/src/main/java/org/apache/causeway/core/metamodel/commons/MetaModelVisitor.java
+++ b/core/metamodel/src/main/java/org/apache/causeway/core/metamodel/commons/MetaModelVisitor.java
@@ -53,7 +53,7 @@ public interface MetaModelVisitor {
*/
public final static Predicate<ObjectSpecification> SKIP_ABSTRACT =
spec->!spec.isAbstract()
- && spec.getBeanSort().isToBeIntrospected();
+ && spec.getBeanSort().policy().isIntrospectionAllowed();
/** types pass this filter, if is NOT a mixin */
public final static Predicate<ObjectSpecification> SKIP_MIXINS =
diff --git a/core/metamodel/src/main/java/org/apache/causeway/core/metamodel/object/_ManagedObjectService.java b/core/metamodel/src/main/java/org/apache/causeway/core/metamodel/object/_ManagedObjectService.java
index b852235e538..195de06850c 100644
--- a/core/metamodel/src/main/java/org/apache/causeway/core/metamodel/object/_ManagedObjectService.java
+++ b/core/metamodel/src/main/java/org/apache/causeway/core/metamodel/object/_ManagedObjectService.java
@@ -46,7 +46,7 @@ extends _ManagedObjectSpecified {
final ObjectSpecification spec,
final Object pojo) {
super(ManagedObject.Specialization.SERVICE, spec);
- _Assert.assertTrue(spec.getBeanSort().isManagedBeanAny()
+ _Assert.assertTrue(spec.getBeanSort().policy().isInjectable()
|| spec.getBeanSort().isUnknown(), ()->
String.format("service %s must be a managed bean (or unknown); sort= %s",
pojo.getClass(), spec.getBeanSort()));
diff --git a/core/metamodel/src/main/java/org/apache/causeway/core/metamodel/objectmanager/memento/ObjectDementifierFactory.java b/core/metamodel/src/main/java/org/apache/causeway/core/metamodel/objectmanager/memento/ObjectDementifierFactory.java
index 3d032f99433..28139e6ba2e 100644
--- a/core/metamodel/src/main/java/org/apache/causeway/core/metamodel/objectmanager/memento/ObjectDementifierFactory.java
+++ b/core/metamodel/src/main/java/org/apache/causeway/core/metamodel/objectmanager/memento/ObjectDementifierFactory.java
@@ -52,7 +52,7 @@ public record ObjectDementifierFactory() {
var spec = request.objectSpecification();
var mmc = spec.getMetaModelContext();
// intercept when managed by Spring
- return spec.getBeanSort().isManagedBeanAny()
+ return spec.getBeanSort().policy().isInjectable()
? mmc.lookupServiceAdapterById(request.memento().logicalType().logicalName())
: mmc.getObjectManager().loadObjectElseFail(request.memento().bookmark());
}
diff --git a/core/metamodel/src/main/java/org/apache/causeway/core/metamodel/postprocessors/all/SanityChecksValidator.java b/core/metamodel/src/main/java/org/apache/causeway/core/metamodel/postprocessors/all/SanityChecksValidator.java
index c6dcfed8270..d51959c2afc 100644
--- a/core/metamodel/src/main/java/org/apache/causeway/core/metamodel/postprocessors/all/SanityChecksValidator.java
+++ b/core/metamodel/src/main/java/org/apache/causeway/core/metamodel/postprocessors/all/SanityChecksValidator.java
@@ -96,9 +96,7 @@ implements
final ObjectSpecification elementType) {
if(elementType == null
- || elementType.getBeanSort().isManagedBeanAny()
- || elementType.getBeanSort().isMixin()
- || elementType.getBeanSort().isVetoed()) {
+ || !elementType.getBeanSort().policy().isAllowedAsMemberElementType()) {
ValidationFailureUtils.raiseInvalidMemberElementType(facetHolder, declaringType, elementType);
}
diff --git a/core/metamodel/src/main/java/org/apache/causeway/core/metamodel/postprocessors/param/ChoicesAndDefaultsPostProcessor.java b/core/metamodel/src/main/java/org/apache/causeway/core/metamodel/postprocessors/param/ChoicesAndDefaultsPostProcessor.java
index a68d235df6e..3eadcc9e70a 100644
--- a/core/metamodel/src/main/java/org/apache/causeway/core/metamodel/postprocessors/param/ChoicesAndDefaultsPostProcessor.java
+++ b/core/metamodel/src/main/java/org/apache/causeway/core/metamodel/postprocessors/param/ChoicesAndDefaultsPostProcessor.java
@@ -232,9 +232,7 @@ extends MetaModelPostProcessorAbstract {
private void checkParamHasChoicesOrAutoCompleteWhenRequired(final ObjectActionParameter param) {
var elementType = param.getElementType();
if(elementType == null
- || elementType.getBeanSort().isManagedBeanAny()
- || elementType.getBeanSort().isMixin()
- || elementType.getBeanSort().isVetoed()) {
+ || !elementType.getBeanSort().policy().isAllowedAsMemberElementType()) {
// ignore, as these cases are covered later by meta-model validation
return;
}
diff --git a/core/metamodel/src/main/java/org/apache/causeway/core/metamodel/services/classsubstitutor/ClassSubstitutorForDomainObjects.java b/core/metamodel/src/main/java/org/apache/causeway/core/metamodel/services/classsubstitutor/ClassSubstitutorForDomainObjects.java
index 4cb7efa50ae..d28a4cfce65 100644
--- a/core/metamodel/src/main/java/org/apache/causeway/core/metamodel/services/classsubstitutor/ClassSubstitutorForDomainObjects.java
+++ b/core/metamodel/src/main/java/org/apache/causeway/core/metamodel/services/classsubstitutor/ClassSubstitutorForDomainObjects.java
@@ -24,6 +24,8 @@ import jakarta.inject.Named;
import org.springframework.stereotype.Component;
import org.apache.causeway.applib.annotation.PriorityPrecedence;
+import org.apache.causeway.applib.services.metamodel.BeanSort;
+import org.apache.causeway.applib.services.metamodel.BeanSort.BeanPolicy;
import org.apache.causeway.core.config.beans.CausewayBeanMetaData;
import org.apache.causeway.core.config.beans.CausewayBeanTypeRegistry;
import org.apache.causeway.core.metamodel.CausewayModuleCoreMetamodel;
@@ -44,20 +46,14 @@ public class ClassSubstitutorForDomainObjects implements ClassSubstitutor {
@Override
public Substitution getSubstitution(@NonNull final Class<?> cls) {
-
- var beanSort = causewayBeanTypeRegistry.lookupIntrospectableType(cls)
- .map(CausewayBeanMetaData::beanSort)
- .orElse(null);
-
- if(beanSort!=null) {
- if(beanSort.isEntity()
- || beanSort.isViewModel()
- || beanSort.isManagedBeanAny()) {
- return Substitution.neverReplaceClass();
- }
- }
-
- return Substitution.passThrough(); // indifferent
+ var notSubstitutable = causewayBeanTypeRegistry.lookupIntrospectableType(cls)
+ .map(CausewayBeanMetaData::beanSort)
+ .map(BeanSort::policy)
+ .map(BeanPolicy::isNotSubstitutable)
+ .orElse(false);
+ return notSubstitutable
+ ? Substitution.neverReplaceClass()
+ : Substitution.passThrough(); // indifferent
}
}
diff --git a/core/metamodel/src/main/java/org/apache/causeway/core/metamodel/spec/ObjectSpecification.java b/core/metamodel/src/main/java/org/apache/causeway/core/metamodel/spec/ObjectSpecification.java
index 043c249e697..bb302f218b6 100644
--- a/core/metamodel/src/main/java/org/apache/causeway/core/metamodel/spec/ObjectSpecification.java
+++ b/core/metamodel/src/main/java/org/apache/causeway/core/metamodel/spec/ObjectSpecification.java
@@ -410,17 +410,17 @@ extends
/**
* Whether represents a bean, that is a managed bean
* with scoped life-cycle, available for dependency injection.
- * <p>
- * DANGER: don't call during MM introspection
- * @apiNote this predicate might not be valid until all services
- * have been discovered and the application context has settled
*/
- boolean isInjectable();
+ default boolean isInjectable() {
+ return getBeanSort().policy().isInjectable();
+ }
/**
* Whether represents a bean, that is in effect annotated with {@link DomainService}.
*/
- boolean isDomainService();
+ default boolean isDomainService() {
+ return getBeanSort().isManagedBeanContributing();
+ }
default boolean isMixin() {
return getBeanSort().isMixin();
diff --git a/core/metamodel/src/main/java/org/apache/causeway/core/metamodel/specloader/SpecificationLoaderDefault.java b/core/metamodel/src/main/java/org/apache/causeway/core/metamodel/specloader/SpecificationLoaderDefault.java
index 2872b81911f..a123c6edd81 100644
--- a/core/metamodel/src/main/java/org/apache/causeway/core/metamodel/specloader/SpecificationLoaderDefault.java
+++ b/core/metamodel/src/main/java/org/apache/causeway/core/metamodel/specloader/SpecificationLoaderDefault.java
@@ -272,16 +272,13 @@ implements
.forEach(typeMeta->{
var spec = primeSpecification(typeMeta);
- if(spec==null) {
- //XXX only ever happens when the class substitutor vetoes
- return;
- }
+ if(spec==null) return; // substitutor veto
knownSpecs.add(spec);
var sort = typeMeta.beanSort();
- if(sort.isManagedBeanAny() || sort.isEntity() || sort.isViewModel() ) {
+ if(sort.isManagedBeanContributing() || sort.isEntity() || sort.isViewModel() ) {
domainObjectSpecs.add(spec);
} else if(sort.isMixin()) {
mixinSpecs.add(spec);
diff --git a/core/runtimeservices/src/main/java/org/apache/causeway/core/runtimeservices/wrapper/WrapperFactoryDefault.java b/core/runtimeservices/src/main/java/org/apache/causeway/core/runtimeservices/wrapper/WrapperFactoryDefault.java
index 44a98da2981..67f18af9453 100644
--- a/core/runtimeservices/src/main/java/org/apache/causeway/core/runtimeservices/wrapper/WrapperFactoryDefault.java
+++ b/core/runtimeservices/src/main/java/org/apache/causeway/core/runtimeservices/wrapper/WrapperFactoryDefault.java
@@ -561,7 +561,7 @@ implements WrapperFactory, HasMetaModelContext {
var adapter = getObjectManager().adapt(domainObject);
if(ManagedObjects.isNullOrUnspecifiedOrEmpty(adapter)
- || !adapter.getSpecification().getBeanSort().isWrappingSupported()) {
+ || !adapter.getSpecification().getBeanSort().policy().isWrappingSupported()) {
throw _Exceptions.illegalArgument("Cannot wrap an object of type %s",
domainObject.getClass().getName());
}
diff --git a/viewers/wicket/ui/src/main/java/org/apache/causeway/viewer/wicket/ui/pages/PageAbstract.java b/viewers/wicket/ui/src/main/java/org/apache/causeway/viewer/wicket/ui/pages/PageAbstract.java
index 42d09284787..6c4e8f74d41 100644
--- a/viewers/wicket/ui/src/main/java/org/apache/causeway/viewer/wicket/ui/pages/PageAbstract.java
+++ b/viewers/wicket/ui/src/main/java/org/apache/causeway/viewer/wicket/ui/pages/PageAbstract.java
@@ -418,7 +418,7 @@ implements ActionPromptProvider {
}
var dialogMode =
- sort.isManagedBeanAny()
+ sort.policy().isInjectable()
? getWicketViewerSettings().getDialogModeForMenu()
: getWicketViewerSettings().getDialogMode();
switch (dialogMode) {