humlab-sead / sead_query_api

.NET Core port of Query SEAD API
Other
2 stars 0 forks source link

Add filter descriptions #54

Closed johanvonboer closed 4 years ago

johanvonboer commented 4 years ago

Would be good to have filter descriptions to make into tooltips when hovering over filters in the menu. This existed in the static JSON filter definition but not in the database and so these are lost when transitioning. The previously defined description (which may need review) can be found in the follow JSON:

[
   {
      "facetGroupKey":"space",
      "displayTitle":"Space",
      "items":[
         {
            "facetCode":"sample_groups",
            "displayTitle":"Sample group",
            "facetTypeKey":"discrete",
            "aggregateType":"count",
            "aggregateTitle":"Number of samples",
            "dependencies": [
               "sites"
            ],
            "description": "A collection of samples, usually defined by the excavator or collector",
            "enabled": true
         },
         {
            "facetCode":"sites",
            "displayTitle":"Site",
            "facetTypeKey":"discrete",
            "aggregateType":"count",
            "aggregateTitle":"Number of samples",
            "dependencies": [],
            "description": "General name for the excavation or sampling location",
            "enabled": true
         },
         {
            "facetCode":"country",
            "displayTitle":"Country",
            "facetTypeKey":"discrete",
            "aggregateType":"count",
            "aggregateTitle":"Number of samples",
            "dependencies": [],
            "description": "The name of the country, at the time of collection, in which the samples were collected",
            "enabled": true
         }
      ]
   },
   {
      "facetGroupKey":"time",
      "displayTitle":"Time",
      "items":[
         {
            "facetCode":"geochronology",
            "displayTitle":"Geochronology",
            "facetGroupKey":"time",
            "facetTypeKey":"range",
            "aggregateType":"",
            "aggregateTitle":"Number of samples",
            "dependencies": [],
            "description": "Sample ages as retrieved through absolute methods such as radiocarbon dating or other radiometric methods (in method based years before present - e.g. 14C years)",
            "enabled": false
         },

         {
            "facetId":11,
            "facetCode":"relative_age_name",
            "displayTitle":"Time periods",
            "facetTypeKey":"discrete",
            "aggregateType":"count",
            "aggregateTitle":"Number of samples",
            "dependencies": [],
            "description": "Age of sample as defined by association with a (often regionally specific) cultural or geological period (in years before present)",
            "enabled": true
         }
      ]
   },
   {
      "facetGroupKey":"ecology",
      "displayTitle":"Ecology",
      "items":[
         {
            "facetCode":"ecocode",
            "displayTitle":"Ecological/cultural category",
            "facetGroupKey":"ecology",
            "facetTypeKey":"discrete",
            "aggregateType":"count",
            "aggregateTitle":"Number of samples",
            "dependencies": [],
            "description": "Ecological category (trait) or cultural relevance of organisms based on a classification system",
            "enabled": true

         },
         {
            "facetId":30,
            "facetCode":"ecocode_system",
            "displayTitle":"Eco code system",
            "facetGroupKey":"ecology",
            "facetTypeKey":"discrete",
            "aggregateType":"count",
            "aggregateTitle":"Number of samples",
            "dependencies": [],
            "description": "Ecological or cultural organism classification system (which groups items in the ecological/cultural category filter)",
            "enabled": true
         }
      ]
   },
   {
      "facetGroupKey":"method",
      "displayTitle":"Method",
      "items":[
         {
            "facetCode":"tbl_denormalized_measured_values_33_0",
            "displayTitle":"MS ",
            "facetTypeKey":"range",
            "aggregateType":"",
            "aggregateTitle":"Number of samples",
            "dependencies": [],
            "description": "",
            "enabled": true
         },
         {
            "facetCode":"tbl_denormalized_measured_values_33_82",
            "displayTitle":"MS Heating 550",
            "facetTypeKey":"range",
            "aggregateType":"",
            "aggregateTitle":"Number of samples",
            "dependencies": [],
            "description": "",
            "enabled": true
         },
         {
            "facetCode":"tbl_denormalized_measured_values_32",
            "displayTitle":"LOI",
            "facetTypeKey":"range",
            "aggregateType":"",
            "aggregateTitle":"Number of samples",
            "dependencies": [],
            "description": "Loss of ignition",
            "enabled": true
         },
         {
            "facetCode":"tbl_denormalized_measured_values_37",
            "displayTitle":"P°",
            "facetTypeKey":"range",
            "aggregateType":"",
            "aggregateTitle":"Number of samples",
            "dependencies": [],
            "description": "",
            "enabled": true
         }
      ]
   },
   {
      "facetGroupKey":"taxonomy",
      "displayTitle":"Taxonomy",
      "items":[
         {
            "facetCode":"family",
            "displayTitle":"Family",
            "facetTypeKey":"discrete",
            "aggregateType":"count",
            "aggregateTitle":"Number of samples",
            "dependencies": [],
            "description": "Taxonomic family",
            "enabled": true
         },
         {
            "facetCode":"genus",
            "displayTitle":"Genus",
            "facetTypeKey":"discrete",
            "aggregateType":"count",
            "aggregateTitle":"Number of samples",
            "dependencies": [],
            "description": "Taxonomic genus (under family)",
            "enabled": true
         },
         {
            "facetCode":"species",
            "displayTitle":"Taxa",
            "facetTypeKey":"discrete",
            "aggregateType":"sum",
            "aggregateTitle":"sum of Abundance",
            "dependencies": [],
            "description": "Taxonomic species (under genus)",
            "enabled": true
         },
         {
            "facetCode":"species_author",
            "displayTitle":"Authority",
            "facetTypeKey":"discrete",
            "aggregateType":"count",
            "aggregateTitle":"Number of samples",
            "dependencies": [],
            "description": "Authority of the taxonomic name (not used for all species)",
            "enabled": true
         }
      ]
   },
   {
      "facetGroupKey":"testing",
      "displayTitle":"Testing",
      "items":[
         {
            "facetCode":"dataset_master",
            "displayTitle":"Master datasets",
            "facetTypeKey":"discrete",
            "aggregateType":"count",
            "aggregateTitle":"Number of samples",
            "dependencies": [],
            "description": "Master datasets",
            "enabled": true
         }
      ]
   }
]
roger-mahler commented 1 year ago

Added to 20190101_DDL_FACET_SCHEMA