0.8.1-rc1/workflow/src/main/java/org/apache/oodt/cas/workflow/structs/HighestFIFOPrioritySorter.java

/**
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache 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.apache.org/licenses/LICENSE-2.0
 *
 * 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.apache.oodt.cas.workflow.structs;

//JDK imports
import java.util.Collections;
import java.util.Comparator;
import java.util.List;
import java.util.logging.Level;
import java.util.logging.Logger;

//OODT imports
import org.apache.oodt.cas.workflow.engine.processor.WorkflowProcessor;

/**
 * 
 * Sorts based on highest {@link Priority} for a {@link WorkflowProcessor} using
 * a particular {@link #boostAmount} provided by a calling party. The
 * {@link #boostAmount} is computed based on a function that allows
 * {@link #boostAmount} to grow over time depending on
 * {@link #secondsBetweenBoosts} and a maximum {@link #boostCap}.
 * 
 * @author bfoster
 * @author mattmann
 * @version $Revision$
 * 
 */
public class HighestFIFOPrioritySorter implements PrioritySorter {

  private int secondsBetweenBoosts;
  private double boostAmount;
  private double boostCap;
  private static final Logger LOG = Logger
      .getLogger(HighestFIFOPrioritySorter.class.getName());

  public HighestFIFOPrioritySorter(int secondsBetweenBoosts,
      double boostAmount, double boostCap) {
    this.secondsBetweenBoosts = secondsBetweenBoosts;
    this.boostAmount = boostAmount;
    this.boostCap = boostCap;
  }

  /*
   * (non-Javadoc)
   * 
   * @see
   * org.apache.oodt.cas.workflow.structs.PrioritySorter#sort(java.util.List)
   */
  @Override
  public synchronized void sort(List<WorkflowProcessor> candidates) {

    Collections.sort(candidates, new Comparator<WorkflowProcessor>() {
      public int compare(WorkflowProcessor o1, WorkflowProcessor o2) {
        return calculatePriority(o2).compareTo(calculatePriority(o1));
      }
    });
  }

  private Double calculatePriority(WorkflowProcessor processorStub) {
    double aliveTime = 0.0;

    try {
      aliveTime = (double) (System.currentTimeMillis() - processorStub
          .getWorkflowInstance().getCreationDate().getTime());
    } catch (Exception e) {
      e.printStackTrace();
      LOG.log(Level.WARNING,
          "Unable to compute aliveTime for computing FIFO priority: Reason: ["
              + e.getMessage() + "]");
      aliveTime = 0.0;
    }

    double boostPercentage = aliveTime / 1000.0
        / (double) this.secondsBetweenBoosts;
    return Math.max(
        processorStub.getWorkflowInstance().getPriority().getValue(),
        Math.min(
            this.boostCap,
            Double.valueOf(processorStub.getWorkflowInstance().getPriority()
                .getValue()
                + (boostPercentage * this.boostAmount))));
  }

}