Completed MOB-876: Period control (based on new d:period data type)

- Removed temporary period control from DOD project
- Added proper period control based on new d:period type
- Added ability for a data type to return a set of parameters to describe it or its restrictions (used here to return the period provider definitions)

git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@14671 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261

source/java/org/alfresco/repo/forms/DataTypeParameters.java

@@ -0,0 +1,50 @@
+/*
+ * Copyright (C) 2005-2009 Alfresco Software Limited.
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation; either version 2
+ * of the License, or (at your option) any later version.
+
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+
+ * As a special exception to the terms and conditions of version 2.0 of 
+ * the GPL, you may redistribute this Program in connection with Free/Libre 
+ * and Open Source Software ("FLOSS") applications as described in Alfresco's 
+ * FLOSS exception.  You should have recieved a copy of the text describing 
+ * the FLOSS exception, and it is also available here: 
+ * http://www.alfresco.com/legal/licensing"
+ */
+package org.alfresco.repo.forms;
+
+/**
+ * Interface definition for an object used to represent any restrictions 
+ * a data type may enforce.
+ *
+ * @author Gavin Cornwell
+ */
+public interface DataTypeParameters
+{
+    /**
+     * Returns the parameters in a Java friendly manner i.e. as an Object.
+     * The Object can be as complex as a multiple nested Map of Maps or as
+     * simple as a String.
+     * 
+     * @return An Object representing the data type parameters
+     */
+    public Object getParameters();
+    
+    /**
+     * Returns the parameters in a REST API friendly manner i.e. as JSON.
+     * 
+     * @return JSON String representing the data type parameters
+     */
+    public String getParametersAsJSONString();
+}

source/java/org/alfresco/repo/forms/PropertyFieldDefinition.java

@@ -35,6 +35,7 @@ import java.util.Map;
 public class PropertyFieldDefinition extends FieldDefinition
 {
     protected String dataType;
+    protected DataTypeParameters dataTypeParams;
     protected boolean mandatory = false;
     protected boolean repeats = false;
     protected List<FieldConstraint> constraints;
@@ -62,6 +63,26 @@ public class PropertyFieldDefinition extends FieldDefinition
     {
         return this.dataType;
     }
+    
+    /**
+     * Returns the data type parameters for the field
+     * 
+     * @return DataTypeParameters object or null
+     */
+    public DataTypeParameters getDataTypeParameters()
+    {
+        return this.dataTypeParams;
+    }
+
+    /**
+     * Sets the data type parameters for the field
+     * 
+     * @param dataTypeParams The DataTypeParameters for the field
+     */
+    public void setDataTypeParameters(DataTypeParameters dataTypeParams)
+    {
+        this.dataTypeParams = dataTypeParams;
+    }
 
     /**
      * Determines if the property is mandatory
@@ -133,6 +154,7 @@ public class PropertyFieldDefinition extends FieldDefinition
         buffer.append(" (");
         buffer.append("name=").append(this.name);
         buffer.append(", dataType=").append(this.dataType);
+        buffer.append(", dataTypeParams=").append(this.dataTypeParams);
         buffer.append(", label=").append(this.label);
         buffer.append(", description=").append(this.description);
         buffer.append(", binding=").append(this.binding);

source/java/org/alfresco/repo/forms/processor/node/NodeFormProcessor.java

@@ -30,6 +30,7 @@ import java.util.Collections;
 import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
+import java.util.Set;
 import java.util.StringTokenizer;
 import java.util.regex.Matcher;
 import java.util.regex.Pattern;
@@ -64,6 +65,7 @@ import org.alfresco.service.cmr.repository.ContentData;
 import org.alfresco.service.cmr.repository.InvalidNodeRefException;
 import org.alfresco.service.cmr.repository.NodeRef;
 import org.alfresco.service.cmr.repository.NodeService;
+import org.alfresco.service.cmr.repository.Period;
 import org.alfresco.service.namespace.NamespaceService;
 import org.alfresco.service.namespace.QName;
 import org.alfresco.service.namespace.RegexQNamePattern;
@@ -597,6 +599,21 @@ public class NodeFormProcessor extends FilteredFormProcessor
         String dataKeyName = PROP_DATA_PREFIX + nameParts[0] + DATA_KEY_SEPARATOR + nameParts[1];
         fieldDef.setDataKeyName(dataKeyName);
         
+        // setup any parameters requried for the data type
+        if (propDef.getDataType().getName().equals(DataTypeDefinition.PERIOD))
+        {
+            // if the property data type is d:period we need to setup a data
+            // type parameters object to represent the options and rules
+            PeriodDataTypeParameters periodOptions = new PeriodDataTypeParameters();
+            Set<String> providers = Period.getProviderNames();
+            for (String provider : providers)
+            {
+                periodOptions.addPeriodProvider(Period.getProvider(provider));
+            }
+            
+            fieldDef.setDataTypeParameters(periodOptions);
+        }
+        
         // setup constraints for the property
         List<ConstraintDefinition> constraints = propDef.getConstraints();
         if (constraints != null && constraints.size() > 0)

source/java/org/alfresco/repo/forms/processor/node/PeriodDataTypeParameters.java

@@ -0,0 +1,220 @@
+/*
+ * Copyright (C) 2005-2009 Alfresco Software Limited.
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation; either version 2
+ * of the License, or (at your option) any later version.
+
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+
+ * As a special exception to the terms and conditions of version 2.0 of 
+ * the GPL, you may redistribute this Program in connection with Free/Libre 
+ * and Open Source Software ("FLOSS") applications as described in Alfresco's 
+ * FLOSS exception.  You should have recieved a copy of the text describing 
+ * the FLOSS exception, and it is also available here: 
+ * http://www.alfresco.com/legal/licensing"
+ */
+package org.alfresco.repo.forms.processor.node;
+
+import java.io.Serializable;
+import java.util.ArrayList;
+import java.util.List;
+
+import org.alfresco.repo.dictionary.types.period.Cron;
+import org.alfresco.repo.dictionary.types.period.Days;
+import org.alfresco.repo.dictionary.types.period.EndOfFinancialMonth;
+import org.alfresco.repo.dictionary.types.period.EndOfFinancialQuarter;
+import org.alfresco.repo.dictionary.types.period.EndOfFinancialYear;
+import org.alfresco.repo.dictionary.types.period.EndOfMonth;
+import org.alfresco.repo.dictionary.types.period.EndOfQuarter;
+import org.alfresco.repo.dictionary.types.period.EndOfYear;
+import org.alfresco.repo.dictionary.types.period.Months;
+import org.alfresco.repo.dictionary.types.period.NoPeriod;
+import org.alfresco.repo.dictionary.types.period.Quarters;
+import org.alfresco.repo.dictionary.types.period.Weeks;
+import org.alfresco.repo.dictionary.types.period.XMLDuration;
+import org.alfresco.repo.dictionary.types.period.Years;
+import org.alfresco.repo.forms.DataTypeParameters;
+import org.alfresco.service.cmr.repository.PeriodProvider;
+
+/**
+ * Represents the parameters for the period data type.
+ *
+ * @author Gavin Cornwell
+ */
+public class PeriodDataTypeParameters implements DataTypeParameters, Serializable
+{
+    private static final long serialVersionUID = -6158584544200642857L;
+    
+    protected List<PeriodProvider> providers;
+    
+    /**
+     * Default constructor
+     */
+    public PeriodDataTypeParameters()
+    {
+        this.providers = new ArrayList<PeriodProvider>(8);
+    }
+    
+    /**
+     * Adds a PeriodProvider
+     * 
+     * @param pp The PeriodProvider to add
+     */
+    public void addPeriodProvider(PeriodProvider pp)
+    {
+        // the XML and cron period types are for future use so don't 
+        // return them for now
+        if (pp.getPeriodType() != XMLDuration.PERIOD_TYPE &&
+            pp.getPeriodType() != Cron.PERIOD_TYPE)
+        {
+            this.providers.add(pp);
+        }
+    }
+    
+    /**
+     * Retrieves a List of PeriodProvider objects representing
+     * the valid period options for the property 
+     * 
+     * @see org.alfresco.repo.forms.DataTypeParameters#getParameters()
+     * @return List of PeriodProvider objects
+     */
+    public Object getParameters()
+    {
+        return this.providers;
+    }
+
+    /**
+     * Retrieves a JSON array representing the valid period options 
+     * for the property
+     * 
+     * @see org.alfresco.repo.forms.DataTypeParameters#getParametersAsJSONString()
+     * @return A JSON string representing the period options for the property
+     */
+    public String getParametersAsJSONString()
+    {
+        StringBuilder builder = new StringBuilder("[\n");
+        
+        boolean isFirst = true;
+        for (PeriodProvider pp : this.providers)
+        {
+            if (isFirst == false)
+            {
+                builder.append(",\n");
+            }
+            else
+            {
+                isFirst = false;
+            }
+            
+            boolean hasExpression = !(pp.getExpressionMutiplicity().equals(PeriodProvider.ExpressionMutiplicity.NONE)); 
+            
+            builder.append("{ \"type\" : \"").append(pp.getPeriodType()).append("\",");
+            builder.append(" \"label\" : \"").append(getPeriodTypeLabel(pp)).append("\",");
+            builder.append(" \"hasExpression\" : ").append(hasExpression);
+            if (hasExpression)
+            {
+                builder.append(", \"expressionMandatory\" : ").append(
+                        pp.getExpressionMutiplicity().equals(PeriodProvider.ExpressionMutiplicity.MANDATORY)).append(",");
+                builder.append(" \"expressionType\" : \"").append(pp.getExpressionDataType().toPrefixString()).append("\",");
+                builder.append(" \"defaultExpression\" : \"").append(pp.getDefaultExpression()).append("\"");
+            }
+            builder.append(" }");
+        }
+        
+        builder.append("\n]");
+        
+        return builder.toString();
+    }
+    
+    /*
+     * @see java.lang.Object#toString()
+     */
+    @Override
+    public String toString()
+    {
+        // NOTE: Until the script and REST API for the form service is
+        // made a little less generic toString() will be called for these
+        // objects, we'll therefore temporarily return the result of
+        // getParametersAsJSONString() from here, eventually the js/ftl 
+        // will call it directly.
+        return getParametersAsJSONString();
+    }
+    
+    protected String getPeriodTypeLabel(PeriodProvider pp)
+    {
+        // TODO: The label for the period should be localisable
+        //       and returned via the PeriodProvider, for now
+        //       we will provide them here.
+        
+        String type = pp.getPeriodType();
+        String label = type;
+        
+        if (Cron.PERIOD_TYPE.equals(type))
+        {
+            label = "Cron Expression";
+        }
+        else if (Days.PERIOD_TYPE.equals(type))
+        {
+            label = "Days";
+        }
+        else if (EndOfFinancialMonth.PERIOD_TYPE.equals(type))
+        {
+            label = "End Of Financial Month";
+        }
+        else if (EndOfFinancialQuarter.PERIOD_TYPE.equals(type))
+        {
+            label = "End Of Financial Quarter";
+        }
+        else if (EndOfFinancialYear.PERIOD_TYPE.equals(type))
+        {
+            label = "End Of Financial Year";
+        }
+        else if (EndOfMonth.PERIOD_TYPE.equals(type))
+        {
+            label = "End Of Month";
+        }
+        else if (EndOfQuarter.PERIOD_TYPE.equals(type))
+        {
+            label = "End Of Quarter";
+        }
+        else if (EndOfYear.PERIOD_TYPE.equals(type))
+        {
+            label = "End Of Year";
+        }
+        else if (Months.PERIOD_TYPE.equals(type))
+        {
+            label = "Month";
+        }
+        else if (NoPeriod.PERIOD_TYPE.equals(type))
+        {
+            label = "None";
+        }
+        else if (Quarters.PERIOD_TYPE.equals(type))
+        {
+            label = "Quarter";
+        }
+        else if (Weeks.PERIOD_TYPE.equals(type))
+        {
+            label = "Week";
+        }
+        else if (XMLDuration.PERIOD_TYPE.equals(type))
+        {
+            label = "XML Duration";
+        }
+        else if (Years.PERIOD_TYPE.equals(type))
+        {
+            label = "Year";
+        }
+        
+        return label;
+    }
+}