/*
    * Copyright 2008 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.ole.sys.document.datadictionary;
  
  import java.util.ArrayList;
  import java.util.List;
  
  import org.apache.commons.lang.StringUtils;
  import org.kuali.ole.sys.businessobject.AccountingLine;
  import org.kuali.ole.sys.document.web.AccountingLineViewColumns;
  import org.kuali.ole.sys.document.web.AccountingLineViewField;
  import org.kuali.ole.sys.document.web.AccountingLineViewLineFillingElement;
  import org.kuali.ole.sys.document.web.TableJoining;
  import org.kuali.rice.krad.datadictionary.DataDictionaryDefinitionBase;
  import org.kuali.rice.krad.datadictionary.exception.AttributeValidationException;
  
  /**
   * 
   */
  public class AccountingLineViewColumnsDefinition extends DataDictionaryDefinitionBase implements AccountingLineViewLineFillingDefinition {
      private int columnCount = 1;
      private List<AccountingLineViewFieldDefinition> fields;
      private String name;
      
      /**
       * 
       * @see org.kuali.ole.sys.document.datadictionary.AccountingLineViewRenderableElementDefinition#createLayoutElement(java.lang.Class)
       */
      public TableJoining createLayoutElement(Class<? extends AccountingLine> accountingLineClass) {
          List<AccountingLineViewField> layoutFields = new ArrayList<AccountingLineViewField>();
          
          for (AccountingLineViewFieldDefinition fieldDefinition : fields) {
              final AccountingLineViewField field = (AccountingLineViewField)fieldDefinition.createLayoutElement(accountingLineClass);
              if (field != null) {
                  layoutFields.add(field);
              }
          }
          
          return new AccountingLineViewColumns(this, layoutFields);
      }
  
      /**
       * @see org.kuali.ole.sys.document.datadictionary.AccountingLineViewLineFillingDefinition#createLineFillingLayoutElement(java.lang.Class)
       */
      public AccountingLineViewLineFillingElement createLineFillingLayoutElement(Class<? extends AccountingLine> accountingLineClass) {
          return (AccountingLineViewLineFillingElement)createLayoutElement(accountingLineClass);
      }
  
      /**
       * 
       * @see org.kuali.rice.krad.datadictionary.DataDictionaryDefinition#completeValidation(java.lang.Class, java.lang.Class)
       */
      public void completeValidation(Class rootBusinessObjectClass, Class otherBusinessObjectClass) {
          if (StringUtils.isBlank(name)) {
              throw new AttributeValidationException("name for "+rootBusinessObjectClass.getName()+" accounting line view columns definition must be defined");
          }
          if (columnCount < 1) {
              throw new AttributeValidationException("columnCount for "+rootBusinessObjectClass.getName()+" accounting line view columns data dictionary definition must be one or greater");
          }
          if (fields == null || fields.size() == 0) {
              throw new AttributeValidationException("Please add at least one field to the "+rootBusinessObjectClass.getName()+" accounting line view columns definition");
          }
      }
  
      /**
       * Gets the columnCount attribute. 
       * @return Returns the columnCount.
       */
      public int getColumnCount() {
          return columnCount;
      }
  
      /**
       * Sets the columnCount attribute value.
       * @param columnCount The columnCount to set.
       */
      public void setColumnCount(int columnCount) {
          this.columnCount = columnCount;
      }
  
      /**
       * Gets the fields attribute. 
       * @return Returns the fields.
       */
      public List<AccountingLineViewFieldDefinition> getFields() {
          return fields;
     }
 
     /**
      * Sets the fields attribute value.
      * @param fields The fields to set.
      */
     public void setFields(List<AccountingLineViewFieldDefinition> fields) {
         this.fields = fields;
     }
 
     /**
      * Gets the name attribute. 
      * @return Returns the name.
      */
     public String getName() {
         return name;
     }
 
     /**
      * Sets the name attribute value.
      * @param name The name to set.
      */
     public void setName(String name) {
         this.name = name;
     }
     
 }