Wikipedia:Lua/Modul/SimpleDataAccess/de
Vorlagenprogrammierung | Diskussionen | Lua | Unterseiten | |||
Modul | Deutsch | English
|
Modul: | Dokumentation |
Einbindung
[Quelltext bearbeiten]bindet ein
[Quelltext bearbeiten]Module, die von diesem Modul eingebunden werden:
- Erzeugung von Zeitobjekten aus Eigenschaftswerten
- Filterung von Eigenschaftswerten nach Zeitpunkt, Start- und Endzeit
Wikidata/Time-Objekte erben die Eigenschaften und Methoden aus Modul:Time
- Formatierung von Zeit- und Datumswerten
- Vergleich von Zeit- und Datumswerten (>, <, >=, <=, =, ~=) unter Berücksichtigung ihrer jeweiligen Genauigkeit
wird eingebunden von
[Quelltext bearbeiten]Selbst eingebunden wird dieses Modul unter anderem in:
Im Modul:Zeichenfolge werden aufgerufen:
- qualifiersLineup(qual, "P527")
- indirectMSValue(cq, "P1299 P4213")
Im Modul:Zeichen wird aufgerufen:
- MainSnackValue(unicodeQ, "P5522")
Kopiervorlage
[Quelltext bearbeiten]Das Modul kann eingebunden werden mit:
local isSuccessfull, SDA = pcall(require, "Modul:SimpleDataAccess")
Funktionen
[Quelltext bearbeiten]Folgende Funktionen stehen zur Verfügung:
getSnaks(object, property, all)
[Quelltext bearbeiten]Liste von Eigenschaftswerten zu einer Aussage
Parameter:
- object
- Quelle:
- Identifikationsschlüssel einer Wikidata-Entität:
- mw.wikibase.getBestStatements(object, property) oder
- mw.wikibase.getAllStatements(object, property) wird aufgerufen, oder
- Wikidata-Entitätsobjekt:
- object:getBestStatements(property) oder
- object:getAllStatements(property) wird aufgerufen, oder
- Liste von Statements:
- entsprechend dem Ergebnis der getBestStatements-Aufrufe; property und all werden ignoriert
- Einzelnes Statement:
- An Stelle der Liste von Statements zu einer Eigenschaft der Entität wird eine Liste von Qualifikatoren zu einer Eigenschaft des Statements zurück gegeben.
- Identifikationsschlüssel einer Wikidata-Entität:
- Quelle:
- property
- Eigenschaftswert: Identifikationsschlüssel einer Wikidata-Eigenschaft ('P123...')
- all
- Wahrheitswert, optional: An Stelle von getBestStatements (Vorgabe) soll getAllStatements verwendet werden.
Rückgabewert:
- eine Tabelle, deren Elemente verschiedene Datentypen haben können:
- {<string>, <string>, <string>, ...}, oder
- {<number>, <number>, <number>, ...}, oder
- {<id>, <id>, <id>, ...}, z. B. {'Q123', 'Q456', 'Q789', ...}, oder
- {<time>, <time>, <time>, ...}, siehe Modul:Wikidata/Time
- Weitere Objekttypen sind vorgesehen.
SnakList(object, property, all, vType, fmtString, sep)
[Quelltext bearbeiten]Liste von Eigenschaftswerten zu einer Aussage, hier als Zeichenkette (z. B. kommasepariert)
Parameter:
- object, property, all: siehe getSnaks
- vType
- Datentyp: Die einzelnen Eigenschaftswerte werden auf Grundlage dieses Parameters in Text umgewandelt. Bei einfachen Datentypen wird dieser Parameter ignoriert. Ohne diesen Parameter werden IDs (Identifikationsschlüssel von Wikidata-Entitäten) als Text behandelt. Für andere Datentypen gilt das gleiche, jedoch ohne die Sicherheit der Funktion.
- Werte:
- 'id': Jeder Eigenschaftswert wird zunächst als ID interpretiert.
- 'f': Es wird die format-Methode jedes Eigenschaftswertes aufgerufen.
- fmtString
- Formatierungsschema: Parameter für die format-Methode
- <time>-Objekte verfügen über eine format-Methode, die über eigene Vorgabewerte verfügt. Dieser Parameter ist hier optional.
- Formatierungsschema: Parameter für die format-Methode
- sep
- optionale Separator-Zeichenkette, durch die die Einträge in der Liste separiert werden. Vorgabewert ist hier: ', '
Rückgabewert:
- Eine Zeichenkette
qualifyingValue(statement, propQual, firstOnly, vType, fmtString, sep)
[Quelltext bearbeiten]Wert(eliste) einer Eigenschaft, die eine Aussage qualifiziert
Parameter:
- statement
- einzelne Aussage, wie sie z. B. von mw.wikibase.getBestStatements in einer Tabelle zurückgegeben wird
- propQual
- Eigenschaftswert: Identifikationsschlüssel einer Wikidata-Eigenschaft ('P123...'), die eine Aussage qualifiziert
- firstOnly
- An stelle einer (z. B. kommaseparierten) Liste von Ergebnissen soll nur das erste gefundene Ergebnis zurück geliefert werden.
- vType, fmtString, sep: siehe SnakList
Rückgabewert:
- Eine Zeichenkette
MainSnakValue(object, property, fmtString)
[Quelltext bearbeiten]Einzelner (erster gefundener) Eigenschaftswert zu einer Aussage
Parameter:
- object, property, fmtString: siehe SnakList
Rückgabewert:
- Eine Zeichenkette
indirectMSValue(qualifier, properties, fmtString)
[Quelltext bearbeiten]Einzelner (erster gefundener) Eigenschaftswert zu einer Aussage; Bis zum vorletzten Schlüssel werden die Werte der ermittelten Eigenschaft jeweils als ID (qualifier) zur Ermittlung des nächsten Eigenschaftswertes interpretiert. Erst mit dem letzten Schlüssel wird auf eine Eigenschaft zugegriffen, die eventuell mit dem Formatierungsschema zu verarbeiten ist.
Parameter:
- object, fmtString: siehe SnakList
- properties
- Kommaseparierte Liste von Identifikationsschlüsseln von Wikidata-Eigenschaften ('P123, P456, P789, ...')
Rückgabewert:
- Eine Zeichenkette
qualifiersLineup(object, property)
[Quelltext bearbeiten]Liste von Schlüsselwerten zu einer Aussage; nach Ordnungsnummer sortiert
Parameter:
- object, property: siehe getSnaks
Rückgabewert:
- {'<id>', '<id>', '<id>', ...}
Achtung: Kann je nach Datenbestand auch korrupte Listen zurück geben:
- {[3]='<id>', [4]='<id>', [7]='<id>', ...}