def generate_attributes(component, target_id): da_object = DAComponent(component=component) if component in da_dict: da_object = da_dict[component]() # get and filter schema elements based on displayable columns schema = [x for x in da_object.get_schema().get("schema_dict") if x.get("show_as_attribute", False)] # build db column projection projection = [(x["id"].split(".")[-1], 1) for x in schema] # account for description metadata in datafiles if component == "datafile": projection.append(('description', 1)) filter_by = dict(_id=ObjectId(target_id)) record = da_object.get_all_records_columns(projection=dict(projection), filter_by=filter_by) result = dict() if len(record): record = record[0] if component == "sample": # filter based on sample type sample_types = [s_t['value'] for s_t in d_utils.get_sample_type_options()] sample_type = record.get("sample_type", str()) schema = [x for x in schema if sample_type in x.get("specifications", sample_types)] for x in schema: x['id'] = x["id"].split(".")[-1] if component == "datafile": key_split = "___0___" attributes = record.get("description", dict()).get("attributes", dict()) stages = record.get("description", dict()).get("stages", list()) datafile_attributes = dict() datafile_items = list() for st in stages: for item in st.get("items", list()): if str(item.get("hidden", False)).lower() == "false": atrib_val = attributes.get(st["ref"], dict()).get(item["id"], str()) item["id"] = st["ref"] + key_split + item["id"] datafile_attributes[item["id"]] = atrib_val datafile_items.append(item) record.update(datafile_attributes) schema = schema + datafile_items result = resolve_display_data(schema, record) return result
def get_resolve(self, component=str()): da_object = DAComponent(component=component) message_display_templates = d_utils.json_to_pytype( lkup.MESSAGES_LKUPS["message_templates"])["templates"] lookup_messages = d_utils.json_to_pytype( lkup.MESSAGES_LKUPS["lookup_messages"])["properties"] component_dict = dict() message_dict = dict() resolved_dict = self.publication_metadata() if resolved_dict.get("status") == "success": message_dict = message_display_templates.get("success", dict()) message_dict["text"] = lookup_messages.get( "doi_metadata_crosscheck", str()).get("text", str()) for f in da_object.get_schema().get("schema"): data_dict = resolved_dict.get("data", dict()) key = f.id.split(".")[-1] if key in data_dict: val = data_dict[key] # reconcile schema type mismatch if isinstance(val, list) and f.type == "string": val = ','.join(str(e) for e in val) # account for numbers if isinstance(val, str) and f.type == "object": object_type_control = d_utils.object_type_control_map( ).get(f.control.lower(), str()) if object_type_control == "ontology_annotation": object_schema = d_utils.get_db_json_schema( object_type_control) value_dict = dict(annotationValue=val) for k in object_schema: object_schema[k] = value_dict.get( k, d_utils.default_jsontype( object_schema.get(k, dict()).get( "type", "object"))) val = object_schema component_dict[key] = val if key not in component_dict: # set default values based on type component_dict[key] = d_utils.default_jsontype(f.type) else: error_list = resolved_dict.get("error", list()) message_dict = message_display_templates.get("danger", dict()) message_dict["text"] = '; '.join( str(e) for e in error_list) + lookup_messages.get( "doi_metadata_error", str()).get("text", str()) return dict(component_dict=component_dict, message_dict=message_dict)
def generate_copo_form(component=str(), target_id=str(), component_dict=dict(), message_dict=dict(), profile_id=str()): # message_dict templates are defined in the lookup dictionary, "MESSAGES_LKUPS" label_dict = dict(publication=dict(label="Publication", clonable=False), person=dict(label="Person", clonable=False), sample=dict(label="Sample", clonable=False), source=dict(label="Source", clonable=True), profile=dict(label="Profile", clonable=False), annotation=dict(label="Annotation", clonable=False), ) da_object = DAComponent(component=component, profile_id=profile_id) form_value = component_dict # get record, if in edit mode if target_id: form_value = da_object.get_record(target_id) form_schema = list() # get schema fields for f in da_object.get_schema().get("schema_dict"): if f.get("show_in_form", True): # if required, resolve data source for select-type controls, # i.e., if a callback is defined on the 'option_values' field if "option_values" in f: f["option_values"] = get_control_options(f) # filter based on sample type if component == "sample" and not filter_sample_type(form_value, f): continue form_schema.append(f) # get all records: used in the UI for 'cloning' and other purposes component_records = generate_component_records(component, profile_id) # if label_dict.get(component, dict()).get("clonable", False): # component_records = generate_component_records(component, profile_id) return dict(component_name=component, form_label=label_dict.get(component, dict()).get("label", str()), form_value=form_value, target_id=target_id, form_schema=form_schema, form_message=message_dict, component_records=component_records, clonable=label_dict.get(component, dict()).get("clonable", False), )
def generate_component_records(component=str(), profile_id=str()): da_object = DAComponent(component=component, profile_id=profile_id) component_records = list() for record in da_object.get_all_records(): rec_dict = dict(_id=str(record["_id"])) for f in da_object.get_schema().get("schema_dict"): if f.get("show_in_form", True): key_split = f["id"].split(".")[-1] rec_dict[key_split] = record.get(key_split, d_utils.default_jsontype(f.get("type", str()))) component_records.append(rec_dict) return component_records
def get_resolve(self, component=str()): da_object = DAComponent(component=component) message_display_templates = d_utils.json_to_pytype(lkup.MESSAGES_LKUPS["message_templates"])["templates"] lookup_messages = d_utils.json_to_pytype(lkup.MESSAGES_LKUPS["lookup_messages"])["properties"] component_dict = dict() message_dict = dict() resolved_dict = self.publication_metadata() if resolved_dict.get("status") == "success": message_dict = message_display_templates.get("success", dict()) message_dict["text"] = lookup_messages.get("doi_metadata_crosscheck", str()).get("text", str()) for f in da_object.get_schema().get("schema"): data_dict = resolved_dict.get("data", dict()) key = f.id.split(".")[-1] if key in data_dict: val = data_dict[key] # reconcile schema type mismatch if isinstance(val, list) and f.type == "string": val = ','.join(str(e) for e in val) # account for numbers if isinstance(val, str) and f.type == "object": object_type_control = d_utils.control_to_schema_name(f.control.lower()) if object_type_control == "ontology_annotation": object_schema = d_utils.get_isa_schema(object_type_control) value_dict = dict(annotationValue=val ) for k in object_schema: object_schema[k] = value_dict.get(k, d_utils.default_jsontype( object_schema.get(k, dict()).get("type", "object"))) val = object_schema component_dict[key] = val if key not in component_dict: # set default values based on type component_dict[key] = d_utils.default_jsontype(f.type) else: error_list = resolved_dict.get("error", list()) message_dict = message_display_templates.get("danger", dict()) message_dict["text"] = '; '.join( str(e) for e in error_list) + lookup_messages.get("doi_metadata_error", str()).get("text", str()) return dict(component_dict=component_dict, message_dict=message_dict )
def generate_table_columns(component=str()): da_object = DAComponent(component=component) # get and filter schema elements based on displayable columns schema = [x for x in da_object.get_schema().get("schema_dict") if x.get("show_in_table", True)] columns = list() columns.append(dict(data="record_id", visible=False)) detail_dict = dict(className='summary-details-control detail-hover-message', orderable=False, data=None, title='', defaultContent='', width="5%") columns.insert(0, detail_dict) # get indexed fields - only fields that are indexed can be ordered when using server-side processing indexed_fields = list() for k, v in da_object.get_collection_handle().index_information().items(): indexed_fields.append(v['key'][0][0]) for x in schema: x["id"] = x["id"].split(".")[-1] orderable = False if x["id"] in indexed_fields: orderable = True columns.append(dict(data=x["id"], title=x["label"], orderable=orderable)) # add column for annotation control if component == "datafile": special_dict = dict(className='annotate-datafile', orderable=False, data=None, title='', width="1%", defaultContent='<span title="Annotate datafile" style="cursor: ' 'pointer;" class="copo-tooltip">' '<i class="ui icon violet write" aria-hidden="true"></i></span>') columns.append(special_dict) return columns
def generate_copo_table_data(profile_id=str(), component=str()): # This method generates the 'json' for building an UI table # instantiate data access object da_object = DAComponent(profile_id, component) # get records records = da_object.get_all_records() columns = list() dataSet = list() displayable_fields = list() # headers for f in da_object.get_schema().get("schema_dict"): if f.get("show_in_table", True): displayable_fields.append(f) columns.append(dict(title=f["label"])) columns.append(dict(title=str())) # extra 'blank' header for record actions column # data for rec in records: row = list() for df in displayable_fields: row.append(resolve_control_output(rec, df)) row.append(str(rec["_id"])) # last element in a row exposes the id of the record dataSet.append(row) # define action buttons button_templates = d_utils.get_button_templates() common_btn_dict = dict(row_btns=[button_templates['edit_row'], button_templates['delete_row']], global_btns=[button_templates['delete_global']]) sample_info = copy.deepcopy(button_templates['info_row']) sample_info["text"] = "Sample Attributes" buttons_dict = dict(publication=common_btn_dict, person=common_btn_dict, sample=dict(row_btns=[sample_info, button_templates['edit_row'], button_templates['delete_row']], global_btns=[button_templates['add_new_samples_global'], button_templates['delete_global']]), source=common_btn_dict, profile=common_btn_dict, annotation=common_btn_dict, metadata_template=common_btn_dict, datafile=dict( row_btns=[button_templates['info_row'], button_templates['describe_row'], button_templates['delete_row']], global_btns=[button_templates['describe_global'], button_templates['undescribe_global']]) ) action_buttons = dict(row_btns=buttons_dict.get(component).get("row_btns"), global_btns=buttons_dict.get(component).get("global_btns") ) return_dict = dict(columns=columns, dataSet=dataSet, table_id=table_id_dict.get(component, str()), action_buttons=action_buttons ) return return_dict
def generate_table_records(profile_id=str(), component=str()): # function generates component records for building an UI table - please note that for effective tabular display, # all array and object-type fields (e.g., characteristics) are deferred to sub-table display. # please define such in the schema as "show_in_table": false and "show_as_attribute": true columns = list() data_set = list() # instantiate data access object da_object = DAComponent(profile_id, component) # get and filter schema elements based on displayable columns schema = [x for x in da_object.get_schema().get("schema_dict") if x.get("show_in_table", True)] # build db column projection projection = [(x["id"].split(".")[-1], 1) for x in schema] # retrieve and process records if component == "submission": records = da_object.get_all_records_columns(sort_by="date_created", sort_direction=1, projection=dict(projection)) else: records = da_object.get_all_records_columns(projection=dict(projection)) if len(records): df = pd.DataFrame(records) df['s_n'] = df.index df['record_id'] = df._id.astype(str) df["DT_RowId"] = df.record_id df.DT_RowId = 'row_' + df.DT_RowId df = df.drop('_id', axis='columns') if component == "submission": df["special_repositories"] = df["repository"] columns.append(dict(data="special_repositories", visible=False)) columns.append(dict(data="record_id", visible=False)) detail_dict = dict(className='summary-details-control detail-hover-message', orderable=False, data=None, title='', defaultContent='', width="5%") columns.insert(0, detail_dict) df_columns = list(df.columns) for x in schema: x["id"] = x["id"].split(".")[-1] columns.append(dict(data=x["id"], title=x["label"])) if x["id"] not in df_columns: df[x["id"]] = str() df[x["id"]] = df[x["id"]].fillna('') df[x["id"]] = df[x["id"]].apply(resolve_control_output_apply, args=(x,)) data_set = df.to_dict('records') return_dict = dict(dataSet=data_set, columns=columns ) # do check for custom repos here if component == "submission": correct_repos = list() user = ThreadLocal.get_current_user() repo_ids = user.userdetails.repo_submitter all_repos = Repository().get_by_ids(repo_ids) for repo in all_repos: for r_id in repo_ids: if r_id == str(repo["_id"]): correct_repos.append(repo) for repo in correct_repos: repo["_id"] = str(repo["_id"]) return_dict["repos"] = correct_repos return return_dict
def generate_server_side_table_records(profile_id=str(), component=str(), request=dict()): # function generates component records for building an UI table using server-side processing # - please note that for effective data display, # all array and object-type fields (e.g., characteristics) are deferred to sub-table display. # please define such in the schema as "show_in_table": false and "show_as_attribute": true data_set = list() n_size = int(request.get("length", 10)) # assumes 10 records per page if length not set draw = int(request.get("draw", 1)) start = int(request.get("start", 0)) # instantiate data access object da_object = DAComponent(profile_id, component) return_dict = dict() records_total = da_object.get_collection_handle().count( {'profile_id': profile_id, 'deleted': data_utils.get_not_deleted_flag()}) # retrieve and process records filter_by = dict() if component == "datafile": # get all active bundles in the profile existing_bundles = Description().get_all_records_columns(projection=dict(_id=1), filter_by=dict(profile_id=profile_id, component=component)) existing_bundles = [str(x["_id"]) for x in existing_bundles] records_total = da_object.get_collection_handle().count({"$and": [ {"profile_id": profile_id, 'deleted': data_utils.get_not_deleted_flag()}, {"$or": [ {"description_token": {"$in": [None, False, ""]}}, {"description_token": {"$nin": existing_bundles}}]} ]}) filter_by = {"$or": [ {"description_token": {"$in": [None, False, ""]}}, {"description_token": {"$nin": existing_bundles}}]} # get and filter schema elements based on displayable columns schema = [x for x in da_object.get_schema().get("schema_dict") if x.get("show_in_table", True)] # build db column projection projection = [(x["id"].split(".")[-1], 1) for x in schema] # order by sort_by = request.get('order[0][column]', '0') sort_by = request.get('columns[' + sort_by + '][data]', '') sort_direction = request.get('order[0][dir]', 'asc') sort_by = '_id' if not sort_by else sort_by sort_direction = 1 if sort_direction == 'asc' else -1 # search search_term = request.get('search[value]', '').strip() records = da_object.get_all_records_columns_server(sort_by=sort_by, sort_direction=sort_direction, search_term=search_term, projection=dict(projection), limit=n_size, skip=start, filter_by=filter_by) records_filtered = records_total if search_term: records_filtered = da_object.get_collection_handle().count( {'profile_id': profile_id, 'deleted': data_utils.get_not_deleted_flag(), 'name': {'$regex': search_term, "$options": 'i'}}) if records: df = pd.DataFrame(records) df['record_id'] = df._id.astype(str) df["DT_RowId"] = df.record_id df.DT_RowId = 'row_' + df.DT_RowId df = df.drop('_id', axis='columns') for x in schema: x["id"] = x["id"].split(".")[-1] df[x["id"]] = df[x["id"]].apply(resolve_control_output_apply, args=(x,)).astype(str) data_set = df.to_dict('records') return_dict["records_total"] = records_total return_dict["records_filtered"] = records_filtered return_dict["data_set"] = data_set return_dict["draw"] = draw return return_dict
def generate_copo_table_data(profile_id=str(), component=str()): # This method generates the 'json' for building an UI table # instantiate data access object da_object = DAComponent(profile_id, component) # get records records = da_object.get_all_records() columns = list() dataSet = list() # headers for f in da_object.get_schema().get("schema_dict"): if f.get("show_in_table", True): columns.append(dict(title=f["label"])) columns.append(dict(title=str())) # extra 'blank' header for record actions column # data for rec in records: row = list() for f in da_object.get_schema().get("schema_dict"): if f.get("show_in_table", True): row.append(resolve_control_output(rec, f)) row.append(str(rec["_id"])) # last element in a row exposes the id of the record dataSet.append(row) # define action buttons button_templates = d_utils.get_button_templates() common_btn_dict = dict(row_btns=[button_templates['edit_row'], button_templates['delete_row']], global_btns=[button_templates['delete_global']]) sample_info = copy.deepcopy(button_templates['info_row']) sample_info["text"] = "Sample Attributes" buttons_dict = dict(publication=common_btn_dict, person=common_btn_dict, sample=dict(row_btns=[sample_info, button_templates['edit_row'], button_templates['delete_row']], global_btns=[button_templates['add_new_samples_global'], button_templates['delete_global']]), source=common_btn_dict, profile=common_btn_dict, annotation=common_btn_dict, datafile=dict( row_btns=[button_templates['info_row'], button_templates['describe_row'], button_templates['delete_row']], global_btns=[button_templates['describe_global'], button_templates['undescribe_global']]) ) action_buttons = dict(row_btns=buttons_dict.get(component).get("row_btns"), global_btns=buttons_dict.get(component).get("global_btns") ) return_dict = dict(columns=columns, dataSet=dataSet, table_id=table_id_dict.get(component, str()), action_buttons=action_buttons ) return return_dict