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