File: category_ranker.h

package info (click to toggle)
chromium-browser 57.0.2987.98-1~deb8u1
  • links: PTS, VCS
  • area: main
  • in suites: jessie
  • size: 2,637,852 kB
  • ctags: 2,544,394
  • sloc: cpp: 12,815,961; ansic: 3,676,222; python: 1,147,112; asm: 526,608; java: 523,212; xml: 286,794; perl: 92,654; sh: 86,408; objc: 73,271; makefile: 27,698; cs: 18,487; yacc: 13,031; tcl: 12,957; pascal: 4,875; ml: 4,716; lex: 3,904; sql: 3,862; ruby: 1,982; lisp: 1,508; php: 1,368; exp: 404; awk: 325; csh: 117; jsp: 39; sed: 37
file content (46 lines) | stat: -rw-r--r-- 1,737 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
// Copyright 2016 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef COMPONENTS_NTP_SNIPPETS_CATEGORY_RANKERS_CATEGORY_RANKER_H_
#define COMPONENTS_NTP_SNIPPETS_CATEGORY_RANKERS_CATEGORY_RANKER_H_

#include "base/time/time.h"
#include "components/ntp_snippets/category.h"

namespace ntp_snippets {

// TODO(vitaliii): Ensure that changes in the order are propagated to the UI.
// (crbug.com/673743)

// Orders categories.
// The order may be dynamic and change at any time.
class CategoryRanker {
 public:
  virtual ~CategoryRanker() = default;

  // Compares two categories. True means that |left| precedes |right|, i.e. it
  // must be located earlier (above) on the NTP. This method must satisfy
  // "Compare" contract required by sort algorithms.
  virtual bool Compare(Category left, Category right) const = 0;

  // Deletes all history related data between |begin| and |end|. After this
  // call, the category order may not depend on this history range anymore.
  virtual void ClearHistory(base::Time begin, base::Time end) = 0;

  // If |category| has not been added previously, it is added after all already
  // known categories, otherwise nothing is changed.
  virtual void AppendCategoryIfNecessary(Category category) = 0;

  // Feedback data from the user to update the ranking.

  // Called whenever a suggestion is opened by the user.
  virtual void OnSuggestionOpened(Category category) = 0;

  // Called whenever a category is dismissed by the user.
  virtual void OnCategoryDismissed(Category category) = 0;
};

}  // namespace ntp_snippets

#endif  // COMPONENTS_NTP_SNIPPETS_CATEGORY_RANKERS_CATEGORY_RANKER_H_