/*
    * Copyright 2006 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.fp.document.dataaccess;
  
  import java.util.HashMap;
  import java.util.Map;
  
  import org.apache.ojb.broker.PersistenceBroker;
  import org.apache.ojb.broker.accesslayer.QueryCustomizer;
  import org.apache.ojb.broker.metadata.CollectionDescriptor;
  import org.apache.ojb.broker.query.Query;
  import org.apache.ojb.broker.query.QueryByCriteria;
  import org.kuali.ole.sys.OLEConstants;
  import org.kuali.ole.sys.OLEPropertyConstants;
  
  /**
   * Query customizer for to seperate out the pre-paid and non prepaid collections from the dv expense table.
   */
  public class OJBTravelExpenseQueryCustomizer implements QueryCustomizer {
      private static final String prepaidAttributeName = "PREPAID";
      private static final String prepaidIndicatorField = OLEPropertyConstants.DISB_VCHR_EXPENSE + "." + OLEPropertyConstants.PREPAID_EXPENSE;
      private Map attributes = new HashMap();
  
      /**
       * @see org.apache.ojb.broker.accesslayer.QueryCustomizer#customizeQuery(java.lang.Object,
       *      org.apache.ojb.broker.PersistenceBroker, org.apache.ojb.broker.metadata.CollectionDescriptor,
       *      org.apache.ojb.broker.query.QueryByCriteria)
       */
      public Query customizeQuery(Object arg0, PersistenceBroker arg1, CollectionDescriptor arg2, QueryByCriteria arg3) {
          if ("TRUE".equals(getAttribute(prepaidAttributeName))) {
              arg3.getCriteria().addEqualTo(prepaidIndicatorField, OLEConstants.ACTIVE_INDICATOR);
          }
          else {
              arg3.getCriteria().addEqualTo(prepaidIndicatorField, OLEConstants.NON_ACTIVE_INDICATOR);
          }
          return arg3;
      }
  
      /**
       * @see org.apache.ojb.broker.metadata.AttributeContainer#addAttribute(java.lang.String, java.lang.String)
       */
      public void addAttribute(String arg0, String arg1) {
          attributes.put(arg0, arg1);
      }
  
      /**
       * @see org.apache.ojb.broker.metadata.AttributeContainer#getAttribute(java.lang.String, java.lang.String)
       */
      public String getAttribute(String arg0, String arg1) {
          return (String) attributes.get(arg0);
      }
  
      /**
       * @see org.apache.ojb.broker.metadata.AttributeContainer#getAttribute(java.lang.String)
       */
      public String getAttribute(String arg0) {
          return (String) attributes.get(arg0);
      }
  
  }