/*

  * Copyright 2006-2007 The Kuali Foundation

  * 

  * Licensed under the Educational Community License, Version 2.0 (the "License");

  * you may not use this file except in compliance with the License.

  * You may obtain a copy of the License at

  * 

  * http://www.opensource.org/licenses/ecl2.php

  * 

  * Unless required by applicable law or agreed to in writing, software

  * distributed under the License is distributed on an "AS IS" BASIS,

  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

  * See the License for the specific language governing permissions and

  * limitations under the License.

  */

 package org.kuali.rice.kns.datadictionary;

 import java.util.ArrayList;

 import java.util.LinkedHashMap;

 import java.util.List;

 import java.util.Map;

 import org.apache.commons.lang.StringUtils;

 import org.kuali.rice.kns.datadictionary.exception.DuplicateEntryException;

 /**

  *                  inquirySection defines the format and content of

                  one section of the inquiry.

                  DD:  See InquirySectionDefinition.java

                 numberOfColumns = the number of fields to be displayed in each row of the inquiry section.

                 For example, numberOfColumns = 2 indicates that the label and values for two fields will be

                 displayed in each row as follows:

                     field1label field1value  |   field2label field2value

                     field3label field3value  |   field4label field4value

                 etc.

  * Contains section-related information for inquiry sections

  * Note: the setters do copious amounts of validation, to facilitate generating errors during the parsing process.

  */

 public class InquirySectionDefinition extends DataDictionaryDefinitionBase {

     private static final long serialVersionUID = 1565114894539391362L;

         protected String title;

     protected List<FieldDefinition> inquiryFields = new ArrayList<FieldDefinition>();

     protected Map<String, FieldDefinition> inquiryFieldMap = new LinkedHashMap<String, FieldDefinition>();

     protected Map inquiryCollections;

     protected Integer numberOfColumns = 1;

     protected boolean defaultOpen = true;

     public InquirySectionDefinition() {}

     /**

      * @return title

      */

     public String getTitle() {

         return title;

     }

     /**

      * Sets title to the given value.

      * 

      * @param title

      * @throws IllegalArgumentException if the given title is blank

      */

     public void setTitle(String title) {

         this.title = title;

     }

     /**

      * @return List of attributeNames of all FieldDefinitions associated with this InquirySection, in the order in

      *         which they were added

      */

     public List<String> getInquiryFieldNames() {

         List<String> itemNames = new ArrayList<String>();

         itemNames.addAll(this.inquiryFieldMap.keySet());

         return itemNames;

     }

     /**

      * @return Collection of all FieldDefinitions associated with this InquirySection, in the order in which they

      *         were added

      */

     public List<FieldDefinition> getInquiryFields() {

         return inquiryFields;

     }

     /**

      * Directly validate simple fields, call completeValidation on Definition fields.

      * 

      * @see org.kuali.rice.kns.datadictionary.DataDictionaryDefinition#completeValidation(java.lang.Class, java.lang.Object)

      */

     public void completeValidation(Class rootBusinessObjectClass, Class otherBusinessObjectClass) {

         for (FieldDefinition inquiryField : inquiryFields ) {

             inquiryField.completeValidation(rootBusinessObjectClass, null);

         }

     }

     public String toString() {

         return "InquirySectionDefinition '" + getTitle() + "'";

     }

     public Map getInquiryCollections() {

         return inquiryCollections;

     }

     /**

                    The inquiryCollection defines a collection within the Business Object which contains

                    data that should be displayed with the BO when the inquiry is performed.

                    Each inquiryCollection defines a set of data fields, nested inquiryCollections

                    and summaryFields.  The summaryFields will be reported in the header of

                    this inquiryCollection, .

                    DD: See InquiryCollectionDefinition.java

                    JSTL: The inquiryCollection element is a Map with the following keys:

                        * name (String)

                        * businessObjectClass (String)

                        * numberOfColumns (String)

                        * inquiryFields (Map)

                        * inquiryCollections (Map, optional)

                        * summaryTitle (String)

                        * summaryFields (Map, optional)

      */

     public void setInquiryCollections(Map inquiryCollections) {

         this.inquiryCollections = inquiryCollections;

     }

     public Integer getNumberOfColumns() {

         return numberOfColumns;

     }

     /**

                 numberOfColumns = the number of fields to be displayed in each row of the inquiry section.

                 For example, numberOfColumns = 2 indicates that the label and values for two fields will be

                 displayed in each row as follows:

                     field1label field1value  |   field2label field2value

                     field3label field3value  |   field4label field4value

                 etc.

      */

     public void setNumberOfColumns(Integer numberOfColumns) {

         this.numberOfColumns = numberOfColumns;

     }

     /**

                 JSTL: inquiryFields is a Map which is accessed using a

                 key of "inquiryFields".  This map contains the following types

                 of elements:

                     * inquirySubSectionHeader

                     * field

                     * inquiryCollection

                 Each of these entries are keyed by "attributeName".

                 The associated value is the attributeName of the

                 mapped element.

                   The inquirySubSectionHeader allows a separator containing text to

                   separate groups of fields.  The name attribute is the displayed text.

                   JSTL: inquirySubSectionHeader appears in the inquiryFields map as:

                       * key = "attributeName"

                       * value = name of inquirySubSectionHeader

                     The field element defines the attributes of a single data field.

                     DD:  See FieldDefinition.java

                     JSTL: The field element is a Map which is accessed using

                     a key of the attributeName.  This map contains the following keys:

                         * attributeName (String)

                         * forceInquiry (boolean String)

                         * noInquiry (boolean String)

                         * maxLength (String)

                 forceInquiry = true means that the displayed field value will

                 always be made inquirable (this attribute is not used within the code).

                 noInquiry = true means that the displayed field will never be made inquirable.

                 maxLength = the maximum allowable length of the field in the lookup result fields.  In other contexts,

                 like inquiries, this field has no effect.

      */

     public void setInquiryFields(List<FieldDefinition> inquiryFields) {

         inquiryFieldMap.clear();

         for (FieldDefinition inquiryField : inquiryFields ) {

             if (inquiryField == null) {

                 throw new IllegalArgumentException("invalid (null) inquiryField");

             }

             String itemName = inquiryField.getAttributeName();

             if (inquiryFieldMap.containsKey(itemName)) {

                 throw new DuplicateEntryException("duplicate itemName entry for item '" + itemName + "'");

             }

             inquiryFieldMap.put(itemName, inquiryField);        

         }

         this.inquiryFields = inquiryFields;

     }

         /**

          * @return the defaultOpen

          */

         public boolean isDefaultOpen() {

                 return this.defaultOpen;

         }

         /**

          * @param defaultOpen the defaultOpen to set

          */

         public void setDefaultOpen(boolean defaultOpen) {

                 this.defaultOpen = defaultOpen;

         }

 }