/*
    * 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 org.kuali.ole.sys.businessobject.AccountingLine;
  import org.kuali.ole.sys.context.SpringContext;
  import org.kuali.ole.sys.document.service.AccountingLineRenderingService;
  import org.kuali.ole.sys.document.web.AccountingLineViewDebitCreditAmountLayoutElement;
  import org.kuali.ole.sys.document.web.TableJoining;
  import org.kuali.rice.kns.datadictionary.MaintainableFieldDefinition;
  import org.kuali.rice.kns.service.DataDictionaryService;
  import org.kuali.rice.kns.util.FieldUtils;
  import org.kuali.rice.kns.web.ui.Field;
  import org.kuali.rice.kns.web.ui.FieldBridge;
  
  /**
   * Data dictionary meta data that represents a debit/credit amount field.  By default, it expects the new line debit amount property on the form
   * to be called "newSourceLineDebit", the debit amount on a new line to be called "newSourceLineCredit", and for the
   * form to have a collection VoucherAccountingLineHelper implementation objects called "voucherLineHelpers", though
   * these can be overridden.
   */
  public class AccountingLineViewDebitCreditAmountFieldDefinition extends MaintainableFieldDefinition implements AccountingLineViewRenderableElementDefinition {
      private String newLineDebitAmountProperty = "newSourceLineDebit";
      private String newLineCreditAmountProperty = "newSourceLineCredit";
      private String voucherLineHelperProperty = "voucherLineHelper";
      private boolean useShortLabels = true;
      private String amountFieldName = "amount";
      
      /**
       * @see org.kuali.ole.sys.document.datadictionary.AccountingLineViewRenderableElementDefinition#createLayoutElement(java.lang.Class)
       */
      public TableJoining createLayoutElement(Class<? extends AccountingLine> accountingLineClass) {
          AccountingLineViewDebitCreditAmountLayoutElement layoutElement = new AccountingLineViewDebitCreditAmountLayoutElement();
          
          layoutElement.setDebitAmountField(createFieldForPropertyName(amountFieldName, accountingLineClass));
          layoutElement.setDebitFieldDefinition(createFieldDefinitionForProperty(amountFieldName));
          
          layoutElement.setCreditAmountField(createFieldForPropertyName(amountFieldName, accountingLineClass));
          layoutElement.setCreditFieldDefinition(createFieldDefinitionForProperty(amountFieldName));
          
          layoutElement.setDefinition(this);
          
          return layoutElement;
      }
      
      /**
       * Creates a field for the given AccountingLine class and property name
       * @param propertyName the name of the property to create a Field for
       * @param accountingLineClass the Class of the AccountingLine we're planning on rendering
       * @return an appropriately created Field
       */
      protected Field createFieldForPropertyName(String propertyName, Class<? extends AccountingLine> accountingLineClass) {
          Field realField = FieldUtils.getPropertyField(accountingLineClass, propertyName, false);
          FieldBridge.setupField(realField, this, null);
          if (useShortLabels) {
              org.kuali.rice.krad.datadictionary.BusinessObjectEntry boEntry = SpringContext.getBean(DataDictionaryService.class).getDataDictionary().getBusinessObjectEntry(accountingLineClass.getName());
              realField.setFieldLabel(boEntry.getAttributeDefinition(propertyName).getShortLabel());
          }
          return realField;
      }
      
      /**
       * Creates an AccountingLineViewFieldDefinition for the given property name
       * @param propertyName the name of the field property that we're creating a definition for
       * @return an appropriately created AccountingLineViewFieldDefinition
       */
      protected AccountingLineViewFieldDefinition createFieldDefinitionForProperty(String propertyName) {
          AccountingLineViewFieldDefinition fieldDefinition = SpringContext.getBean(AccountingLineRenderingService.class).createGenericAccountingLineViewFieldDefinition(this);
          fieldDefinition.setName(propertyName);
          return fieldDefinition;
      }
  
      /**
       * Gets the newLineCreditAmountProperty attribute. 
       * @return Returns the newLineCreditAmountProperty.
       */
      public String getNewLineCreditAmountProperty() {
          return newLineCreditAmountProperty;
      }
  
      /**
       * Sets the newLineCreditAmountProperty attribute value.
       * @param newLineCreditAmountProperty The newLineCreditAmountProperty to set.
       */
      public void setNewLineCreditAmountProperty(String newLineCreditAmountProperty) {
          this.newLineCreditAmountProperty = newLineCreditAmountProperty;
     }
 
     /**
      * Gets the newLineDebitAmountProperty attribute. 
      * @return Returns the newLineDebitAmountProperty.
      */
     public String getNewLineDebitAmountProperty() {
         return newLineDebitAmountProperty;
     }
 
     /**
      * Sets the newLineDebitAmountProperty attribute value.
      * @param newLineDebitAmountProperty The newLineDebitAmountProperty to set.
      */
     public void setNewLineDebitAmountProperty(String newLineDebitAmountProperty) {
         this.newLineDebitAmountProperty = newLineDebitAmountProperty;
     }
 
     /**
      * Gets the voucherLineHelpersProperty attribute. 
      * @return Returns the voucherLineHelpersProperty.
      */
     public String getVoucherLineHelperProperty() {
         return voucherLineHelperProperty;
     }
 
     /**
      * Sets the voucherLineHelpersProperty attribute value.
      * @param voucherLineHelpersProperty The voucherLineHelpersProperty to set.
      */
     public void setVoucherLineHelperProperty(String voucherLineHelpersProperty) {
         this.voucherLineHelperProperty = voucherLineHelpersProperty;
     }
 
     /**
      * Gets the useShortLabels attribute. 
      * @return Returns the useShortLabels.
      */
     public boolean shouldUseShortLabels() {
         return useShortLabels;
     }
 
     /**
      * Sets the useShortLabels attribute value.
      * @param useShortLabels The useShortLabels to set.
      */
     public void setUseShortLabels(boolean useShortLabels) {
         this.useShortLabels = useShortLabels;
     }
 
     /**
      * Gets the amountFieldName attribute. 
      * @return Returns the amountFieldName.
      */
     public String getAmountFieldName() {
         return amountFieldName;
     }
 
     /**
      * Sets the amountFieldName attribute value.
      * @param amountFieldName The amountFieldName to set.
      */
     public void setAmountFieldName(String amountFieldName) {
         this.amountFieldName = amountFieldName;
     }
     
 }