opencultureconsulting
/
openrefine-client
mirror of https://github.com/opencultureconsulting/openrefine-client.git
2
0
Fork 0
Code Issues Releases Activity

Document compute_facets()

This commit is contained in:
Paul Makepeace 2011-04-27 05:04:09 +01:00
parent 5c4930cc78
commit 6d59e2e2cf
1 changed files with 12 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
google/refine/refine.py
View File

@ -214,7 +214,7 @@ class RefineProject:
# following filled in by get_models() # following filled in by get_models()
self.has_records = False self.has_records = False
self.columns = None self.columns = None
self.column_order = {} # order of columns in UI self.column_order = {} # map of column names to order in UI
self.rows_response_factory = None # for parsing get_rows() self.rows_response_factory = None # for parsing get_rows()
self.get_models() self.get_models()
@ -292,6 +292,17 @@ class RefineProject:
return 'code' in response_json and response_json['code'] == 'ok' return 'code' in response_json and response_json['code'] == 'ok'
def compute_facets(self, facets=None): def compute_facets(self, facets=None):
"""Compute facets as per the project's engine.
The response object has two attributes, mode & facets. mode is one of
'row-based' or 'record-based'. facets is a magic list of facets in the
same order as they were specified in the Engine. Magic allows the
original Engine's facet as index into the response, e.g.,
name_facet = TextFacet('name')
response = project.compute_facets(name_facet)
response.facets[name_facet] # same as response.facets[0]
"""
if facets: if facets:
self.engine.set_facets(facets) self.engine.set_facets(facets)
response = self.do_json('compute-facets') response = self.do_json('compute-facets')