1/*
2 * Copyright (C) 2010 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 *      http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16package com.android.quicksearchbox;
17
18/**
19 * Abstract {@link Promoter} that uses a {@link SuggestionFilter} to choose shortcuts.
20 */
21public abstract class AbstractPromoter implements Promoter {
22
23    private final SuggestionFilter mFilter;
24    private final Promoter mNext;
25    private final Config mConfig;
26
27    protected AbstractPromoter(SuggestionFilter filter, Promoter next, Config config) {
28        mFilter = filter;
29        mNext = next;
30        mConfig = config;
31    }
32
33    public void pickPromoted(
34            Suggestions suggestions, int maxPromoted, ListSuggestionCursor promoted) {
35        doPickPromoted(suggestions, maxPromoted, promoted);
36        if (mNext != null) {
37            mNext.pickPromoted(suggestions, maxPromoted, promoted);
38        }
39    }
40
41    protected abstract void doPickPromoted(
42            Suggestions suggestions, int maxPromoted, ListSuggestionCursor promoted);
43
44    protected Config getConfig() {
45        return mConfig;
46    }
47
48    protected boolean accept(Suggestion s) {
49        if (mFilter != null) {
50            return mFilter.accept(s);
51        } else {
52            return true;
53        }
54    }
55
56}
57