Module:Task
From MaRDI portal
Documentation for this module may be created at Module:Task/doc
-- Required modules for SPARQL queries and HTML table generation
-- Module for executing SPARQL queries
local sparql = require('SPARQL')
-- MediaWiki library for logging and utilities
local mw = require('mw')
local json = require("mw.text")
-- Main table to hold all functions
local p = {}
-------------------------------- Local Functions -------------------------------
-- Utility: get all P31 values of an entity
local function getInstanceOf(qid)
local e = mw.wikibase.getEntityObject(qid)
local result = {}
if not e or not e.claims or not e.claims["P31"] then
return result
end
for _, claim in pairs(e.claims["P31"]) do
local id = claim.mainsnak and claim.mainsnak.datavalue and claim.mainsnak.datavalue.value.id
if id then
table.insert(result, id)
end
end
return result
end
-------------------------------- Local Functions -------------------------------
-- Function to get Formulations with Quantities
function p.getFormulationsWithQuantities(frame)
local entityId = frame.args[1]
-- Validate input parameter
if not entityId or entityId == '' then
return "Error: No entity ID provided"
end
-- Constructing the SPARQL query with dynamic entity entityId
-- P1560: contains property id
-- P989: defining formula property id
local sparqlQuery = [[
PREFIX entityId: <https://portal.mardi4nfdi.de/entity/]] .. entityId .. [[>
SELECT ?Formula ?defining_formulation ?IDFormula ?qualValueLabel ?qualValue
WHERE {
# full statement node for P1560
entityId: p:P1560 ?statement .
?statement ps:P1560 ?IDFormula .
OPTIONAL {
?IDFormula rdfs:label ?Formula .
FILTER(LANG(?Formula) = "en")
}
OPTIONAL { ?IDFormula wdt:P989 ?defining_formulation . }
# qualifiers on this statement
OPTIONAL {
?statement ?qualProp ?qualValue .
FILTER(STRSTARTS(STR(?qualProp), STR(pq:))) # only qualifiers
OPTIONAL {
?qualProp rdfs:label ?qualPropLabel .
FILTER(LANG(?qualPropLabel) = "en")
}
OPTIONAL {
?qualValue rdfs:label ?qualValueLabel .
FILTER(LANG(?qualValueLabel) = "en")
}
}
}
ORDER BY ?Formula
]]
-- Executing the SPARQL query and retrieving results in JSON format
local jsonResults = sparql.runQuery(sparqlQuery)
-- Validate results
if not jsonResults or not jsonResults.results or not jsonResults.results.bindings then
return "\"No mathematical expressions found.\""
end
-- local resultTable = p.convertJsonToTable(jsonResults)
-- return "<pre>" .. mw.text.nowiki(json.jsonEncode(resultTable)) .. "</pre>"
-- local jsonString = mw.text.jsonEncode(jsonResults)
-- return "<pre>" .. mw.text.nowiki(jsonString) .. "</pre>"
return p.extractDefiningFormulationsWithQuantities(jsonResults)
end
-- Function to extract Formulations with Quantities
function p.extractDefiningFormulationsWithQuantities(jsonResults)
local frame = mw.getCurrentFrame()
-- Table to store contained entities
local containedEntities = {}
-- Table to store quantity symbol and name id
local quantitySymbolNameIdPairs = {}
local jsonString = mw.text.jsonEncode(jsonResults)
-- Decode the JSON string into a Lua table
local data = mw.text.jsonDecode(jsonString)
-- Get the number of contained entities
local totalContainedEntities = #data.results.bindings
if totalContainedEntities > 0 then
-- Create a table to keep track of seen IDs
local seenEquationIDs = {}
-- Loop through the bindings
for index = 1, totalContainedEntities do
local item = data.results.bindings[index]
local itemLabel = item.Formula.value
local equationIDURL = item.IDFormula.value
local equationID = equationIDURL:match(".*/(.-)$") or equationIDURL -- Extracts the part after the last '/'
-- Check if we’ve already seen this ID
if not seenEquationIDs[equationID] then
-- mark it as seen to avoid duplicates
seenEquationIDs[equationID] = true
local instances = getInstanceOf(equationID)
for _, id in ipairs(instances) do
if(id == "Q6481152") then
-- if is about a mathematical expression (Q6481152) that is contained
local numericId = equationID:sub(2) -- remove "Q" to get "6674540"
local urlRendered = "https://portal.mardi4nfdi.de/wiki/Formula:" .. numericId
local equationWithUrl = string.format('[%s %s]', tostring(urlRendered), tostring(itemLabel))
-- add new row that starts with equationWithUrl
table.insert(containedEntities, string.format('| %s ', equationWithUrl))
local equation = mw.wikibase.getEntity(equationID)
-- Get all statements for property P989 (defining formula)
local definingFormulas = equation:getBestStatements('P989')
-- Check if there are any
if definingFormulas and #definingFormulas > 0 then
for i = 1, #definingFormulas do
local definingFormula = definingFormulas[i]
local value = definingFormula.mainsnak.datavalue.value
mathTag = frame:extensionTag{
name = "math",
content = value
}
if(i == 1) then
-- for the first mathematical expression (value of defining formula) concatenate it next to the equation label (with URL)
containedEntities[#containedEntities] = containedEntities[#containedEntities] .. string.format('|| %s ', mathTag)
else
-- for every other mathematical expression (value of defining formula) create a new row
table.insert(containedEntities, string.format('| || %s', mathTag))
end
local qualValue = item.qualValueLabel or item.qualValue or ""
local qualValueWithUrl = ""
if qualValue ~= "" then
qualValueWithUrl = string.format('[%s %s]', tostring(item.qualValue.value), tostring(item.qualValueLabel.value))
containedEntities[#containedEntities] = containedEntities[#containedEntities] .. string.format('|| %s ', qualValueWithUrl)
end
-- go over defining formulas
end
else
-- local qualValue = item.qualValueLabel or item.qualValue or ""
-- local qualValueWithUrl = ""
-- if qualValue ~= "" then
-- qualValueWithUrl = string.format('[%s %s]', tostring(item.qualValue.value), tostring(item.qualValueLabel.value))
-- end
-- if qualValue ~= "" then
-- local row = "| " .. equationWithUrl .. " || " .. qualValueWithUrl
-- table.insert(containedEntities, row)
-- else
-- table.insert(containedEntities, "| " .. equationWithUrl)
-- end
end
quantitySymbolNameIdPairs = p.extractQuantities(equationID)
if type(quantitySymbolNameIdPairs) == "table" then
-- Accessing the stored pairs
for i, pair in ipairs(quantitySymbolNameIdPairs) do
local pairFirstValue = pair[1]
local pairFirstValue = mw.text.decode(pairFirstValue or "")
local quantitySymbolMathTag = frame:extensionTag{
name = "math",
content = pairFirstValue
}
-- Construct the Portal URL
local numericId = pair[3]:sub(2) -- remove "Q" to get "6674540"
local instances = getInstanceOf(pair[3])
-- Define a set of allowed IDs for Quantity
local allowedQuantityIds = {
Q6534245 = true,
Q6534237 = true,
}
local url = ""
for _, id in ipairs(instances) do
if allowedQuantityIds[id] then
-- if the symbol is a quantity kind or a quantity
-- Construct the Portal URL
url = "https://portal.mardi4nfdi.de/wiki/Quantity:"
elseif(id == "Q6481152") then
-- if is about a mathematical expression (Q6481152) that is contained
url = "https://portal.mardi4nfdi.de/wiki/Formula:"
end
-- go over values of instances
end
local fullUrl = url .. numericId
local labelWithUrl = string.format('[%s %s]', tostring(fullUrl), tostring(pair[2]))
table.insert(containedEntities, "| " .. " || ".. quantitySymbolMathTag .. " represents " .. labelWithUrl)
end
table.insert(containedEntities, "| " .. " " )
else
end
elseif(id == "Q68663") then
-- if is about a model (Q68663) that is contained
local numericId = equationID:sub(2) -- remove "Q" to get "6674540"
local urlRendered = "https://portal.mardi4nfdi.de/wiki/Model:" .. numericId
local modelWithUrl = string.format('[%s %s]', tostring(urlRendered), tostring(itemLabel))
table.insert(containedEntities, "| " .. modelWithUrl)
elseif(id == "Q6534237") then
-- if is about a quantity (Q6534237) that is contained
local numericId = equationID:sub(2) -- remove "Q" to get "6674540"
local urlRendered = "https://portal.mardi4nfdi.de/wiki/Quantity:" .. numericId
local quantityWithUrl = string.format('[%s %s]', tostring(urlRendered), tostring(itemLabel))
-- add new row that starts with quantityWithUrl
table.insert(containedEntities, string.format('| %s ', quantityWithUrl))
local equation = mw.wikibase.getEntity(equationID)
-- Get all statements for property P989 (defining formula)
local definingFormulas = equation:getBestStatements('P989')
-- Check if there are any
if definingFormulas and #definingFormulas > 0 then
-- go over defining formula values (if multiple)
for i = 1, #definingFormulas do
local definingFormula = definingFormulas[i]
local value = definingFormula.mainsnak.datavalue.value
mathTag = frame:extensionTag{
name = "math",
content = value
}
if(i == 1) then
-- for the first mathematical expression (value of defining formula) concatenate it next to the equation label (with URL)
containedEntities[#containedEntities] = containedEntities[#containedEntities] .. string.format('|| %s ', mathTag)
else
-- for every other mathematical expression (value of defining formula) create a new row
table.insert(containedEntities, string.format('| || %s', mathTag))
end
local qualValue = item.qualValueLabel or item.qualValue or ""
local qualValueWithUrl = ""
if qualValue ~= "" then
qualValueWithUrl = string.format('[%s %s]', tostring(item.qualValue.value), tostring(item.qualValueLabel.value))
containedEntities[#containedEntities] = containedEntities[#containedEntities] .. string.format('|| %s ', qualValueWithUrl)
end
-- go over defining formulas
end
else
--local qualValue = item.qualValueLabel or item.qualValue or ""
--if qualValue ~= "" then
-- local row = "| " .. quantityWithUrl .. " || " .. qualValue.value
-- table.insert(containedEntities, row)
-- -- table.insert(containedEntities, "| " .. quantityWithUrl, qualValue.value )
--else
-- table.insert(containedEntities, "| " .. quantityWithUrl)
-- end
end
quantitySymbolNameIdPairs = p.extractQuantities(equationID)
if type(quantitySymbolNameIdPairs) == "table" then
-- Accessing the stored pairs
for i, pair in ipairs(quantitySymbolNameIdPairs) do
local pairFirstValue = pair[1]
local pairFirstValue = mw.text.decode(pairFirstValue or "")
local quantitySymbolMathTag = frame:extensionTag{
name = "math",
content = pairFirstValue
}
-- Construct the Portal URL
local url = "https://portal.mardi4nfdi.de/wiki/Quantity:"
local numericId = pair[3]:sub(2) -- remove "Q" to get "6674540"
local fullUrl = url .. numericId
local labelWithUrl = string.format('[%s %s]', tostring(fullUrl), tostring(pair[2]))
table.insert(containedEntities, "| " .. " || ".. quantitySymbolMathTag .. " represents " .. labelWithUrl)
end
table.insert(containedEntities, "| " .. " " )
else
end
-- if is about a quantity (Q6534237) that is contained
end
-- Loop through the instances
end
-- if not seen
end
-- Loop through the bindings
end
-- Construct the Wikitext table
local wikitextTable = [[
{| class="wikitable" style="table-layout: auto;"
]] .. table.concat(containedEntities, "\n|-\n") .. "\n|}"
return wikitextTable
else
return "No mathematical expressions found."
end
end
function p.extractQuantities(qid)
-- Property ID for in defining formula
local pidInDefiningFormula = "P983"
-- Property ID for the (qualifier) symbol represents
local pidSymbolRepresents = "P984"
-- Attempt to retrieve entity data
local entity = mw.wikibase.getEntity(qid)
if not entity or not entity.claims[pidInDefiningFormula] then
return "No formulation found"
end
local inDefiningFormulaClaims = entity.claims[pidInDefiningFormula]
local count = 0
-- Table to store pairs of quantity symbol and quantity name
local quantitySymbolNameIdPairs = {}
for _ in pairs(inDefiningFormulaClaims or {}) do
count = count + 1
-- Get the quantity symbol
local quantitySymbol = inDefiningFormulaClaims[count].mainsnak.datavalue.value
if not quantitySymbol then
return "No valid symbol found"
end
quantity = inDefiningFormulaClaims[count].qualifiers[pidSymbolRepresents][1].datavalue.value.text
quantityId = inDefiningFormulaClaims[count].qualifiers[pidSymbolRepresents][1].datavalue.value.id
local quantityName = mw.wikibase.label(quantityId)
-- Insert pair into the table
table.insert(quantitySymbolNameIdPairs, {quantitySymbol, quantityName, quantityId})
end
return quantitySymbolNameIdPairs
end
-- Function to get specialized Research Problems
function p.getSpecializedTasks(frame)
local entityId = frame.args[1]
-- Validate input parameter
if not entityId or entityId == '' then
return "Error: No entity ID provided"
end
-- Constructing the SPARQL query with dynamic entity entityId
-- P1684: specialized by property id
local sparqlQuery = [[
PREFIX entityId: <https://portal.mardi4nfdi.de/entity/]] .. entityId .. [[>
SELECT ?URL ?Label
WHERE {
entityId: wdt:P1684 ?URL.
?URL rdfs:label ?Label
FILTER(LANG(?Label) = "en")
}
]]
-- Executing the SPARQL query and retrieving results in JSON format
local jsonResults = sparql.runQuery(sparqlQuery)
-- Validate results
if not jsonResults or not jsonResults.results or not jsonResults.results.bindings then
return "No specialized research fields found"
end
local specializedTasks = {}
-- Get the number of specialized research fields
local totalTasks = #jsonResults.results.bindings
-- Loop through the bindings
for index = 0, totalTasks do
local item = jsonResults.results.bindings[index]
if not item.Label.value then
return "Error: Missing item.Label.value"
elseif not item.URL.value then
return "Error: Missing item.URL.value"
else
local label = item.Label.value
local url = item.URL.value
local numericId = url:match("Q(%d+)")
local urlRendered = "https://portal.mardi4nfdi.de/wiki/Task:" .. numericId
local labelWithUrl = string.format('[%s %s]', tostring(urlRendered), tostring(label))
table.insert(specializedTasks, "| " .. labelWithUrl)
end
end
-- Construct the Wikitext table
local wikitextTable = "{| class='wikitable'\n" .. table.concat(specializedTasks, "\n|-\n") .. "\n|}"
return wikitextTable
end
return p
