Changeset 7496

Timestamp:

Jul 11, 2018, 2:42:30 PM (5 years ago)

Author:

Nicklas Nordborg

Message:

References #2125: Add support for hidden extended properties

It is now possible to set "hidden" attribute for an extended property. Hidden properties are usually not visible in the interface. They can still be modified via extensions or plug-ins.

Location:

trunk

Files:

• src/core/net/sf/basedb/core/ClonableProperty.java (modified) (3 diffs)
• src/core/net/sf/basedb/core/ExtendedProperties.java (modified) (13 diffs)
• src/core/net/sf/basedb/core/ExtendedProperty.java (modified) (4 diffs)
• src/core/net/sf/basedb/core/HibernateUtil.java (modified) (1 diff)
• src/core/net/sf/basedb/core/RawDataProperty.java (modified) (1 diff)
• src/core/net/sf/basedb/core/ReporterBatcher.java (modified) (1 diff)
• src/core/net/sf/basedb/core/SessionControl.java (modified) (1 diff)
• src/core/net/sf/basedb/core/dtd/extended-properties.dtd (modified) (1 diff)
• www/admin/users/edit_user.jsp (modified) (2 diffs)
• www/admin/users/index.jsp (modified) (2 diffs)
• www/my_base/user/submit_user.jsp (modified) (2 diffs)
• www/views/reporters/edit_reporter.jsp (modified) (1 diff)
• www/views/reporters/index.jsp (modified) (2 diffs)

trunk/src/core/net/sf/basedb/core/ClonableProperty.java

@@ -250 +250 @@
     super(propertyName, title, description, column, 
       valueType, length, nullable, true, true, 
-      false, averageMethod, null);
+      false, false, averageMethod, null);
     this.isExtendedProperty = false;
     this.isMandatory = isMandatory;
@@ -263 +263 @@
     super(p.getName(), p.getTitle(), p.getDescription(), p.getColumn(), 
       p.getType(), p.getLength(), p.isNullable(), true, true, 
-      false, p.getAverageMethod(), null);
+      false, false, p.getAverageMethod(), null);
     this.isExtendedProperty = true;
     this.isMandatory = false;
@@ -278 +278 @@
     super(propertyName, d.getTitle(), d.getDescription(), d.getColumn(),
       Type.fromValue(d.getValueType()), d.getLength(), d.isNullable(), true, true,
-      false, AverageMethod.fromValue(d.getAverageMethod()), null);
+      false, false, AverageMethod.fromValue(d.getAverageMethod()), null);
     this.isExtendedProperty = d.isExtendedProperty();
     this.isMandatory = d.isMandatory();

trunk/src/core/net/sf/basedb/core/ExtendedProperties.java

@@ -31 +31 @@
 import java.util.List;
 import java.util.ArrayList;
+import java.util.Collections;
 import java.util.Map;
 import java.util.HashMap;
@@ -73 +74 @@
 
   /**
+    A map from class name --> a list of extended properties of for
+    that class. The list holds {@link ExtendedProperty} objects that 
+    are not hidden.
+    @since 3.13
+  */
+  private static Map<String, List<ExtendedProperty>> visibleProperties = null;
+
+  
+  /**
     The DTD which is used to validate the XML file.
   */
@@ -89 +99 @@
     classes = new ArrayList<String>();
     allProperties = new HashMap<String, List<ExtendedProperty>>();
+    visibleProperties = new HashMap<String, List<ExtendedProperty>>();
     loadExtendedPropertiesFile();
     isInitialised = true;
@@ -102 +113 @@
     if (allProperties != null) allProperties.clear();
     allProperties = null;
+    if (visibleProperties != null) visibleProperties.clear();
+    visibleProperties = null;
     isInitialised = false;
   }
@@ -107 +120 @@
   /**
     Load and parse the file with predefined queries.
-    This method will populate the {@link #classes} and
-    {@link #allProperties} variables.
+    This method will populate the {@link #classes}, 
+    {@link #allProperties} and {@link #visibleProperties} variables.
   */
   private static synchronized void loadExtendedPropertiesFile()
@@ -159 +172 @@
 
   /**
-    Get a list of extended properties for the specified class.
+    Get a list of extended properties for the specified class. Hidden
+    properties (introduced in BASE 3.13) are not included.
+    
     @param className The name of the class with or without
       the package name
@@ -168 +183 @@
   public static List<ExtendedProperty> getProperties(String className)
   {
+    return getProperties(className, false);
+  }
+
+  /**
+    Get a list of extended properties for the specified class. 
+    
+    @param className The name of the class with or without
+      the package name
+    @param includeHidden A flag to indicate if hidden properties should be included or not
+    @return A <code>List</code> object containing {@link ExtendedProperty}
+      objects, or null if the specified class is not extendable or
+      no extended properties has been defined
+    @since 3.13
+  */
+  public static List<ExtendedProperty> getProperties(String className, boolean includeHidden)
+  {
     int index = className.lastIndexOf(".");
     if (index >= 0)
@@ -173 +204 @@
       className = className.substring(index+1);
     }
-    return allProperties.get(className);
+    List<ExtendedProperty> properties = includeHidden ? allProperties.get(className) : visibleProperties.get(className);
+    return properties == null ? null : Collections.unmodifiableList(properties);
   }
 
@@ -186 +218 @@
   public static ExtendedProperty getProperty(String className, String property)
   {
-    List<ExtendedProperty> l = getProperties(className);
+    List<ExtendedProperty> l = getProperties(className, true);
     if (l == null) return null;
     for (ExtendedProperty e : l)
@@ -209 +241 @@
         classes.add(className);
         allProperties.put(className, new ArrayList<ExtendedProperty>());
+        visibleProperties.put(className, new ArrayList<ExtendedProperty>());
       }
       loadProperties(usedNames, el, xmlFile);
@@ -222 +255 @@
     String className = classElement.getAttributeValue("name");
     List<ExtendedProperty> properties = allProperties.get(className);
+    List<ExtendedProperty> visible = visibleProperties.get(className);
     List<Element> children = classElement.getChildren("property");
     DbEngine engine = HibernateUtil.getDbEngine();
@@ -262 +296 @@
       boolean updateable = XmlUtil2.getBooleanAttribute(property, "update", true);
       boolean restrictedEdit = XmlUtil2.getBooleanAttribute(property, "restricted-edit", false);
+      boolean hidden = XmlUtil2.getBooleanAttribute(property, "hidden", false);
       String avgMethod = property.getAttributeValue("averagemethod");
       Formula.AverageMethod averageMethod = null;
@@ -302 +337 @@
         }
       }
-      properties.add(new ExtendedProperty(name, title, description, column, type, length, nullable, insertable, updateable, restrictedEdit, averageMethod, epLinks));
+      ExtendedProperty ep = new ExtendedProperty(name, title, description, column, type, length, nullable, insertable, updateable, restrictedEdit, hidden, averageMethod, epLinks);
+      properties.add(ep);
+      if (!hidden) visible.add(ep);
     }
   }

trunk/src/core/net/sf/basedb/core/ExtendedProperty.java

@@ -67 +67 @@
   private final boolean updateable;
   private final boolean restrictedEdit;
+  private final boolean hidden;
   private final Formula.AverageMethod averageMethod;
   private final List<ExtendedPropertyLinker> linkers;
@@ -76 +77 @@
   ExtendedProperty(String name, String title, String description, String column,
     Type type, int length, boolean nullable, boolean insertable, boolean updateable, 
-    boolean restrictedEdit,
+    boolean restrictedEdit, boolean hidden,
     Formula.AverageMethod averageMethod, List<ExtendedPropertyLinker> linkers)
   {
@@ -89 +90 @@
     this.updateable = updateable;
     this.restrictedEdit = restrictedEdit;
+    this.hidden = hidden;
     this.averageMethod = averageMethod;
     this.linkers = linkers;
@@ -191 +193 @@
   {
     return restrictedEdit;
+  }
+  
+  /**
+    Check if the value of this property is hidden or not. Hidden properties should
+    normally not show up in user interfaces that have not been specifically designed
+    to work with the property.
+    @since 3.13
+  */
+  public boolean isHidden()
+  {
+    return hidden;
   }
 

trunk/src/core/net/sf/basedb/core/HibernateUtil.java

@@ -448 +448 @@
   {
     log.info("Adding extended properties to class: " + className);
-    List<ExtendedProperty> properties = ExtendedProperties.getProperties(className);
+    List<ExtendedProperty> properties = ExtendedProperties.getProperties(className, true);
 
     for (ExtendedProperty property : properties)

trunk/src/core/net/sf/basedb/core/RawDataProperty.java

@@ -44 +44 @@
     Type type, int length, boolean nullable, Formula.AverageMethod averageMethod, int channel)
   {
-    super(name, title, description, column, type, length, nullable, true, false, false, averageMethod, null);
+    super(name, title, description, column, type, length, nullable, true, false, false, false, averageMethod, null);
     this.channel = channel;
   }

trunk/src/core/net/sf/basedb/core/ReporterBatcher.java

@@ -90 +90 @@
     super(dc.getHibernateSession(), ReporterData.class, null);
     entryDate = new Date();
-    extendedProperties = ExtendedProperties.getProperties("ReporterData");
+    extendedProperties = ExtendedProperties.getProperties("ReporterData", true);
     batchedExternalIds = HibernateUtil.getDbEngine().caseInsensitiveComparison() ?
       new TreeSet<String>(String.CASE_INSENSITIVE_ORDER) : new HashSet<String>();

trunk/src/core/net/sf/basedb/core/SessionControl.java

@@ -779 +779 @@
       userData.setDescription(extraInfo.getDescription());
       
-      List<ExtendedProperty> properties = ExtendedProperties.getProperties("UserData");
+      List<ExtendedProperty> properties = ExtendedProperties.getProperties("UserData", true);
       if (properties != null)
       {

trunk/src/core/net/sf/basedb/core/dtd/extended-properties.dtd

@@ -43 +43 @@
   averagemethod (none|arithmetic_mean|geometric_mean|quadratic_mean|min|max) #IMPLIED
   restricted-edit (true|false) "false"
+  hidden (true|false) "false"
 >
 

trunk/www/admin/users/edit_user.jsp

@@ -286 +286 @@
     <input type="hidden" name="cmd" value="UpdateItem">
     <input type="hidden" name="item_id" value="<%=itemId%>">
-
+    
     <t:tabcontrol id="settings"
       subclass="content dialogtabcontrol"
@@ -557 +557 @@
         <table class="fullform input100">
           <%
-            for (ExtendedProperty ep : ExtendedProperties.getProperties("UserData"))
+            for (ExtendedProperty ep : extendedProperties)
             {
               String name = ep.getName();

trunk/www/admin/users/index.jsp

@@ -72 +72 @@
   import="java.util.ArrayList"
   import="java.util.Collections"
+  import="java.util.Map"
 %>
 <%@ taglib prefix="base" uri="/WEB-INF/base.tld" %>
@@ -258 +259 @@
       
       // Extended properties
-      List<ExtendedProperty> extendedProperties = ExtendedProperties.getProperties("UserData");
+      List<ExtendedProperty> extendedProperties = ExtendedProperties.getProperties("UserData", true);
       if (extendedProperties != null)
       {
+        Map<String, String[]> parameters = request.getParameterMap();
         for (ExtendedProperty ep : extendedProperties)
         {
           String name = ep.getName();
-          Formatter formatter = FormatterFactory.getExtendedPropertyFormatter(sc, ep);
-          Object value = formatter.parseString(Values.getStringOrNull(request.getParameter("ep."+name)));
-          user.setExtended(name, value);
+          if (parameters.containsKey("ep."+name))
+          {
+            Formatter formatter = FormatterFactory.getExtendedPropertyFormatter(sc, ep);
+            Object value = formatter.parseString(Values.getStringOrNull(request.getParameter("ep."+name)));
+            user.setExtended(name, value);
+          }
         }
       }

trunk/www/my_base/user/submit_user.jsp

@@ -50 +50 @@
   import="java.util.Collections"
   import="java.util.List"
+  import="java.util.Map"
 %>
 <%@ taglib prefix="base" uri="/WEB-INF/base.tld" %>
@@ -103 +104 @@
 
     // Extended properties
-    List<ExtendedProperty> extendedProperties = ExtendedProperties.getProperties("UserData");
+    List<ExtendedProperty> extendedProperties = ExtendedProperties.getProperties("UserData", true);
     if (extendedProperties != null)
     {
+      Map<String, String[]> parameters = request.getParameterMap();
       for (ExtendedProperty ep : extendedProperties)
       {
         if (ep.isRestrictedEdit()) continue;
-        String name = ep.getName();
-        Formatter formatter = FormatterFactory.getExtendedPropertyFormatter(sc, ep);
-        Object value = formatter.parseString(Values.getStringOrNull(request.getParameter("ep."+name)));
-        user.setExtended(name, value);
+        if (parameters.containsKey("ep."+name))
+        {
+          String name = ep.getName();
+          Formatter formatter = FormatterFactory.getExtendedPropertyFormatter(sc, ep);
+          Object value = formatter.parseString(Values.getStringOrNull(request.getParameter("ep."+name)));
+          user.setExtended(name, value);
+        }
       }
     }

trunk/www/views/reporters/edit_reporter.jsp

@@ -236 +236 @@
         if (reporterProperties != null)
         {
-          for (ExtendedProperty ep : ExtendedProperties.getProperties("ReporterData"))
+          for (ExtendedProperty ep : reporterProperties)
           {
             String name = ep.getName();

trunk/www/views/reporters/index.jsp

@@ -58 +58 @@
   import="java.util.Enumeration"
   import="java.util.List"
+  import="java.util.Map"
 %>
 <%@ taglib prefix="base" uri="/WEB-INF/base.tld" %>
@@ -157 +158 @@
         if (rt != null) cc.setRecent(rt, maxRecent);
       }
-      List<ExtendedProperty> reporterProperties = ExtendedProperties.getProperties("ReporterData");
+      List<ExtendedProperty> reporterProperties = ExtendedProperties.getProperties("ReporterData", true);
       if (reporterProperties != null)
       {
+        Map<String, String[]> parameters = request.getParameterMap();
         for (ExtendedProperty ep : reporterProperties)
         {
           String name = ep.getName();
-          Formatter formatter = FormatterFactory.getExtendedPropertyFormatter(sc, ep);
-          Object value = formatter.parseString(Values.getStringOrNull(request.getParameter("ep."+name)));
-          reporter.setExtended(name, value);
+          if (parameters.containsKey("ep."+name))
+          {
+            Formatter formatter = FormatterFactory.getExtendedPropertyFormatter(sc, ep);
+            Object value = formatter.parseString(Values.getStringOrNull(request.getParameter("ep."+name)));
+            reporter.setExtended(name, value);
+          }
         }
       }