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.

Sign up for GitHub

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

Jump to bottom

unique identifiers etc. #42

Merged
merged 1 commit into from
Sep 4, 2023
Merged

unique identifiers etc. #42

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
12 changes: 12 additions & 0 deletions dmlex-v1.0/specification/core/objectTypes/definition.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,18 @@

<itemizedlist>
<title>Properties</title>
<listitem>
<para><literal>id</literal>
<glossterm>optional</glossterm> (zero or one). A unique identifier.</para>
<formalpara>
<title>Uniqueness constraint</title>
<para>
No two instances of <literal>definition</literal>
in the same <literal>lexicographicResource</literal>
can have the same <literal>id</literal>.
</para>
</formalpara>
</listitem>
<listitem>
<para><literal>text</literal>
<glossterm>required</glossterm> (exactly one). Non-empty string. A statement, in the same
Expand Down
9 changes: 9 additions & 0 deletions dmlex-v1.0/specification/core/objectTypes/entry.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,15 @@
<glossterm>optional</glossterm> (zero or one). An unique identifier of the entry. Entries
which have identifiers are capable of being involved in relations created with the <olink
targetptr="linking">Linking module</olink>.</para>
<formalpara>
<title>Uniqueness constraint</title>
<para>
No two instances of <literal>entry</literal>
in the same <literal>lexicographicResource</literal>
(or in the same collection of lexicographic resources if cross-resource linking is required)
can have the same <literal>id</literal>.
</para>
</formalpara>
</listitem>
<listitem>
<para><literal>headword</literal>
Expand Down
12 changes: 12 additions & 0 deletions dmlex-v1.0/specification/core/objectTypes/example.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,18 @@

<itemizedlist>
<title>Properties</title>
<listitem>
<para><literal>id</literal>
<glossterm>optional</glossterm> (zero or one). A unique identifier.</para>
<formalpara>
<title>Uniqueness constraint</title>
<para>
No two instances of <literal>example</literal>
in the same <literal>lexicographicResource</literal>
can have the same <literal>id</literal>.
</para>
</formalpara>
</listitem>
<listitem>
<para><literal>text</literal>
<glossterm>required</glossterm> (exactly one). Non-empty string. The example itself.</para>
Expand Down
12 changes: 12 additions & 0 deletions dmlex-v1.0/specification/core/objectTypes/inflectedForm.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,18 @@

<itemizedlist>
<title>Properties</title>
<listitem>
<para><literal>id</literal>
<glossterm>optional</glossterm> (zero or one). A unique identifier.</para>
<formalpara>
<title>Uniqueness constraint</title>
<para>
No two instances of <literal>inflectedForm</literal>
in the same <literal>lexicographicResource</literal>
can have the same <literal>id</literal>.
</para>
</formalpara>
</listitem>
<listitem>
<para><literal>tag</literal>
<glossterm>optional</glossterm> (zero or one). Non-empty string. An abbreviation, a code or
Expand Down
12 changes: 12 additions & 0 deletions dmlex-v1.0/specification/core/objectTypes/pronunciation.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,18 @@

<itemizedlist>
<title>Properties</title>
<listitem>
<para><literal>id</literal>
<glossterm>optional</glossterm> (zero or one). A unique identifier.</para>
<formalpara>
<title>Uniqueness constraint</title>
<para>
No two instances of <literal>pronunciation</literal>
in the same <literal>lexicographicResource</literal>
can have the same <literal>id</literal>.
</para>
</formalpara>
</listitem>
<listitem>
<para>At least one of:</para>
<itemizedlist>
Expand Down
9 changes: 9 additions & 0 deletions dmlex-v1.0/specification/core/objectTypes/sense.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,15 @@
<glossterm>optional</glossterm> (zero or one). A unique identifier of the sense. Senses
which have identifiers can be involved in relations created with the <olink
targetptr="linking">Linking module</olink>.</para>
<formalpara>
<title>Uniqueness constraint</title>
<para>
No two instances of <literal>sense</literal>
in the same <literal>lexicographicResource</literal>
(or in the same collection of lexicographic resources if cross-resource linking is required)
can have the same <literal>id</literal>.
</para>
</formalpara>
</listitem>
<listitem>
<para><literal>listingOrder</literal>
Expand Down
12 changes: 12 additions & 0 deletions dmlex-v1.0/specification/core/objectTypes/transcription.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,18 @@

<itemizedlist>
<title>Properties</title>
<listitem>
<para><literal>id</literal>
<glossterm>optional</glossterm> (zero or one). A unique identifier.</para>
<formalpara>
<title>Uniqueness constraint</title>
<para>
No two instances of <literal>transcription</literal>
in the same <literal>lexicographicResource</literal>
can have the same <literal>id</literal>.
</para>
</formalpara>
</listitem>
<listitem>
<para><literal>text</literal>
<glossterm>required</glossterm> (exactly one). Non-empty string. The actual
Expand Down
6 changes: 6 additions & 0 deletions dmlex-v1.0/specification/core/specification.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,12 @@
<para><literal><olink targetptr="core_example">example</olink></literal></para>
</listitem>
</itemizedlist>
<para>
When exchanging data encoded in a DMLex serialization
which has the concept of a "root" or top-level object, such as XML and JSON,
then the object types <literal>lexicographicResource</literal> and <literal>entry</literal>
can serve as such roots.
</para>
<xi:include href="objectTypes/lexicographicResource.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
<xi:include href="objectTypes/entry.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
<xi:include href="objectTypes/partOfSpeech.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
Expand Down
35 changes: 35 additions & 0 deletions dmlex-v1.0/specification/dmlex.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -391,6 +391,34 @@
are modelled as non-tree relations in order in order to avoid recusion in the tree
structures and to minimize the number of object types in the data model.</para>
</section>
<section>
<title>Unique identifiers</title>
<para>
Some object types defined in DMLex have a property called <literal>id</literal>
whose type is given as unique identifier. Unique identifiers in DMLex serve two purposes:
</para>
<itemizedlist>
<listitem>
<para>
To enable objects to participate in relational structures.
Relational structures (as opposed to tree structures)
are modelled in DMLex as tuples (triples, ...) of unique identifiers.
</para>
</listitem>
<listitem>
<para>
To enable addressing and accessing individual objects,
for example indvidual senses or individual exampe sentences,
outside the context of the entries they are in.
</para>
</listitem>
</itemizedlist>
<para>
DMLex does not prescribe a specific data type for unique identifiers.
Implementers can choose to implement them as numeric or alphanumeric,
as human-readably meanigful or arbitrary.
</para>
</section>
</section>
</section>

Expand Down Expand Up @@ -496,6 +524,13 @@
>
http://standards.iso.org/ittf/PubliclyAvailableStandards/c038615_ISO_IEC_19757-4_2006(E).zip</ulink>
</citetitle> ISO, June 1, 2006.</bibliomixed>
<bibliomixed id="bib_nvh"><abbrev>NVH</abbrev>
<title>Name-Value Hierarchy</title>, <citetitle>
<ulink
url="https://www.namevaluehierarchy.org/"
>
https://www.namevaluehierarchy.org/</ulink>
</citetitle>.</bibliomixed>
<bibliomixed id="rfc3987"><abbrev>RFC 3987</abbrev> M. Duerst and M. Suignard,
<title>Internationalized Resource Identifiers (IRIs)</title>, <citetitle>
<ulink url="https://www.ietf.org/rfc/rfc3987.txt"
Expand Down
9 changes: 9 additions & 0 deletions dmlex-v1.0/specification/modules/annotation/objectTypes/collocateMarker.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,15 @@
<glossterm>optional</glossterm> (zero or one). A unique identifier of the marker.
Markers which have identifiers are capable of being involved in relations created with the
<olink targetptr="linking">Linking module</olink>.</para>
<formalpara>
<title>Uniqueness constraint</title>
<para>
No two instances of <literal>collocateMarker</literal>
in the same <literal>lexicographicResource</literal>
(or in the same collection of lexicographic resources if cross-resource linking is required)
can have the same <literal>id</literal>.
</para>
</formalpara>
</listitem>
<listitem>
<para><literal>lemma</literal>
Expand Down
12 changes: 12 additions & 0 deletions dmlex-v1.0/specification/modules/etymology/objectTypes/etymology.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,18 @@

<itemizedlist>
<title>Properties</title>
<listitem>
<para><literal>id</literal>
<glossterm>optional</glossterm> (zero or one). A unique identifier.</para>
<formalpara>
<title>Uniqueness constraint</title>
<para>
No two instances of <literal>etymology</literal>
in the same <literal>lexicographicResource</literal>
can have the same <literal>id</literal>.
</para>
</formalpara>
</listitem>
<listitem>
<para><literal>description</literal>
<glossterm>optional</glossterm> (zero or one). A plain-text form of the etymology, which may
Expand Down
12 changes: 12 additions & 0 deletions dmlex-v1.0/specification/modules/etymology/objectTypes/etymon.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,18 @@

<itemizedlist>
<title>Properties</title>
<listitem>
<para><literal>id</literal>
<glossterm>optional</glossterm> (zero or one). A unique identifier.</para>
<formalpara>
<title>Uniqueness constraint</title>
<para>
No two instances of <literal>etymon</literal>
in the same <literal>lexicographicResource</literal>
can have the same <literal>id</literal>.
</para>
</formalpara>
</listitem>
<listitem>
<para><literal>when</literal>
<glossterm>optional</glossterm> (zero or one). Indicates the time period during which this etymological origin is valid.
Expand Down
8 changes: 8 additions & 0 deletions dmlex-v1.0/specification/modules/etymology/objectTypes/etymonLanguage.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,14 @@
<para><literal>langCode</literal>
<glossterm>required</glossterm> (exactly one). The IETF language code of the
language.</para>
<formalpara>
<title>Uniqueness constraint</title>
<para>
No two instances of <literal>etymonLanguage</literal>
in the same <literal>lexicographicResource</literal>
can have the same <literal>langCode</literal>.
</para>
</formalpara>
</listitem>
<listitem>
<para><literal>displayName</literal>
Expand Down
8 changes: 8 additions & 0 deletions dmlex-v1.0/specification/modules/etymology/objectTypes/etymonType.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,14 @@
<listitem>
<para><literal>type</literal>
<glossterm>required</glossterm> (exactly one). Non-empty string.</para>
<formalpara>
<title>Uniqueness constraint</title>
<para>
No two instances of <literal>etymonType</literal>
in the same <literal>lexicographicResource</literal>
can have the same <literal>type</literal>.
</para>
</formalpara>
</listitem>
<listitem>
<para><literal>description</literal>
Expand Down
12 changes: 12 additions & 0 deletions dmlex-v1.0/specification/modules/etymology/objectTypes/etymonUnit.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,18 @@

<itemizedlist>
<title>Properties</title>
<listitem>
<para><literal>id</literal>
<glossterm>optional</glossterm> (zero or one). A unique identifier.</para>
<formalpara>
<title>Uniqueness constraint</title>
<para>
No two instances of <literal>etymonUnit</literal>
in the same <literal>lexicographicResource</literal>
can have the same <literal>id</literal>.
</para>
</formalpara>
</listitem>
<listitem>
<para><literal>langCode</literal>
<glossterm>required</glossterm> (exactly one). An IETF tag. The tags can be
Expand Down
8 changes: 8 additions & 0 deletions dmlex-v1.0/specification/modules/linking/objectTypes/memberType.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,14 @@
<para><literal>role</literal>
<glossterm>required</glossterm> (exactly one). String. If the value is empty, then members
having this role do not need to have a <code>role</code> property.</para>
<formalpara>
<title>Uniqueness constraint</title>
<para>
No two instances of <literal>memberTYpe</literal>
in the same <literal>relationType</literal>
can have the same <literal>role</literal>.
</para>
</formalpara>
</listitem>
<listitem>
<para><literal>description</literal>
Expand Down
12 changes: 12 additions & 0 deletions dmlex-v1.0/specification/modules/linking/objectTypes/relation.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,18 @@

<itemizedlist>
<title>Properties</title>
<listitem>
<para><literal>id</literal>
<glossterm>optional</glossterm> (zero or one). A unique identifier.</para>
<formalpara>
<title>Uniqueness constraint</title>
<para>
No two instances of <literal>relation</literal>
in the same <literal>lexicographicResource</literal>
can have the same <literal>id</literal>.
</para>
</formalpara>
</listitem>
<listitem>
<para><literal>type</literal>
<glossterm>required</glossterm> (exactly one). Non-empty string. Specifies what type of
Expand Down
8 changes: 8 additions & 0 deletions dmlex-v1.0/specification/modules/linking/objectTypes/relationType.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,14 @@
<listitem>
<para><literal>type</literal>
<glossterm>required</glossterm> (exactly one). Non-empty string.</para>
<formalpara>
<title>Uniqueness constraint</title>
<para>
No two instances of <literal>relationType</literal>
in the same <literal>lexicographicResource</literal>
can have the same <literal>type</literal>.
</para>
</formalpara>
</listitem>
<listitem>
<para><literal>description</literal>
Expand Down
8 changes: 8 additions & 0 deletions dmlex-v1.0/specification/modules/values/objectTypes/definitionTypeTag.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,14 @@
<para><literal>tag</literal>
<glossterm>required</glossterm> (exactly one). Non-empty string. An abbreviation, a code or
some other string of text.</para>
<formalpara>
<title>Uniqueness constraint</title>
<para>
No two instances of <literal>definitionTypeTag</literal>
in the same <literal>lexicographicResource</literal>
can have the same <literal>tag</literal>.
</para>
</formalpara>
</listitem>
<listitem>
<para><literal>description</literal>
Expand Down
8 changes: 8 additions & 0 deletions dmlex-v1.0/specification/modules/values/objectTypes/inflectedFormTag.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,14 @@
<para><literal>tag</literal>
<glossterm>required</glossterm> (exactly one). Non-empty string. An abbreviation, a code or
some other string of text.</para>
<formalpara>
<title>Uniqueness constraint</title>
<para>
No two instances of <literal>inflectedFormTag</literal>
in the same <literal>lexicographicResource</literal>
can have the same <literal>tag</literal>.
</para>
</formalpara>
</listitem>
<listitem>
<para><literal>description</literal>
Expand Down
8 changes: 8 additions & 0 deletions dmlex-v1.0/specification/modules/values/objectTypes/labelTag.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,14 @@
<para><literal>tag</literal>
<glossterm>required</glossterm> (exactly one). Non-empty string. An abbreviation, a code or
some other string of text.</para>
<formalpara>
<title>Uniqueness constraint</title>
<para>
No two instances of <literal>labelTag</literal>
in the same <literal>lexicographicResource</literal>
can have the same <literal>tag</literal>.
</para>
</formalpara>
</listitem>
<listitem>
<para><literal>description</literal>
Expand Down
Loading
Loading