/*

  * Copyright 2007 The Kuali Foundation

  *

  * Licensed under the Educational Community License, Version 1.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/ecl1.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.uif.container;

 import java.io.Serializable;

 import java.util.HashMap;

 import java.util.Map;

 import org.apache.commons.lang.StringUtils;

 import org.kuali.rice.kns.uif.core.BindingInfo;

 import org.kuali.rice.kns.uif.core.Component;

 import org.kuali.rice.kns.uif.field.AttributeField;

 /**

  * Holds field indexes of a <code>View</code> instance for retrieval

  * 

  * @author Kuali Rice Team (rice.collab@kuali.org)

  */

 public class ViewIndex implements Serializable {

         private static final long serialVersionUID = 4700818801272201371L;

     private Map<String, Component> index;

         private Map<String, AttributeField> attributeFieldIndex;

         private Map<String, CollectionGroup> collectionsIndex;

     /**

      * Constructs new instance and performs indexing on View instance

      *

      * @param view - view instance to index

      */

     public ViewIndex(View view) {

         index(view);

         }

         /**

          * Walks through the View tree and indexes all components found. All components

      * are indexed by their IDs with the special indexing done for certain components

          * 

          * <p>

          * <code>AttributeField</code> instances are indexed by the attribute path.

          * This is useful for retrieving the AttributeField based on the incoming

          * request parameter

          * </p>

          * 

          * <p>

          * <code>CollectionGroup</code> instances are indexed by the collection

          * path. This is useful for retrieving the CollectionGroup based on the

          * incoming request parameter

          * </p>

          */

         protected void index(View view) {

         index = new HashMap<String, Component>();

                 attributeFieldIndex = new HashMap<String, AttributeField>();

         collectionsIndex = new HashMap<String, CollectionGroup>();

         indexComponent(view);

         }

     /**

      * Adds an entry to the main index for the given component. If the component

      * is of type <code>AttributeField</code> or <code>CollectionGroup</code> an

      * entry is created in the corresponding indexes for those types as well. Then

      * the #indexComponent method is called for each of the component's children

      *

      * <p>

      *   If the component is already contained in the indexes, it will be replaced

      * </p>

      *

      * @param component - component instance to index

      */

     public void indexComponent(Component component) {

         if (component == null) {

             return;

         }

         index.put(component.getId(), component);

         if (component instanceof AttributeField) {

             AttributeField field = (AttributeField) component;

             attributeFieldIndex.put(field.getBindingInfo().getBindingPath(), field);

         } else if (component instanceof CollectionGroup) {

             CollectionGroup collectionGroup = (CollectionGroup) component;

             collectionsIndex.put(collectionGroup.getBindingInfo().getBindingPath(), collectionGroup);

         }

         for (Component nestedComponent : component.getNestedComponents()) {

             indexComponent(nestedComponent);

         }

     }

     /**

      * Retrieves a <code>Component</code> from the view index by Id

      *

      * @param id - id for the component to retrieve

      * @return Component instance found in index, or null if no such component exists

      */

     public Component getComponentById(String id) {

         return index.get(id);

     }

         /**

          * Retrieves a <code>AttributeField</code> instance from the index

          * 

          * @param attributePath

          *            - full path of the attribute (from the form)

          * @return AttributeField instance for the path or Null if not found

          */

         public AttributeField getAttributeFieldByPath(String attributePath) {

                 return attributeFieldIndex.get(attributePath);

         }

         /**

          * Gets the Map that contains attribute field indexing information. The Map

          * key points to an attribute binding path, and the Map value is the

          * <code>AttributeField</code> instance

          * 

          * @return Map<String, AttributeField> attribute fields index map

          */

         public Map<String, AttributeField> getAttributeFieldIndex() {

                 return this.attributeFieldIndex;

         }

         /**

          * Gets the Map that contains collection indexing information. The Map key

          * gives the binding path to the collection, and the Map value givens the

          * <code>CollectionGroup</code> instance

          * 

          * @return Map<String, CollectionGroup> collection index map

          */

         public Map<String, CollectionGroup> getCollectionsIndex() {

                 return this.collectionsIndex;

         }

         /**

          * Retrieves a <code>CollectionGroup</code> instance from the index

          * 

          * @param collectionPath

          *            - full path of the collection (from the form)

          * @return CollectionGroup instance for the collection path or Null if not

          *         found

          */

         public CollectionGroup getCollectionGroupByPath(String collectionPath) {

                 return collectionsIndex.get(collectionPath);

         }

     /**

      * Searches for the <code>AttributeField</code> based on the given binding path. 

      * 

      * <p>It first searches for the matching <code>AttributeField</code> by path. If not

      * matching field found, it searches in the <code>CollectionGroup</code>

      * </p>

      * 

      * @param bindingInfo - <code>AttributeField</code> will be searched based on this binding path

      * @return the attribute field for the binding path

      */

         public AttributeField getAttributeField(BindingInfo bindingInfo) {

                 // Find in the attribute index first.

                 AttributeField attributeField = getAttributeFieldByPath(bindingInfo.getBindingPath());

                 if (attributeField == null) {

                         // Lets search the collections (by collection's binding path)

                         String path = bindingInfo.getBindingObjectPath() + "." + bindingInfo.getBindByNamePrefix();

                         CollectionGroup collectionGroup = getCollectionGroupByPath(stripIndexesFromPropertyPath(path));

                         if (collectionGroup != null) {

                                 for (Component item : ((CollectionGroup) collectionGroup).getItems()) {

                                         if (item instanceof AttributeField) {

                                                 if (StringUtils.equals(((AttributeField) item).getPropertyName(),bindingInfo.getBindingName())) {

                                                         attributeField = (AttributeField) item;

                                                         break;

                                                 }

                                         }

                                 }

                         }

                 }

                 return attributeField;

         }

         /**

      * Strips indexes from the property path.

      * 

      * <p> For example, it returns bo.fiscalOfficer.accounts.name for the input bo.fiscalOfficer.accounts[0].name, 

      * which can be used to find the components from the CollectionGroup index

      * </p>

      * 

      * @param propertyPath - property path

      * @return the stripped index path

      */

     private String stripIndexesFromPropertyPath(String propertyPath){

             String returnValue = propertyPath;

             String index = StringUtils.substringBetween(propertyPath, "[", "]");

             if (StringUtils.isNotBlank(index)){

                     returnValue = StringUtils.remove(propertyPath, "[" + index + "]");

                     return stripIndexesFromPropertyPath(returnValue);

             }else{

                     return returnValue;

             }

     }

 }