XML-vormingu selgitus

Klassifikaatori ja selle struktuuri edastamisel kasutatavate elementide kirjeldus

CLASET Toolbox'iga genereeritud dokument koosneb järgmistest elementidest:

Claset
 	Classification
 		Label
 		Level
 		Item

CLASET Toolbox'iga genereeritud dokumendi skeem

<Claset ....>
 	<Classification ....>
 		<Label ....>
 			<LabelText ....>
 			</LabelText>
 		</Label>
 		<Level ....>
 			<Level ....>
 				[ <Level ....> 
 					[ <Level ....>
 					....................
 					</Level> ]
 				</Level> ]
 			</Level>
 		</Level>
 		<Item ....>
 			<Label ....>
 				<LabelText ....>
 				</LabelText>
 			</Label>
 			[ <Property ....>
 				<PropertyQualifier ....>
 					<PropertyText ....>
 					</PropertyText>
 					[ <RelItem ....>
 					</RelItem> ]
 				</ PropertyQualifier>
 			</Property> ]
 			[ <Item ....>
 				<Label ....>
 					<LabelText ....>
 					</LabelText>
 				</Label>
 				[ <Property ....>
 					<PropertyQualifier ....>
 						<PropertyText ....>
 						</PropertyText>
 						[ <RelItem ....>
 						</RelItem> ]
 					</ PropertyQualifier>
 				</Property> ]
 				..................................
 			</Item> ]
  		</Item>
 		[ <Item ....>
 		...................
 		</Item> ]
 	</Classification ....>
 </Claset ....>

Claset
Selgitus
See on sõnumi juurelement, sisaldab sõnumi üldist kirjeldust.
Atribuudid
reference — viitenumber, mille annab dokumendi moodustaja (praegusel juhul — klassifikaatori lühinimetus)
version — dokumendi CLASET versiooninumber, praegusel juhul "1"
release — dokumendi CLASET redaktsiooninumber, praegusel juhul "0"
Alamelement
Classification — viitab edastatavale klassifikaatorile

Classification
Selgitus
Hierarhiline klassifikaator — mitme tasemega klassifikaator, mida on võimalik kujutada puustruktuurina.
Lineaarne klassifikaator — ühe tasemega klassifikaator e koodide loetelu.
Atribuudid
Id — klassifikaatori identifikaator, praegusel juhul alati klassifikaatori lühinimetus
version — versiooni number või väljaande kood, praegusel juhul klassifikaatori versioon
type — klassifikaatori tüüp; koodide loetelu korral ValueList, hierarhilise klassifikaatori korral Classification, mitme koodiga klassifikaatori korral Other
Alamelemendid
Label — klassifikaatori nimetus
Level — tase
Item — andmeelement (sisaldab koodi, koodile vastavat nimetust, selgitust jms)
Näidis

  <?xml version="1.0" encoding="UTF-8" ?> 
  <!DOCTYPE Claset (View Source for full doctype...)> 
- <Claset reference="KN" version="1" release="0">
  + <Classification id="KN" version="2005" type="Classification">
  </Claset>

Label
Selgitus
Kirjeldab elemendi (klassifikaatori, taseme, andmeelemendi) nimetust
Atribuut
Qualifier — nimetuse piiritleja; võimalikud väärtused on
Full | Usual | Normalised | Context
CLASET Toolbox'iga genereeritud XML-vormingus esineb ainult Full
Alamelement
LabelText — nimetuse tekst

LabelText
Selgitus
Kirjeldab harilikult elementi Label; elemendi Classification korral — klassifikaatori nimetus
Atribuut
language — teksti keel (ühe struktuuriga on võimalik klassifikaatorit edastada erinevates keeltes)
Näidis

  <?xml version="1.0" encoding="UTF-8" ?> 
  <!DOCTYPE Claset (View Source for full doctype...)> 
- <Claset reference="KN" version="1" release="0">
  - <Classification id="KN" version="2005" type="Classification">
    - <Label qualifier="Full">
        <LabelText language="ET">Kombineeritud nomenklatuur 2005</LabelText> 
      </Label>
 

Level
Selgitus
Klassifikaatori hierarhia tasemete kirjeldus
Atribuudid
Id — taseme identifikaator
qualifier — kirjeldab taseme rolli klassifikaatoris; CLASET Toolbox'iga genereeritud XML-vormingus on selleks tasemenumber
nbItems — kirjeldab taseme elementide arvu (k.a dummy ja uncoded)
Alamelement
Level — alamtase
Label — alamtaseme nimetus
Näidis

  <?xml version="1.0" encoding="UTF-8" ?> 
  <!DOCTYPE Claset (View Source for full doctype...)> 
- <Claset reference="KN" version="1" release="0">
  - <Classification id="KN" version="2005" type="Classification">
    - <Label qualifier="Full">
        <LabelText language="ET">Kombineeritud nomenklatuur 2005</LabelText> 
      </Label>
     - <Level id="1" qualifier="1" nbItems="21">
      - <Level id="2" qualifier="2" nbItems="97">
        - <Level id="3" qualifier="3" nbItems="1279">
          - <Level id="4" qualifier="4" nbItems="1254">
            - <Level id="5" qualifier="5" nbItems="3550">
              - <Level id="6" qualifier="6" nbItems="4995">
                - <Level id="7" qualifier="7" nbItems="3278">
                  - <Level id="8" qualifier="8" nbItems="1496">
                    - <Level id="9" qualifier="9" nbItems="628">
                      - <Level id="10" qualifier="10" nbItems="230">
                        - <Level id="11" qualifier="11" nbItems="142">
                            <Level id="12" qualifier="12" nbItems="31" /> 
                          </Level>
                        </Level>
                      </Level>
                    </Level>
                  </Level>
                </Level>
              </Level>
            </Level>
          </Level>
        </Level>
      </Level>

Item
Selgitus
Klassifikaatori andmeelement (kirje, rida), mis on seotud unikaalse koodiga.
Atribuudid
Id — klassifikaatori andmeelemendi identifikaator e kood (näiteks A, 01, 01.01 jms)
Idlevel — tasemenumber
type — andmeelemendi tüüp, kirjeldab grupeerimist või strukturaalset suhet. Selle võimalikud väärtused on
DummyGrouping | DummyDegrouping | OfficialGrouping | Uncoded
DummyGrouping — kasutatakse hierarhilise klassifikaatori korral tasemete järgnevuse tagamiseks; kirjeldatud andmeelement on fiktiivne
Lineaarse klassifikaatori korral moodustatakse esimesel tasemel DummyGrouping tehnilistel põhjustel.
Uncoded — kasutatakse koodita andmeelemendi märkimiseks (andmeelemendile on kirjeldatud fiktiivne kood)
Alamelemendid
Label — andmeelemendi nimetus e koodile vastav nimetus (vt elemendi Label kirjeldust)
Item — alam-andmeelement
Property — kirjeldab andmeelemendi märkuse, selgituse jms

Property
Selgitus
Antud juhul kirjeldab andmeelemendi selgituse.
Atribuut
name — võimalikud väärtused on
Footnote | ExplanatoryNote | Note | Name | Comment | Context | Objects | Keyword | Family | Area
CLASET Toolbox'iga genereeritakse ExplanatoryNote
Alamelement
PropertyQualifier

PropertyQualifier
Selgitus
Määrab selgituse tüübi.
Atribuudid
name — võimalikud väärtused (Property name= ExplanatoryNote) puhul on
CentralContent | LimitContent | Exclusions | Rules
LimitContent — piirab selgitava märkuse sisu; täpsustab, mida kood veel sisaldab
Exclusions — täpsustab, mida kood ei sisalda
Rules — reeglid, mida rakendatakse selgitava märkuse puhul
language — märkuse keel
Alamelemendid
PropertyText
RelItem

PropertyText
Selgitus
Selgituse tekst.
Atribuut
Type — võimalikud väärtused on
Subtitle | Content | Description | PlainText
Atribuudi type väärtuseks on CLASET Toolbox'i puhul Content, mis sisaldab selgituse teksti.
Kui selgitavas tekstis on kasutatud reavahetust, moodustatakse iga lõigu jaoks eraldi element
<PropertyText type="Content">

RelItem
Selgitus
Elemendi Exclusions korral viitab selgitusega seotud andmeelemendile (koodile).
Atribuut
id — väärtuseks on selgitavas märkuses viidatud sama klassifikaatori andmeelemendi (kirje/rea) identifikaator
Näidis

- <Item id="I" idLevel="1" type="Uncoded">
  - <Label qualifier="Full">
      <LabelText language="ET">I JAOTIS ELUSLOOMAD; LOOMSED TOOTED</LabelText> 
    </Label>
  - <Property name="ExplanatoryNote">
    - <PropertyQualifier name="CentralContent" language="ET">
        <PropertyText type="Content">Märkused</PropertyText>
        <PropertyText type="Content">1. Selles jaotises kehtib viide mingile
          loomaperekonnale või -liigile ka selle perekonna või liigi noorloomade
          kohta, kui kontekst ei nõua teisiti.</PropertyText>
        <PropertyText type="Content">2. Kogu nomenklatuuris tähendab termin
          "kuivatatud tooted" veetustatud, aurustamise või külmutamise teel
          kuivatatud tooteid, kui kontekst ei nõua teisiti.</PropertyText>
        <PropertyText type="Content" />
      </PropertyQualifier>
    </Property>
  - <Item id="01" idLevel="2" type="Uncoded">
    - <Label qualifier="Full">
        <LabelText language="ET">GRUPP 1 ELUSLOOMAD</LabelText> 
      </Label>
    - <Property name="ExplanatoryNote">
      - <PropertyQualifier name="CentralContent" language="ET">
          <PropertyText type="Content">Märkus</PropertyText>
          <PropertyText type="Content">1. Sellesse gruppi kuuluvad kõik
            elusloomad, välja arvatud:</PropertyText>
          <PropertyText type="Content">a) kalad ning vähid, limused ja muud
            veeselgrootud, kes kuuluvad vastavalt rubriikidesse 0301, 0306 ja
            0307;</PropertyText>
          <PropertyText type="Content">b) mikroorganismide kultuurid ja
            muud samalaadsed tooted, mis kuuluvad rubriiki 3002;</PropertyText>
          <PropertyText type="Content">c) rubriigi 9508 loomad.</PropertyText>
          <PropertyText type="Content" />
        </PropertyQualifier>
      </Property>
    - <Item id="0101" idLevel="3">
      - <Label qualifier="Full">
          <LabelText language="ET">Elushobused, -eeslid,
            -muulad ja -hobueeslid:</LabelText>
        </Label>
      - <Item id="0101 -" idLevel="4" type="DummyGrouping">
        - <Label qualifier="Full">
            <LabelText language="ET">- tõupuhtad
              aretusloomad:/- muud:</LabelText>
          </Label>
        - <Item id="0101 10" idLevel="5">
          - <Label qualifier="Full">
              <LabelText language="ET">- tõupuhtad aretusloomad:</LabelText> 
            </Label>
          - <Item id="0101 10 10" idLevel="6">
            - <Label qualifier="Full">
                <LabelText language="ET">- - hobused</LabelText>
              </Label>
            - <Property name="ExplanatoryNote">
              - <PropertyQualifier name="CentralContent" language="ET">
                  <PropertyText type="Content">Sellesse alamrubriiki
                    klassifitseerimisel tuleb järgida asjakohastes ühenduse
                    õigusaktides sätestatud tingimusi.</PropertyText>
                  <PropertyText type="Content">täiendav mõõtühik:
                    p/st (tükiarv)</PropertyText>
                </PropertyQualifier>
              </Property>
            </Item>

Klassifikaatoris Kombineeritud nomenklatuur 2005 määrab esimene tase klassifikaatori jaotised, millel kood puudub (andmeelemendi tüüp Uncoded). Teine tase määrab jaotise grupid, millel samuti kood puudub. Esimene koodiga andmeelement on kolmandal tasemel — 0101 Elushobused, -eeslid, -muulad ja -hobueeslid:. Neljas tase kirjeldab fiktiivse grupi, mis üldjuhul moodustatakse hierarhia tasemete järgnevuse tagamiseks. KN 2005 korral on fiktiivse grupi moodustamine neljandal tasemel tingitud koodi ja koodile vastava teksti ees taset määravate kriipsukeste mittevastavusest.

Lineaarse klassifikaatori korral viitab koodide loetelule klassifikaatori tüüp ValueList.
Lineaarse klassifikaatori XML-dokumendi moodustamisel CLASET Toolbox'iga luuakse tarkvarast tingitud põhjustel esimesel tasemel DummyGrouping.

Kui klassifikaatoris on mitut liiki koode (näiteks riikide ja territooriumide klassifikaator, valuutade ja fondide klassifikaator), on moodustatud lisatase, et esitada erinevad koodid ühe XML-dokumendina. Mitme koodiga klassifikaatori tüüp on Other.