OLD | NEW |
1 #!/usr/bin/python | 1 #!/usr/bin/python |
2 | 2 |
3 """ | 3 """ |
4 Copyright 2014 Google Inc. | 4 Copyright 2014 Google Inc. |
5 | 5 |
6 Use of this source code is governed by a BSD-style license that can be | 6 Use of this source code is governed by a BSD-style license that can be |
7 found in the LICENSE file. | 7 found in the LICENSE file. |
8 | 8 |
9 ColumnHeaderFactory class (see class docstring for details) | 9 ColumnHeaderFactory class (see class docstring for details) |
10 """ | 10 """ |
11 | 11 |
12 # Keys used within dictionary representation of each column header. | 12 # Keys used within dictionary representation of each column header. |
13 # NOTE: Keep these in sync with static/constants.js | 13 # NOTE: Keep these in sync with static/constants.js |
14 KEY__HEADER_TEXT = 'headerText' | 14 KEY__EXTRACOLUMNHEADERS = 'extraColumnHeaders' |
15 KEY__HEADER_URL = 'headerUrl' | 15 KEY__EXTRACOLUMNHEADERS__HEADER_TEXT = 'headerText' |
16 KEY__IS_FILTERABLE = 'isFilterable' | 16 KEY__EXTRACOLUMNHEADERS__HEADER_URL = 'headerUrl' |
17 KEY__IS_SORTABLE = 'isSortable' | 17 KEY__EXTRACOLUMNHEADERS__IS_FILTERABLE = 'isFilterable' |
18 KEY__VALUES_AND_COUNTS = 'valuesAndCounts' | 18 KEY__EXTRACOLUMNHEADERS__IS_SORTABLE = 'isSortable' |
| 19 KEY__EXTRACOLUMNHEADERS__VALUES_AND_COUNTS = 'valuesAndCounts' |
19 | 20 |
20 | 21 |
21 class ColumnHeaderFactory(object): | 22 class ColumnHeaderFactory(object): |
22 """Factory which assembles the header for a single column of data.""" | 23 """Factory which assembles the header for a single column of data.""" |
23 | 24 |
24 def __init__(self, header_text, header_url=None, | 25 def __init__(self, header_text, header_url=None, |
25 is_filterable=True, is_sortable=True, | 26 is_filterable=True, is_sortable=True, |
26 include_values_and_counts=True): | 27 include_values_and_counts=True): |
27 """ | 28 """ |
28 Args: | 29 Args: |
(...skipping 10 matching lines...) Expand all Loading... |
39 self._header_text = header_text | 40 self._header_text = header_text |
40 self._header_url = header_url | 41 self._header_url = header_url |
41 self._is_filterable = is_filterable | 42 self._is_filterable = is_filterable |
42 self._is_sortable = is_sortable | 43 self._is_sortable = is_sortable |
43 self._include_values_and_counts = include_values_and_counts | 44 self._include_values_and_counts = include_values_and_counts |
44 | 45 |
45 def create_as_dict(self, values_and_counts_dict=None): | 46 def create_as_dict(self, values_and_counts_dict=None): |
46 """Creates the header for this column, in dictionary form. | 47 """Creates the header for this column, in dictionary form. |
47 | 48 |
48 Creates the header for this column in dictionary form, as needed when | 49 Creates the header for this column in dictionary form, as needed when |
49 constructing the JSON representation. Uses the KEY__* constants as keys. | 50 constructing the JSON representation. Uses the KEY__EXTRACOLUMNHEADERS__* |
| 51 constants as keys. |
50 | 52 |
51 Args: | 53 Args: |
52 values_and_counts_dict: dictionary mapping each possible column value | 54 values_and_counts_dict: dictionary mapping each possible column value |
53 to its count (how many entries in the column have this value), or | 55 to its count (how many entries in the column have this value), or |
54 None if this information is not available. | 56 None if this information is not available. |
55 """ | 57 """ |
56 asdict = { | 58 asdict = { |
57 KEY__HEADER_TEXT: self._header_text, | 59 KEY__EXTRACOLUMNHEADERS__HEADER_TEXT: self._header_text, |
58 KEY__IS_FILTERABLE: self._is_filterable, | 60 KEY__EXTRACOLUMNHEADERS__IS_FILTERABLE: self._is_filterable, |
59 KEY__IS_SORTABLE: self._is_sortable, | 61 KEY__EXTRACOLUMNHEADERS__IS_SORTABLE: self._is_sortable, |
60 } | 62 } |
61 if self._header_url: | 63 if self._header_url: |
62 asdict[KEY__HEADER_URL] = self._header_url | 64 asdict[KEY__EXTRACOLUMNHEADERS__HEADER_URL] = self._header_url |
63 if self._include_values_and_counts and values_and_counts_dict: | 65 if self._include_values_and_counts and values_and_counts_dict: |
64 asdict[KEY__VALUES_AND_COUNTS] = values_and_counts_dict | 66 asdict[KEY__EXTRACOLUMNHEADERS__VALUES_AND_COUNTS] = sorted( |
| 67 values_and_counts_dict.items()) |
65 return asdict | 68 return asdict |
OLD | NEW |