You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@maven.apache.org by jv...@apache.org on 2002/12/31 08:01:06 UTC

cvs commit: jakarta-turbine-maven/src/java/org/apache/maven/jelly/tags/maven DependencyResolver.java

jvanzyl     2002/12/30 23:01:06

  Added:       src/java/org/apache/maven/jelly/tags/maven
                        DependencyResolver.java
  Log:
  refactoring. update to follow
  
  Revision  Changes    Path
  1.1                  jakarta-turbine-maven/src/java/org/apache/maven/jelly/tags/maven/DependencyResolver.java
  
  Index: DependencyResolver.java
  ===================================================================
  package org.apache.maven.jelly.tags.maven;
  
  /* ====================================================================
   * The Apache Software License, Version 1.1
   *
   * Copyright (c) 2002 The Apache Software Foundation.  All rights
   * reserved.
   *
   * Redistribution and use in source and binary forms, with or without
   * modification, are permitted provided that the following conditions
   * are met:
   *
   * 1. Redistributions of source code must retain the above copyright
   *    notice, this list of conditions and the following disclaimer.
   *
   * 2. Redistributions in binary form must reproduce the above copyright
   *    notice, this list of conditions and the following disclaimer in
   *    the documentation and/or other materials provided with the
   *    distribution.
   *
   * 3. The end-user documentation included with the redistribution,
   *    if any, must include the following acknowledgment:
   *       "This product includes software developed by the
   *        Apache Software Foundation (http://www.apache.org/)."
   *    Alternately, this acknowledgment may appear in the software itself,
   *    if and wherever such third-party acknowledgments normally appear.
   *
   * 4. The names "Apache" and "Apache Software Foundation" and
   *    "Apache MavenSession" must not be used to endorse or promote products
   *    derived from this software without prior written permission. For
   *    written permission, please contact apache@apache.org.
   *
   * 5. Products derived from this software may not be called "Apache",
   *    "Apache MavenSession", nor may "Apache" appear in their name, without
   *    prior written permission of the Apache Software Foundation.
   *
   * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
   * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
   * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
   * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
   * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
   * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
   * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
   * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
   * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
   * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
   * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
   * SUCH DAMAGE.
   * ====================================================================
   *
   * This software consists of voluntary contributions made by many
   * individuals on behalf of the Apache Software Foundation.  For more
   * information on the Apache Software Foundation, please see
   * <http://www.apache.org/>.
   *
   * ====================================================================
   */
  
  
  import org.apache.commons.graph.domain.dependency.DependencyGraph;
  import org.apache.maven.project.Dependency;
  import org.apache.maven.project.Project;
  
  import java.util.ArrayList;
  import java.util.HashMap;
  import java.util.Iterator;
  import java.util.List;
  /**
   *  Takes a list of maven projects and determines the overall
   *  dependency ordering among the project.
   *
   * @author <a href="mailto:jason@zenplex.com">Jason van Zyl</a>
   *
   * @version $Id: DependencyResolver.java,v 1.1 2002/12/31 07:01:06 jvanzyl Exp $
   */
  public class DependencyResolver
  {
      /** The dependency graph. */
      private DependencyGraph dependencyGraph;
  
      /** List of maven projects to analyse. */
      private List projects;
  
      /** Project dependencies. */
      private HashMap projectDeps;
  
      /** Flag to indicate whether the graph has been built. */
      private boolean graphBuilt;
  
      /**
       * Default constructor.
       */
      public DependencyResolver()
      {
          dependencyGraph = new DependencyGraph();
          projects = new ArrayList();
          projectDeps = new HashMap();
          graphBuilt = false;
      }
  
      /**
       * Clear the project list and set the graph built flag to false.
       */
      public void clear()
      {
          graphBuilt = false;
          projects.clear();
      }
  
      /**
       * These are the fully populated projects that
       * are being fed into the reactor.
       *
       * @param project Project to add to the list.
       */
      public void addProject( Project project )
      {
          projects.add( project );
      }
  
      /**
       * Set a list of projects to process.
       *
       * @param projects List of projects.
       */
      public void setProjects( List projects )
      {
          this.projects = projects;
      }
  
      /**
       * Get the list of projects in dependency sorted order.
       *
       * @param project The project to use as the head of the graph.
       * @return The list of projects.
       * @throws Exception If an error occurs while processing the graph.
       */
      public List getSortedDependencies( Project project )
          throws Exception
      {
          return getSortedDependencies( project, false );
      }
  
      /**
       * Get the list of projects in dependency sorted order.
       *
       * @param project The project to use as the head of the graph.
       * @param sourceBuild Indicate we are performing a source build.
       * @return The list of projects.
       * @throws Exception If an error occurs while processing the graph.
       */
      public List getSortedDependencies( Project project, boolean sourceBuild )
          throws Exception
      {
          buildGraph();
          List sortedDependencies = dependencyGraph.getSortedDependencies( project );
  
          if ( sourceBuild )
          {
              return sortedDependencies;
          }
  
          return getBinaryDependencies( sortedDependencies );
      }
  
      /**
       * Get the list of projects in dependency sorted order.
       *
       * @param sourceBuild Flag to indicate we are performing a source build.
       * @return The list of projects.
       * @throws Exception If an error occurs while processing the graph.
       */
      public List getSortedDependencies( boolean sourceBuild )
          throws Exception
      {
          buildGraph();
  
          List sortedDependencies = dependencyGraph.getSortedDependencies();
  
          if ( sourceBuild )
          {
              return sortedDependencies;
          }
  
          return getBinaryDependencies( sortedDependencies );
      }
  
      /**
       * Get dependency graph for a build based on binary inputs.
       *
       * @param sortedDependencies List of projects that have been dependency sorted.
       * @return The list of projects.
       */
      private List getBinaryDependencies( List sortedDependencies )
      {
          HashMap idMap = new HashMap();
          for ( Iterator i = projects.iterator(); i.hasNext(); )
          {
              Project p = (Project) i.next();
              idMap.put( p.getId(), p );
          }
  
          List binaryDeps = new ArrayList();
          for ( Iterator i = sortedDependencies.iterator(); i.hasNext(); )
          {
              Project p = (Project) i.next();
  
              Project dep = (Project) idMap.get( p.getId() );
              if ( dep != null )
              {
                  binaryDeps.add( dep );
              }
          }
  
          return binaryDeps;
      }
  
      /**
       * Build the dependency graph.
       */
      private void buildGraph()
      {
          if ( graphBuilt )
          {
              return;
          }
  
          for ( Iterator i = projects.iterator(); i.hasNext(); )
          {
              Project p = (Project) i.next();
  
              ArrayList dependencies = new ArrayList();
              for ( Iterator j = p.getDependencies().iterator(); j.hasNext(); )
              {
                  Dependency d = (Dependency) j.next();
                  Project dp = new Project();
                  dp.setId( d.getRealId() );
                  dp.setCurrentVersion( d.getVersion() );
                  dependencies.add( dp );
              }
  
              dependencyGraph.addDependencies( p, dependencies );
          }
          graphBuilt = true;
      }
  }