aboutsummaryrefslogtreecommitdiff
path: root/cpp/include/libaddressinput/ondemand_supplier.h
blob: 0fe33f8f4194d72e22afae53aef2da2bfecdb003 (plain)
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
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
// Copyright (C) 2014 Google Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

#ifndef I18N_ADDRESSINPUT_ONDEMAND_SUPPLIER_H_
#define I18N_ADDRESSINPUT_ONDEMAND_SUPPLIER_H_

#include <libaddressinput/callback.h>
#include <libaddressinput/supplier.h>
#include <libaddressinput/util/basictypes.h>
#include <libaddressinput/util/scoped_ptr.h>

#include <map>
#include <string>

namespace i18n {
namespace addressinput {

class Downloader;
class LookupKey;
class Retriever;
class Rule;
class Storage;

// An implementation of the Supplier interface that owns a Retriever object,
// through which it loads address metadata as needed, creating Rule objects and
// caching these.
//
// When using an OndemandSupplier, address validation will benefit from address
// metadata server synonym resolution, because the server will be contacted for
// every new LookupKey (ie. every LookupKey that isn't on canonical form and
// isn't already cached).
//
// The maximum size of this cache is naturally limited to the amount of data
// available from the data server. (Currently this is less than 12,000 items of
// in total less than 2 MB of JSON data.)
class OndemandSupplier : public Supplier {
 public:
  // Takes ownership of |downloader| and |storage|. The |validation_data_url|
  // should be a URL to an address data server that |downloader| can access.
  //
  // (See the documentation for the Downloader implementation used for
  // information about what URLs are useable with that Downloader.)
  OndemandSupplier(const std::string& validation_data_url,
                   const Downloader* downloader,
                   Storage* storage);
  virtual ~OndemandSupplier();

  // Loads the metadata needed for |lookup_key|, then calls |supplied|.
  virtual void Supply(const LookupKey& lookup_key, const Callback& supplied);

 private:
  const scoped_ptr<const Retriever> retriever_;
  std::map<std::string, const Rule*> rule_cache_;

  DISALLOW_COPY_AND_ASSIGN(OndemandSupplier);
};

}  // namespace addressinput
}  // namespace i18n

#endif  // I18N_ADDRESSINPUT_ONDEMAND_SUPPLIER_H_