File D:\maven-qcr-plugin-testsunitaires\qcr4java\jenkins-master\target\site\qc\core\src\main\java\hudson\search\CollectionSearchIndex.java.html

1 /*
2 * The MIT License
3 *
4 * Copyright (c) 2004-2009, Sun Microsystems, Inc., Kohsuke Kawaguchi
5 *
6 * Permission is hereby granted, free of charge, to any person obtaining a copy
7 * of this software and associated documentation files (the "Software"), to deal
8 * in the Software without restriction, including without limitation the rights
9 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10 * copies of the Software, and to permit persons to whom the Software is
11 * furnished to do so, subject to the following conditions:
12 *
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
15 *
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
22 * THE SOFTWARE.
23 */
24 package hudson.search;
25
26 import java.util.Collection;
27 import java.util.List;
28 import java.util.Map;
29
30 /**
31 * {@link SearchIndex} built on a {@link Map}.
32 *
33 * @author Kohsuke Kawaguchi
34 */
35 public abstract class CollectionSearchIndex<SMT extends SearchableModelObject> implements SearchIndex {
36 /**
37 * Gets a single item that exactly matches the given key.
38 */
39 protected abstract SearchItem get(String key);
40
41 /**
42 * Returns all items in the map.
43 * The collection can include null items.
44 */
45 protected abstract Collection<SMT> all();
46
47 public void find(String token, List<SearchItem> result) {
48 SearchItem p = get(token);
49 if(p!=null)
50 result.add(p);
51 }
52
53 public void suggest(String token, List<SearchItem> result) {
54 Collection<SMT> items = all();
55 if(UserSearchProperty.isCaseInsensitive()){
56 token = token.toLowerCase();
57 }
58 if(items==null) return;
59 for (SMT o : items) {
60 String name = getName(o);
61 if(UserSearchProperty.isCaseInsensitive())
62 name=name.toLowerCase();
63 if(o!=null && name.contains(token))
64 result.add(o);
65 }
66 }
67
68 protected String getName(SMT o) {
69 return o.getDisplayName();
70 }
71 }
72