Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Compute an ngram field for all admin data #345

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
79 changes: 48 additions & 31 deletions mappings/document.js
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
const admin = require('./partial/admin');
const admin_ngram = require('./partial/admin_ngram');
const postalcode = require('./partial/postalcode');
const hash = require('./partial/hash');
const multiplier = require('./partial/multiplier');
const literal = require('./partial/literal');
const literal_with_doc_values = require('./partial/literal_with_doc_values');
const config = require('pelias-config').generate();
const merge = require('lodash.merge');

var schema = {
properties: {
Expand Down Expand Up @@ -53,79 +55,94 @@ var schema = {
dynamic: 'strict',
properties: {
// https://github.com/whosonfirst/whosonfirst-placetypes#continent
continent: admin,
continent_a: admin,
continent: merge({ copy_to: 'parent.continent_ngram' }, admin),
continent_a: merge({ copy_to: 'parent.continent_ngram' }, admin),
continent_id: literal,
continent_ngram: admin_ngram,

// https://github.com/whosonfirst/whosonfirst-placetypes#ocean
ocean: admin,
ocean_a: admin,
ocean: merge({ copy_to: 'parent.ocean_ngram' }, admin),
ocean_a: merge({ copy_to: 'parent.ocean_ngram' }, admin),
ocean_id: literal,
ocean_ngram: admin_ngram,

// https://github.com/whosonfirst/whosonfirst-placetypes#empire
empire: admin,
empire_a: admin,
empire: merge({ copy_to: 'parent.empire_ngram' }, admin),
empire_a: merge({ copy_to: 'parent.empire_ngram' }, admin),
empire_id: literal,
empire_ngram: admin_ngram,

// https://github.com/whosonfirst/whosonfirst-placetypes#country
country: admin,
country_a: admin,
country: merge({ copy_to: 'parent.country_ngram' }, admin),
country_a: merge({ copy_to: 'parent.country_ngram' }, admin),
country_id: literal,
country_ngram: admin_ngram,

// https://github.com/whosonfirst/whosonfirst-placetypes#dependency
dependency: admin,
dependency_a: admin,
dependency: merge({ copy_to: 'parent.dependency_ngram' }, admin),
dependency_a: merge({ copy_to: 'parent.dependency_ngram' }, admin),
dependency_id: literal,
dependency_ngram: admin_ngram,

// https://github.com/whosonfirst/whosonfirst-placetypes#marinearea
marinearea: admin,
marinearea_a: admin,
marinearea: merge({ copy_to: 'parent.marinearea_ngram' }, admin),
marinearea_a: merge({ copy_to: 'parent.marinearea_ngram' }, admin),
marinearea_id: literal,
marinearea_ngram: admin_ngram,

// https://github.com/whosonfirst/whosonfirst-placetypes#macroregion
macroregion: admin,
macroregion_a: admin,
macroregion: merge({ copy_to: 'parent.macroregion_ngram' }, admin),
macroregion_a: merge({ copy_to: 'parent.macroregion_ngram' }, admin),
macroregion_id: literal,
macroregion_ngram: admin_ngram,

// https://github.com/whosonfirst/whosonfirst-placetypes#region
region: admin,
region_a: admin,
region: merge({ copy_to: 'parent.region_ngram' }, admin),
region_a: merge({ copy_to: 'parent.region_ngram' }, admin),
region_id: literal,
region_ngram: admin_ngram,

// https://github.com/whosonfirst/whosonfirst-placetypes#macrocounty
macrocounty: admin,
macrocounty_a: admin,
macrocounty: merge({ copy_to: 'parent.macrocounty_ngram' }, admin),
macrocounty_a: merge({ copy_to: 'parent.macrocounty_ngram' }, admin),
macrocounty_id: literal,
macrocounty_ngram: admin_ngram,

// https://github.com/whosonfirst/whosonfirst-placetypes#county
county: admin,
county_a: admin,
county: merge({ copy_to: 'parent.county_ngram' }, admin),
county_a: merge({ copy_to: 'parent.county_ngram' }, admin),
county_id: literal,
county_ngram: admin_ngram,

// https://github.com/whosonfirst/whosonfirst-placetypes#locality
locality: admin,
locality_a: admin,
locality: merge({ copy_to: 'parent.locality_ngram' }, admin),
locality_a: merge({ copy_to: 'parent.locality_ngram' }, admin),
locality_id: literal,
locality_ngram: admin_ngram,

// https://github.com/whosonfirst/whosonfirst-placetypes#borough
borough: admin,
borough_a: admin,
borough: merge({ copy_to: 'parent.borough_ngram' }, admin),
borough_a: merge({ copy_to: 'parent.borough_ngram' }, admin),
borough_id: literal,
borough_ngram: admin_ngram,

// https://github.com/whosonfirst/whosonfirst-placetypes#localadmin
localadmin: admin,
localadmin_a: admin,
localadmin: merge({ copy_to: 'parent.localadmin_ngram' }, admin),
localadmin_a: merge({ copy_to: 'parent.localadmin_ngram' }, admin),
localadmin_id: literal,
localadmin_ngram: admin_ngram,

// https://github.com/whosonfirst/whosonfirst-placetypes#neighbourhood
neighbourhood: admin,
neighbourhood_a: admin,
neighbourhood: merge({ copy_to: 'parent.neighbourhood_ngram' }, admin),
neighbourhood_a: merge({ copy_to: 'parent.neighbourhood_ngram' }, admin),
neighbourhood_id: literal,
neighbourhood_ngram: admin_ngram,

// https://github.com/whosonfirst/whosonfirst-placetypes#postalcode
postalcode: postalcode,
postalcode_a: postalcode,
postalcode_id: literal
postalcode: merge({ copy_to: 'parent.postalcode_ngram' }, postalcode),
postalcode_a: merge({ copy_to: 'parent.postalcode_ngram' }, postalcode),
postalcode_id: literal,
postalcode_ngram: admin_ngram
}
},

Expand Down
2 changes: 1 addition & 1 deletion mappings/partial/admin.json
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
{
"type": "string",
"analyzer": "peliasAdmin"
}
}
8 changes: 8 additions & 0 deletions mappings/partial/admin_ngram.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"type": "string",
"analyzer": "peliasIndexOneEdgeGram",
"doc_values": false,
"fielddata" : {
"format": "disabled"
}
}
40 changes: 24 additions & 16 deletions test/document.js
Original file line number Diff line number Diff line change
Expand Up @@ -85,21 +85,21 @@ module.exports.tests.address_analysis = function(test, common) {
// should contain the correct parent field definitions
module.exports.tests.parent_fields = function(test, common) {
var fields = [
'continent', 'continent_a', 'continent_id',
'ocean', 'ocean_a', 'ocean_id',
'empire', 'empire_a', 'empire_id',
'country', 'country_a', 'country_id',
'dependency', 'dependency_a', 'dependency_id',
'marinearea', 'marinearea_a', 'marinearea_id',
'macroregion', 'macroregion_a', 'macroregion_id',
'region', 'region_a', 'region_id',
'macrocounty', 'macrocounty_a', 'macrocounty_id',
'county', 'county_a', 'county_id',
'locality', 'locality_a', 'locality_id',
'borough', 'borough_a', 'borough_id',
'localadmin', 'localadmin_a', 'localadmin_id',
'neighbourhood', 'neighbourhood_a', 'neighbourhood_id',
'postalcode', 'postalcode_a', 'postalcode_id'
'continent', 'continent_a', 'continent_id', 'continent_ngram',
'ocean', 'ocean_a', 'ocean_id', 'ocean_ngram',
'empire', 'empire_a', 'empire_id', 'empire_ngram',
'country', 'country_a', 'country_id', 'country_ngram',
'dependency', 'dependency_a', 'dependency_id', 'dependency_ngram',
'marinearea', 'marinearea_a', 'marinearea_id', 'marinearea_ngram',
'macroregion', 'macroregion_a', 'macroregion_id', 'macroregion_ngram',
'region', 'region_a', 'region_id', 'region_ngram',
'macrocounty', 'macrocounty_a', 'macrocounty_id', 'macrocounty_ngram',
'county', 'county_a', 'county_id', 'county_ngram',
'locality', 'locality_a', 'locality_id', 'locality_ngram',
'borough', 'borough_a', 'borough_id', 'borough_ngram',
'localadmin', 'localadmin_a', 'localadmin_id', 'localadmin_ngram',
'neighbourhood', 'neighbourhood_a', 'neighbourhood_id', 'neighbourhood_ngram',
'postalcode', 'postalcode_a', 'postalcode_id', 'postalcode_ngram'
];
test('parent fields specified', function(t) {
t.deepEqual(Object.keys(schema.properties.parent.properties), fields);
Expand All @@ -111,15 +111,23 @@ module.exports.tests.parent_fields = function(test, common) {
// ref: https://github.com/pelias/schema/pull/95
module.exports.tests.parent_analysis = function(test, common) {
var prop = schema.properties.parent.properties;
var fields = ['country','region','county','locality','localadmin','neighbourhood'];
var fields = [
'continent', 'ocean', 'empire', 'country', 'dependency', 'marinearea',
'macroregion', 'region', 'macrocounty', 'county', 'locality', 'borough',
'localadmin', 'neighbourhood'
];
fields.forEach( function( field ){
test(field, function(t) {
t.equal(prop[field].type, 'string');
t.equal(prop[field].analyzer, 'peliasAdmin');
t.equal(prop[field].copy_to, `parent.${field}_ngram`);
t.equal(prop[field+'_a'].type, 'string');
t.equal(prop[field+'_a'].analyzer, 'peliasAdmin');
t.equal(prop[field+'_a'].copy_to, `parent.${field}_ngram`);
t.equal(prop[field+'_id'].type, 'string');
t.equal(prop[field+'_id'].index, 'not_analyzed');
t.equal(prop[field+'_ngram'].type, 'string');
t.equal(prop[field+'_ngram'].analyzer, 'peliasIndexOneEdgeGram');

t.end();
});
Expand Down
Loading