View Javadoc

1   package org.apache.maven.index.search.grouping;
2   
3   /*
4    * Licensed to the Apache Software Foundation (ASF) under one
5    * or more contributor license agreements.  See the NOTICE file
6    * distributed with this work for additional information
7    * regarding copyright ownership.  The ASF licenses this file
8    * to you under the Apache License, Version 2.0 (the
9    * "License"); you may not use this file except in compliance
10   * with the License.  You may obtain a copy of the License at
11   *
12   *   http://www.apache.org/licenses/LICENSE-2.0    
13   *
14   * Unless required by applicable law or agreed to in writing,
15   * software distributed under the License is distributed on an
16   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17   * KIND, either express or implied.  See the License for the
18   * specific language governing permissions and limitations
19   * under the License.
20   */
21  
22  import java.util.Comparator;
23  import java.util.Map;
24  
25  import org.apache.maven.index.ArtifactInfo;
26  import org.apache.maven.index.ArtifactInfoGroup;
27  import org.apache.maven.index.Grouping;
28  
29  /**
30   * An abstract {@link Grouping} implementation.
31   * 
32   * @author Tamas Cservenak
33   */
34  public abstract class AbstractGrouping
35      implements Grouping
36  {
37      private Comparator<ArtifactInfo> comparator;
38  
39      public AbstractGrouping()
40      {
41          this( ArtifactInfo.VERSION_COMPARATOR );
42      }
43  
44      public AbstractGrouping( Comparator<ArtifactInfo> comparator )
45      {
46          super();
47          this.comparator = comparator;
48      }
49  
50      public boolean addArtifactInfo( Map<String, ArtifactInfoGroup> result, ArtifactInfo artifactInfo )
51      {
52          String key = getGroupKey( artifactInfo );
53  
54          ArtifactInfoGroup group = result.get( key );
55  
56          if ( group == null )
57          {
58              group = new ArtifactInfoGroup( key, comparator );
59  
60              result.put( key, group );
61          }
62  
63          return group.addArtifactInfo( artifactInfo );
64      }
65  
66      protected abstract String getGroupKey( ArtifactInfo artifactInfo );
67  
68  }