/*

  * Copyright 2007-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.rice.kew.rule;

 import org.apache.log4j.Logger;

 import org.kuali.rice.kew.engine.RouteContext;

 import org.kuali.rice.kew.engine.node.RouteNodeInstance;

 import org.kuali.rice.kew.engine.node.hierarchyrouting.HierarchyRoutingNode;

 import org.kuali.rice.kew.exception.WorkflowException;

 import org.kuali.rice.kew.routeheader.DocumentRouteHeaderValue;

 import org.kuali.rice.kew.util.Utilities;

 import java.sql.Timestamp;

 import java.util.Map;

 /**

  * Derives the rule name to select based on node instance state configured by a governing

  * HierarchyRoutingNode and the HierarchyRoutingNode name.  E.g.:

  * <pre>

  * <dynamic name="hierarchy">

  *   <type>org.kuali.rice.kew.engine.node.hierarchyrouting.HierarchyRoutingNode</type>

  *   <hierarchyProvider>org.kuali.rice.kew.engine.node.hierarchyrouting.SimpleHierarchyProvider</hierarchyProvider>

  *   <ruleSelector>HierarchicalNamed</ruleSelector>

  * </dynamic>

  * </pre>

  * If <code>org.kuali.rice.kew.engine.node.hierarchyrouting.SimpleHierarchyProvider</code> supplied stops named 'a', 'b', and 'c', the rules

  * selected would be 'hierarchy-a', 'hierarchy-b', and 'hierarchy-c', respectively.

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

  */

 public class HierarchicalNamedRuleSelector extends NamedRuleSelector {

     private static final Logger LOG = Logger.getLogger(HierarchicalNamedRuleSelector.class);

     @Override

     protected String getName(RouteContext context, DocumentRouteHeaderValue routeHeader, RouteNodeInstance nodeInstance,

             String selectionCriterion, Timestamp effectiveDate) throws WorkflowException {

         Map<String, String> cfgMap = Utilities.getKeyValueCollectionAsMap(nodeInstance.getState());

         String stop_id = cfgMap.get(HierarchyRoutingNode.STOP_ID);

         if (stop_id == null) {

             LOG.warn("STOP ID from nodeInstance was NULL: " + nodeInstance);

             return null;

         }

         LOG.info("STOP ID from nodeInstance: " + nodeInstance.getRouteNodeInstanceId() + ": " + stop_id);

         return nodeInstance.getProcess().getRouteNode().getRouteNodeName() + "-" + stop_id;

     }

 }