MID-9278 display (deprecating embedded=true/false) annotation integrated

Evolveum · Nov 13, 2023 · d91889e · d91889e
1 parent 77a8fc3
commit d91889e
Show file tree

Hide file tree

Showing 8 changed files with 37 additions and 15 deletions.
diff --git a/infra/prism-api/src/main/java/com/evolveum/midpoint/prism/Definition.java b/infra/prism-api/src/main/java/com/evolveum/midpoint/prism/Definition.java
@@ -133,6 +133,8 @@ default boolean isIgnored() {
      */
     boolean isEmphasized();
 
+    DisplayHint getDisplay();
+
     /**
      * Returns display name.
      *

diff --git a/.../com/evolveum/midpoint/prism/Display.java → .../evolveum/midpoint/prism/DisplayHint.java b/.../com/evolveum/midpoint/prism/Display.java → .../evolveum/midpoint/prism/DisplayHint.java
@@ -14,7 +14,7 @@
  *
  * "display" annotation enumeration also replaces emphasized=true.
  */
-public enum Display {
+public enum DisplayHint {
 
     /**
      * Item shouldn't be visible.
@@ -43,11 +43,11 @@ public enum Display {
 
     final String value;
 
-    Display(final String value) {
+    DisplayHint(final String value) {
         this.value = value;
     }
 
-    public static Display findByValue(String value) {
+    public static DisplayHint findByValue(String value) {
         if (value == null) {
             return null;
         }

diff --git a/infra/prism-api/src/main/java/com/evolveum/midpoint/prism/MutableDefinition.java b/infra/prism-api/src/main/java/com/evolveum/midpoint/prism/MutableDefinition.java
@@ -28,6 +28,8 @@ public interface MutableDefinition extends Definition {
 
     void setEmphasized(boolean emphasized);
 
+    void setDisplay(DisplayHint display);
+
     void setDisplayName(String displayName);
 
     void setDisplayOrder(Integer displayOrder);

diff --git a/infra/prism-api/src/main/java/com/evolveum/midpoint/prism/deleg/DefinitionDelegator.java b/infra/prism-api/src/main/java/com/evolveum/midpoint/prism/deleg/DefinitionDelegator.java
@@ -13,14 +13,10 @@
 
 import javax.xml.namespace.QName;
 
+import com.evolveum.midpoint.prism.*;
+
 import org.jetbrains.annotations.NotNull;
 
-import com.evolveum.midpoint.prism.Definition;
-import com.evolveum.midpoint.prism.ItemProcessing;
-import com.evolveum.midpoint.prism.PrismContext;
-import com.evolveum.midpoint.prism.SchemaMigration;
-import com.evolveum.midpoint.prism.SmartVisitation;
-import com.evolveum.midpoint.prism.Visitor;
 import com.evolveum.midpoint.prism.schema.SchemaRegistry;
 
 import org.jetbrains.annotations.Nullable;
@@ -123,6 +119,10 @@ default String getDeprecatedSince() {
         return delegate().getDeprecatedSince();
     }
 
+    @Override
+    default DisplayHint getDisplay() {
+        return delegate().getDisplay();
+    }
     @Override
     default boolean isEmphasized() {
         return delegate().isEmphasized();

diff --git a/infra/prism-impl/src/main/java/com/evolveum/midpoint/prism/impl/DefinitionImpl.java b/infra/prism-impl/src/main/java/com/evolveum/midpoint/prism/impl/DefinitionImpl.java
@@ -51,6 +51,7 @@ public abstract class DefinitionImpl extends AbstractFreezable implements Mutabl
     @NotNull protected QName typeName;
     protected ItemProcessing processing;
     protected boolean isAbstract = false;
+    protected DisplayHint display;
     protected String displayName;
     protected Integer displayOrder;
     protected String help;
@@ -201,6 +202,18 @@ public void setElaborate(boolean elaborate) {
         setAnnotation(PrismConstants.A_ELABORATE, elaborate);
     }
 
+    @Override
+    public DisplayHint getDisplay() {
+        return display;
+    }
+
+    @Override
+    public void setDisplay(DisplayHint display) {
+        checkMutable();
+        this.display = display;
+        setAnnotation(PrismConstants.A_DISPLAY, display);
+    }
+
     @Override
     public boolean isEmphasized() {
         return emphasized;
@@ -210,7 +223,7 @@ public boolean isEmphasized() {
     public void setEmphasized(boolean emphasized) {
         checkMutable();
         this.emphasized = emphasized;
-        setAnnotation(PrismConstants.A_DISPLAY, emphasized ? Display.EMPHASIZED : null);
+        setAnnotation(PrismConstants.A_DISPLAY, emphasized ? DisplayHint.EMPHASIZED : null);
     }
 
     @Override

diff --git a/...prism-impl/src/main/java/com/evolveum/midpoint/prism/impl/DummyPrismObjectDefinition.java b/...prism-impl/src/main/java/com/evolveum/midpoint/prism/impl/DummyPrismObjectDefinition.java
@@ -27,6 +27,11 @@
 @Experimental
 public class DummyPrismObjectDefinition implements PrismObjectDefinition<Objectable> {
 
+    @Override
+    public DisplayHint getDisplay() {
+        throw new UnsupportedOperationException();
+    }
+
     @NotNull
     @Override
     public ItemName getItemName() {

diff --git a/infra/prism-impl/src/main/java/com/evolveum/midpoint/prism/impl/schema/Annotation.java b/infra/prism-impl/src/main/java/com/evolveum/midpoint/prism/impl/schema/Annotation.java
@@ -11,7 +11,7 @@
 
 import javax.xml.namespace.QName;
 
-import com.evolveum.midpoint.prism.Display;
+import com.evolveum.midpoint.prism.DisplayHint;
 
 import com.sun.xml.xsom.XSAnnotation;
 import org.jetbrains.annotations.NotNull;
@@ -49,11 +49,11 @@ public enum Annotation {
     @Deprecated
     EMPHASIZED(A_EMPHASIZED, Boolean.class, true),
 
-    DISPLAY(A_DISPLAY, Display.class, null, new AnnotationProcessor() {
+    DISPLAY(A_DISPLAY, DisplayHint.class, null, new AnnotationProcessor() {
 
         @Override
         protected @Nullable Object convert(@NotNull Annotation annotation, @NotNull Element element) {
-            return Display.findByValue(element.getTextContent());
+            return DisplayHint.findByValue(element.getTextContent());
         }
     }),
 

diff --git a/infra/prism-impl/src/main/resources/xml/ns/public/annotation-3.xsd b/infra/prism-impl/src/main/resources/xml/ns/public/annotation-3.xsd
@@ -163,7 +163,7 @@
         </xsd:annotation>
     </xsd:element>
 
-    <xsd:element name="display" type="tns:DisplayType">
+    <xsd:element name="display" type="tns:DisplayHintType">
         <xsd:annotation>
             <xsd:documentation>
                 Enumeration annotation that specifies how the item should be displayed.
@@ -173,7 +173,7 @@
         </xsd:annotation>
     </xsd:element>
 
-    <xsd:simpleType name="DisplayType">
+    <xsd:simpleType name="DisplayHintType">
         <xsd:annotation>
             <xsd:documentation>
                 Display hints for an item.