Module:Is located in

Module documentationviewedithistorypurge

Usage

{{#invoke:Is located in|main|qid=|value=}}

This module will use Wikidata property located in the administrative territorial entity (P131) to determine whether or not an entity is located in a particular area or not.

Example

For example:

• Kassa Dam (Q6374700)
  • is located in Yuzawa (Q1204269), which
    • is located in Minamiuonuma district (Q798772), which
      • is located in Niigata Prefecture (Q132705).

To know that Kassa Dam (Q6374700) is located in Niigata Prefecture (Q132705), you can use:

{{#invoke:Is located in|main|qid=Q6374700|value=Q132705}} = 3

The output number indicates the minimum recursion depth to find the value required. An output of zero indicates that the item is not located there.

Maximum depth

For performance considerations, the module will not go on searching indefinitely. The default maximum recursion depth is 5. If you want to change this, use the |maxdepth= parameter.

The above documentation is transcluded from Module:Is located in/doc. (edit | history)
Editors can experiment in this module's sandbox (create | mirror) and testcases (create) pages.
Subpages of this module.

local p = {};

local function checklayer(depth) -- check P131 of items at current depth
	checklist[depth+1] = {} -- setup next layer of table
	local j = 0
	for j = 1,#checklist[depth] do -- loop over items at current depth
		local subclasses = mw.wikibase.getBestStatements(checklist[depth][j],"P131") -- get P131 statements
		for i,statement in ipairs(subclasses) do -- loop through items at next depth
			if statement.mainsnak.snaktype == 'value' then
				local newitem = statement.mainsnak.datavalue.value.id
				if newitem == value then
					isLocated = true
				else
					checklist[depth+1][#checklist[depth+1]+1] = newitem -- add item to next depth of checklist table
				end
			end
		end
	end
	return isLocated
end

function p.main(frame)
	local args = frame.args
	local pargs = frame:getParent().args
	value = args.value or pargs.value
	local qid = args.qid or pargs.qid or ""
	if qid == "" then
		qid = mw.wikibase.getEntityIdForCurrentPage()
	end
	if not qid then
		return 0
	end
	checklist = {{qid}}
	local md = args.maxdepth or pargs.maxdepth
	if md then
		maxdepth = tonumber(md)
	else
		maxdepth = 5
	end
	depth = 0 -- current depth
	isLocated = false -- assume false until match found
	while not isLocated and depth<maxdepth do
		depth = depth+1
		checklayer(depth)
	end
	if not isLocated then
		depth = 0 -- indicates not isLocated
	end
	return depth -- return depth that item was found
end

return p