DomainKind.getKindReservedPropertyNames

Author: labkey-nicka

api/src/org/labkey/api/audit/query/AbstractAuditDomainKind.java

@@ -298,7 +298,7 @@ public boolean hasNullValues(Domain domain, DomainProperty prop)
     }
 
     @Override
-    public @NotNull Set<String> getReservedPropertyNames(Domain domain, User user)
+    protected @NotNull Set<String> getKindReservedPropertyNames(Domain domain, User user, boolean forCreate)
     {
         Set<String> names = new HashSet<>();
 

api/src/org/labkey/api/exp/api/SampleTypeDomainKind.java

@@ -261,16 +261,9 @@ public Set<PropertyStorageSpec> getBaseProperties(Domain domain)
     }
 
     @Override
-    public @NotNull Set<String> getReservedPropertyNames(Domain domain, User user)
-    {
-        return getReservedPropertyNames(domain, user, false);
-    }
-
-    @Override
-    public @NotNull Set<String> getReservedPropertyNames(Domain domain, User user, boolean forCreate)
+    protected @NotNull Set<String> getKindReservedPropertyNames(Domain domain, User user, boolean forCreate)
     {
         Set<String> reserved = new CaseInsensitiveHashSet(RESERVED_NAMES);
-        reserved.addAll(getTemplateReservedPropertyNames(domain));
 
         if (domain == null)
         {

api/src/org/labkey/api/exp/property/DomainKind.java

@@ -109,23 +109,41 @@ public Map<String, Object> processArguments(Container container, User user, Map<
 
     /**
      * Return the set of names that should not be allowed for properties. E.g., the names of columns
-     * from the hard table underlying this type.
+     * from the hard table underlying this type, unioned with any names declared in the
+     * {@link DomainTemplate}'s {@code <reservedColumnNames>} element that this domain was created from.
      * <p>
-     * Subclasses should typically override this method and union their kind-specific reserved set with
-     * {@link #getTemplateReservedPropertyNames(Domain)} (or with {@code super.getReservedPropertyNames(...)}
-     * when the override does not also override the {@code forCreate} variant). Doing so ensures that
-     * names declared in a {@code DomainTemplate}'s {@code <reservedColumnNames>} element are honored.
+     * This method is {@code final}; subclasses contribute their kind-specific reserved set by overriding
+     * {@link #getKindReservedPropertyNames(Domain, User, boolean)}. The base class always unions that
+     * set with the template-declared set.
      *
      * @return set of strings containing the names. This will be compared ignoring case
      */
-    public Set<String> getReservedPropertyNames(Domain domain, User user)
+    public final Set<String> getReservedPropertyNames(Domain domain, User user)
     {
-        return getTemplateReservedPropertyNames(domain);
+        return getReservedPropertyNames(domain, user, false);
     }
 
-    public Set<String> getReservedPropertyNames(Domain domain, User user, boolean forCreate)
+    public final Set<String> getReservedPropertyNames(Domain domain, User user, boolean forCreate)
     {
-        return getReservedPropertyNames(domain, user);
+        Set<String> reserved = new CaseInsensitiveHashSet(getKindReservedPropertyNames(domain, user, forCreate));
+        reserved.addAll(getTemplateReservedPropertyNames(domain));
+        return reserved;
+    }
+
+    /**
+     * Return the kind-specific set of names that should not be allowed for properties. Subclasses override
+     * this to contribute their static/hard-coded reserved names. The base class will automatically union
+     * the result with any names declared in the {@link DomainTemplate}'s {@code <reservedColumnNames>}
+     * element via {@link #getReservedPropertyNames(Domain, User, boolean)}.
+     *
+     * @param forCreate true when validating names during domain creation; some kinds reserve additional
+     *                  names only at creation time.
+     * @return set of strings containing the names.
+     */
+    @NotNull
+    protected Set<String> getKindReservedPropertyNames(Domain domain, User user, boolean forCreate)
+    {
+        return Collections.emptySet();
     }
 
     /**

api/src/org/labkey/api/exp/property/TestDomainKind.java

@@ -148,7 +148,7 @@ public void deletePropertyDescriptor(Domain domain, User user, PropertyDescripto
     }
 
     @Override
-    public @NotNull Set<String> getReservedPropertyNames(Domain domain, User user)
+    protected @NotNull Set<String> getKindReservedPropertyNames(Domain domain, User user, boolean forCreate)
     {
         throw new UnsupportedOperationException();
     }

api/src/org/labkey/api/query/SimpleTableDomainKind.java

@@ -236,7 +236,7 @@ public boolean canCreateDefinition(User user, Container container)
     }
 
     @Override
-    public @NotNull Set<String> getReservedPropertyNames(Domain domain, User user)
+    protected @NotNull Set<String> getKindReservedPropertyNames(Domain domain, User user, boolean forCreate)
     {
         SimpleUserSchema.SimpleTable table = domain != null ? getTable(domain, user) : null;
         if (table != null)

assay/api-src/org/labkey/api/assay/AssayBatchDomainKind.java

@@ -25,10 +25,6 @@
 import java.util.Arrays;
 import java.util.Set;
 
-/**
- * User: jeckels
- * Date: Jan 27, 2012
- */
 public class AssayBatchDomainKind extends AssayDomainKind
 {
     private static final Set<String> RESERVED_NAMES;
@@ -50,7 +46,7 @@ public String getKindName()
     }
 
     @Override
-    public @NotNull Set<String> getReservedPropertyNames(Domain domain, User user)
+    protected @NotNull Set<String> getKindReservedPropertyNames(Domain domain, User user, boolean forCreate)
     {
         return RESERVED_NAMES;
     }

assay/api-src/org/labkey/api/assay/AssayResultDomainKind.java

@@ -127,7 +127,7 @@ public DbSchema getSchema()
     }
 
     @Override
-    public @NotNull Set<String> getReservedPropertyNames(Domain domain, User user)
+    protected @NotNull Set<String> getKindReservedPropertyNames(Domain domain, User user, boolean forCreate)
     {
         return RESERVED_NAMES;
     }

assay/api-src/org/labkey/api/assay/AssayRunDomainKind.java

@@ -53,7 +53,7 @@ public String getKindName()
     }
 
     @Override
-    public @NotNull Set<String> getReservedPropertyNames(Domain domain, User user)
+    protected @NotNull Set<String> getKindReservedPropertyNames(Domain domain, User user, boolean forCreate)
     {
         return RESERVED_NAMES;
     }

assay/src/org/labkey/assay/DefaultAssayDomainKind.java

@@ -43,7 +43,7 @@ public String getKindName()
     }
 
     @Override
-    public @NotNull Set<String> getReservedPropertyNames(Domain domain, User user)
+    protected @NotNull Set<String> getKindReservedPropertyNames(Domain domain, User user, boolean forCreate)
     {
         return getAssayReservedPropertyNames();
     }

assay/src/org/labkey/assay/PlateBasedAssaySampleTypeDomainKind.java

@@ -55,12 +55,6 @@ public String getKindName()
             {
                 return null;
             }
-
-            @Override
-            public @NotNull Set<String> getReservedPropertyNames(Domain domain, User user)
-            {
-                return Collections.emptySet();
-            }
         };
     }