/**
    * Copyright 2005-2014 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.krad.uif.lifecycle.model;
  
  import java.util.Map;
  
  import org.kuali.rice.krad.uif.UifConstants;
  import org.kuali.rice.krad.uif.layout.LayoutManager;
  import org.kuali.rice.krad.uif.lifecycle.ApplyModelComponentPhase;
  import org.kuali.rice.krad.uif.lifecycle.ViewLifecyclePhase;
  import org.kuali.rice.krad.uif.lifecycle.ViewLifecycleTaskBase;
  import org.kuali.rice.krad.uif.util.LifecycleElement;
  
  /**
  * * Push attributes to the component context.
   * 
   * @author Kuali Rice Team (rice.collab@kuali.org)
   */
  public class PopulateComponentContextTask extends ViewLifecycleTaskBase<LifecycleElement> {
  
      /**
       * Constructor.
       * 
       * @param phase The apply model phase for the component.
       */
      public PopulateComponentContextTask(ViewLifecyclePhase phase) {
          super(phase, LifecycleElement.class);
      }
  
      /**
       * {@inheritDoc}
       */
      @Override
      public ApplyModelComponentPhase getElementState() {
          return (ApplyModelComponentPhase) super.getElementState();
      }
  
      /**
       * {@inheritDoc}
       */
      @Override
      protected void performLifecycleTask() {
          LifecycleElement element = getElementState().getElement();
          LifecycleElement parent = getElementState().getParent();
         
          Map<String, Object> commonContext = getElementState().getCommonContext();
          
          if (parent != null) {
              element.pushObjectToContext(UifConstants.ContextVariableNames.PARENT, parent);
          }
  
          // set context on component for evaluating expressions
          element.pushAllToContext(commonContext);
  
          // set context evaluate expressions on the layout manager
          if (element instanceof LayoutManager) {
              element.pushObjectToContext(UifConstants.ContextVariableNames.MANAGER, element);
          }
      }
  
  }