eu.vexpro.editor.util
Class XMLUtil

java.lang.Object
  eu.vexpro.editor.util.XMLUtil

public class XMLUtil
extends java.lang.Object

XML utiliitide kogum.

Field Summary

static java.lang.String	ELEMENT_MUUTUS
static java.lang.String	ENCODING
static java.lang.String	XSD_FILE_ASUKOHT
static java.lang.String	XSD_FILE_JUURAKT

Constructor Summary

XMLUtil()

Method Summary

static java.lang.String	documentToString(org.w3c.dom.Document document) DOM dokument stringiks teisendamine.
static void	eemaldaNodeNimeJaIdAbil(org.w3c.dom.Document doc, java.lang.String elementNimi, java.lang.String elementId) DOM documendist eemaldatakse node nime ja id atribuudi väärtuse järgi.
static void	eemaldaNodeNimeJargi(org.w3c.dom.Node node, java.lang.String elementNimi) Eemaldatadakse dokumendist elemedid nime järgi.
static java.util.List	getEelmineJargmineSeqElement(java.util.List<java.util.List<java.lang.String>> seqList, java.lang.String otsitavNimi) Deprecated. REMOVE Leitakse eelmine ja järgmine elemendi nimi sequence järjekorras, vastavalt otsitava elemendi nimele
static ElementDefaultValueAndEnumeration	getElementDefaultValue(java.lang.String elementNimi, java.lang.String xsdFile) Tagastatakse elemendi default väärtus.
static ElementDefaultValueAndEnumeration	getElementDefaultValueAndEnumeration(java.lang.String elementNimi, java.lang.String xsdFile) Leitakse vastavast schemast metaandmete vaikeväärtused ja enumeration väärtused, kui eksisteerivad.
static org.w3c.dom.Element	getPreviousSiblingElement(org.w3c.dom.Node node)
static boolean	isEmpty(org.w3c.dom.NodeList nl) NodeList on tühi või mitte.
static void	iteereriYleAlamate(org.w3c.dom.Element element, java.util.List<MetaElementNimiVaartus> resultList, java.lang.String jooksevXSDFail, java.lang.String ignoreeriElementNimi) Rekursiivne meetod üle alamelementide itereerimiseks.
static java.lang.String	leiaElemendiDokumentatsioon(java.lang.String element, java.lang.String xsdFile) Leiab elemendi nimele vastava elemendi kirjelduse (dokumentatsiooni).
static org.w3c.dom.Element	leiaElementNimeJaIdAbil(org.w3c.dom.Document doc, java.lang.String elementNimi, java.lang.String elementId) Elemendi leidmine DOM dokumendist elemendi nime ja elemendi id järgi.
static org.w3c.dom.Element	leiaEsimeneAlamelementNimeAbil(java.lang.String elementNimi, org.w3c.dom.Element parent) Leitakse esimene nimele vastav alamelement.
static org.w3c.dom.Element	leiaEsimeneAlamelementNimeAbil(java.lang.String elementNimi, java.lang.String parentElementNimi, org.w3c.dom.Element parent)
static void	leiaEsimeneElementNimeAbil(org.w3c.dom.Element parentElement, java.lang.String nimi, java.util.List<org.w3c.dom.Element> hoidla) Leida esimene xml element elemendi nime abil.
static void	leiaXMLelementIDAbil(org.w3c.dom.Element parentElement, java.lang.String id, java.util.List<org.w3c.dom.Element> hoidla) Leida xml element id abil.
static boolean	leidubDokumendisElement(org.w3c.dom.Document doc, java.lang.String elementNimi) Konntrollitakse, kas dokumendis leidub elementi, mille nimi parameetrina antud.
static void	lisaXMLelementIDAtribuut(org.w3c.dom.Element parentElement) XML elemendiel id atribuudi lisamine.
static java.util.Map	loeXSDElementDokumentatsioon(java.lang.String xsdFile) Loeb xsd failist elemendile vastava dokumentatsiooni.
static java.util.Map	loeXSDMetaElementEnumeration(java.lang.String xsdFile) XSD failist vaikeväärtuste ja lubatud väärtuste mapi täitmine.
static java.util.List<java.util.List<java.lang.String>>	loeXSDSequenceList(java.lang.String xsdFile)
static java.util.Map	loeXSDVanemElementSequenceJarjestus(java.lang.String xsdFile) Deprecated. - REMOVE
static void	mergeJargnevElement(org.w3c.dom.Element parent, java.lang.String mergeElementName) Ühendab kõrvuti asetsevad samanimelised elemendid üheks elemendiks.
static void	mergeJargnevElement(org.w3c.dom.Element parent, java.lang.String mergeElementName, java.lang.String id) Samanimeliste ja sama id-d omavate elementide ühendamine.
static void	nimetaElementYmber(org.w3c.dom.Element vanaElement) Elemendi nime muutmine (luuakse uuse eelement, kopeeritakse sinna vajalik ja eemaldatakse vana element)
static boolean	nodeListIsEmpty(org.w3c.dom.NodeList nl) Kas NodeList on null või tühi.
static java.lang.String	nodeToString(org.w3c.dom.Node node) Node esitamine xml formaadis stringi kujul.
static org.w3c.dom.DocumentFragment	parseXml(org.w3c.dom.Document doc, java.lang.String fragment) Parses a string containing XML and returns a DocumentFragment.
static org.w3c.dom.Document	parseXmlFile(java.lang.String filename, boolean validating) XML faili lugemine ja parsimine DOM dokumendiks.
static org.w3c.dom.Element	poolitaNode(org.w3c.dom.Element currentElement, int positsioon) Teksti sisaldava elemendi poolitamine teksti mingilt positsioonilt.
static java.lang.String	readXMLFileContentToString(java.lang.String fileName) Tagastab xml faili sisu stringina.
static void	removeChildrenNodes(org.w3c.dom.Element element) Eemaldatakse kõik child elemendid parameetrina antud elemendilt.
static org.w3c.dom.Document	stringToDocument(java.lang.String xmlString) Teisendab xml stringi DOM dokumendiks.
static org.w3c.dom.Document	stringToDocument(java.lang.String xmlString, boolean validate) Teisendab xml stringi DOM dokumendiks, saab sättida, kas valideerimisega või valideerimiseta.
static java.lang.String	tootleVeateadeEestikeelseks(java.lang.String dokumentValideerimineTulem) Valideerimise tulemusel saadud exceptioni teksti töötlemine eesti keelseks.
static ValideerimineViga	validateXML(org.w3c.dom.Document document, java.lang.String xsdFilePath) XML dokumendi valideerimine vastu schema faili.
static void	writeXmlFile(org.w3c.dom.Document doc, java.lang.String filename) Dom dokumendist xml file loomine.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ENCODING

public static final java.lang.String ENCODING

See Also:

Constant Field Values

XSD_FILE_ASUKOHT

public static final java.lang.String XSD_FILE_ASUKOHT

See Also:

Constant Field Values

XSD_FILE_JUURAKT

public static final java.lang.String XSD_FILE_JUURAKT

See Also:

Constant Field Values

ELEMENT_MUUTUS

public static final java.lang.String ELEMENT_MUUTUS

See Also:

Constant Field Values

Constructor Detail

XMLUtil

public XMLUtil()

Method Detail

readXMLFileContentToString

public static java.lang.String readXMLFileContentToString(java.lang.String fileName)

Tagastab xml faili sisu stringina.

Parameters:

fileName -

Returns:

stringToDocument

public static org.w3c.dom.Document stringToDocument(java.lang.String xmlString)

Teisendab xml stringi DOM dokumendiks.

Parameters:

xmlString -

Returns:

stringToDocument

public static org.w3c.dom.Document stringToDocument(java.lang.String xmlString,
                                                    boolean validate)

Teisendab xml stringi DOM dokumendiks, saab sättida, kas valideerimisega või valideerimiseta.

Parameters:

xmlString -

validate -

Returns:

parseXmlFile

public static org.w3c.dom.Document parseXmlFile(java.lang.String filename,
                                                boolean validating)

XML faili lugemine ja parsimine DOM dokumendiks.

Parameters:

filename -

validating -

Returns:

documentToString

public static java.lang.String documentToString(org.w3c.dom.Document document)

DOM dokument stringiks teisendamine.

Parameters:

document -

Returns:

getElementDefaultValueAndEnumeration

public static ElementDefaultValueAndEnumeration getElementDefaultValueAndEnumeration(java.lang.String elementNimi,
                                                                                     java.lang.String xsdFile)

Leitakse vastavast schemast metaandmete vaikeväärtused ja enumeration väärtused, kui eksisteerivad.

Parameters:

elementNimi - otsitavale infole vastav elemendi nimetus.

xsdFile - xsd faili nimi töövahendi formaadis.

Returns:

ElementDefaultValueAndEnumeration objekt kui leidub, vastasel juhul null.

getElementDefaultValue

public static ElementDefaultValueAndEnumeration getElementDefaultValue(java.lang.String elementNimi,
                                                                       java.lang.String xsdFile)

Tagastatakse elemendi default väärtus.

Parameters:

elementNimi -

xsdFile -

Returns:

loeXSDElementDokumentatsioon

public static java.util.Map loeXSDElementDokumentatsioon(java.lang.String xsdFile)

Loeb xsd failist elemendile vastava dokumentatsiooni. Loob element - kirjeldus mapi.

Returns:

loeXSDMetaElementEnumeration

public static java.util.Map loeXSDMetaElementEnumeration(java.lang.String xsdFile)

XSD failist vaikeväärtuste ja lubatud väärtuste mapi täitmine. vaikeväärtus - default lubatud väärtused - enumeration Mapi lisatakse vastav info ainult juhul kui leidub kas vaikeväärtus või lubatud väärtused või mõlemad.

Parameters:

xsdFile -

Returns:

poolitaNode

public static org.w3c.dom.Element poolitaNode(org.w3c.dom.Element currentElement,
                                              int positsioon)

Teksti sisaldava elemendi poolitamine teksti mingilt positsioonilt. Kasutatakse näiteks reavahetuse korral tavatekst elementide poolitamiseks. Elemendi poolitamine, nii et väärtus poolitakse teksti node õigelt positsioonilt. Tagastatakse poolitatud elemendi viimane element või kui tekst oli tühi siis järgnev element samal tasemel.

Parameters:

currentElement - element, mida soovitakse poolitada

positsioon - positsioon tekstis, kust soovitakse poolitada

Returns:

poolitatud elemendi uus loodud element

leiaElemendiDokumentatsioon

public static java.lang.String leiaElemendiDokumentatsioon(java.lang.String element,
                                                           java.lang.String xsdFile)

Leiab elemendi nimele vastava elemendi kirjelduse (dokumentatsiooni).

Parameters:

element -

Returns:

iteereriYleAlamate

public static void iteereriYleAlamate(org.w3c.dom.Element element,
                                      java.util.List<MetaElementNimiVaartus> resultList,
                                      java.lang.String jooksevXSDFail,
                                      java.lang.String ignoreeriElementNimi)

Rekursiivne meetod üle alamelementide itereerimiseks. Kasutus: vaade.metadata.MetadataVaade

Parameters:

element - - root node

resultList - - alamelementide hoidla, alamelemente hoitakse MetaElementNimiVaartus objktidena

jooksevXSDFail - xsd fail, XMLUtil konstant prefix XSD_FILE_...

validateXML

public static ValideerimineViga validateXML(org.w3c.dom.Document document,
                                            java.lang.String xsdFilePath)

XML dokumendi valideerimine vastu schema faili. Juhul kui dokument valideerub tagastatakse null. Dokumendi mitte valideerumisel tagastatakse ValideerimineViga objekt.

Parameters:

document - DOM dokument

xsdFilePath - schema faili asukoht

Returns:

tootleVeateadeEestikeelseks

public static java.lang.String tootleVeateadeEestikeelseks(java.lang.String dokumentValideerimineTulem)

Valideerimise tulemusel saadud exceptioni teksti töötlemine eesti keelseks.

Parameters:

dokumentValideerimineTulem -

Returns:

writeXmlFile

public static void writeXmlFile(org.w3c.dom.Document doc,
                                java.lang.String filename)

Dom dokumendist xml file loomine.

Parameters:

doc -

filename -

lisaXMLelementIDAtribuut

public static void lisaXMLelementIDAtribuut(org.w3c.dom.Element parentElement)

XML elemendiel id atribuudi lisamine. Id atribuudi väärtuseks saab uuid (guid

Parameters:

parentElement -

leiaXMLelementIDAbil

public static void leiaXMLelementIDAbil(org.w3c.dom.Element parentElement,
                                        java.lang.String id,
                                        java.util.List<org.w3c.dom.Element> hoidla)

Leida xml element id abil.

Parameters:

parentElement -

id -

hoidla -

leiaEsimeneElementNimeAbil

public static void leiaEsimeneElementNimeAbil(org.w3c.dom.Element parentElement,
                                              java.lang.String nimi,
                                              java.util.List<org.w3c.dom.Element> hoidla)

Leida esimene xml element elemendi nime abil.

Parameters:

parentElement -

nimi - elemendi nimi

hoidla -

leiaElementNimeJaIdAbil

public static org.w3c.dom.Element leiaElementNimeJaIdAbil(org.w3c.dom.Document doc,
                                                          java.lang.String elementNimi,
                                                          java.lang.String elementId)

Elemendi leidmine DOM dokumendist elemendi nime ja elemendi id järgi.

Parameters:

doc -

elementNimi -

elementId -

Returns:

leiaEsimeneAlamelementNimeAbil

public static org.w3c.dom.Element leiaEsimeneAlamelementNimeAbil(java.lang.String elementNimi,
                                                                 org.w3c.dom.Element parent)

Leitakse esimene nimele vastav alamelement.

Parameters:

elementNimi - otsitava alamelemendi nimi

parent - elemendi kuuluvus (vanemelement)

Returns:

leiaEsimeneAlamelementNimeAbil

public static org.w3c.dom.Element leiaEsimeneAlamelementNimeAbil(java.lang.String elementNimi,
                                                                 java.lang.String parentElementNimi,
                                                                 org.w3c.dom.Element parent)

eemaldaNodeNimeJaIdAbil

public static void eemaldaNodeNimeJaIdAbil(org.w3c.dom.Document doc,
                                           java.lang.String elementNimi,
                                           java.lang.String elementId)

DOM documendist eemaldatakse node nime ja id atribuudi väärtuse järgi.

Parameters:

doc - DOM dokument

elementNimi - elemendi nimi

elementId - elemendi atribuut id väärtus

eemaldaNodeNimeJargi

public static void eemaldaNodeNimeJargi(org.w3c.dom.Node node,
                                        java.lang.String elementNimi)

Eemaldatadakse dokumendist elemedid nime järgi. Näiteks: eemaldaNodeNimeJargi(doc, "junk");

Parameters:

node -

elementNimi -

leidubDokumendisElement

public static boolean leidubDokumendisElement(org.w3c.dom.Document doc,
                                              java.lang.String elementNimi)

Konntrollitakse, kas dokumendis leidub elementi, mille nimi parameetrina antud.

Parameters:

doc -

elementNimi -

Returns:

loeXSDVanemElementSequenceJarjestus

public static java.util.Map loeXSDVanemElementSequenceJarjestus(java.lang.String xsdFile)

Deprecated. - REMOVE

Parameters:

xsdFile -

Returns:

loeXSDSequenceList

public static java.util.List<java.util.List<java.lang.String>> loeXSDSequenceList(java.lang.String xsdFile)

getEelmineJargmineSeqElement

public static java.util.List getEelmineJargmineSeqElement(java.util.List<java.util.List<java.lang.String>> seqList,
                                                          java.lang.String otsitavNimi)

Deprecated. REMOVE Leitakse eelmine ja järgmine elemendi nimi sequence järjekorras, vastavalt otsitava elemendi nimele

Parameters:

seqList -

Returns:

mergeJargnevElement

public static void mergeJargnevElement(org.w3c.dom.Element parent,
                                       java.lang.String mergeElementName)

Ühendab kõrvuti asetsevad samanimelised elemendid üheks elemendiks. Elementises sisalduvad text noded ühendatakse üheks. Kasutatkse dokumendi korrastamiseks, vältimaks, et kõrvuti ei tekiks samanimelisi elemente. Näiteks: 123456789>fafdaffdafdasfadsfa tulemus: 123456789>fafdaffdafdasfadsfa

Parameters:

parent -

mergeElementName -

mergeJargnevElement

public static void mergeJargnevElement(org.w3c.dom.Element parent,
                                       java.lang.String mergeElementName,
                                       java.lang.String id)

Samanimeliste ja sama id-d omavate elementide ühendamine.

Parameters:

parent -

mergeElementName -

id -

nimetaElementYmber

public static void nimetaElementYmber(org.w3c.dom.Element vanaElement)

Elemendi nime muutmine (luuakse uuse eelement, kopeeritakse sinna vajalik ja eemaldatakse vana element)

nodeListIsEmpty

public static boolean nodeListIsEmpty(org.w3c.dom.NodeList nl)

Kas NodeList on null või tühi.

Parameters:

nl -

Returns:

nodeToString

public static java.lang.String nodeToString(org.w3c.dom.Node node)

Node esitamine xml formaadis stringi kujul. Kasutus: arendustöö, testimine. Tänud: http://projectwownow.blogspot.com/2008/08/java-node-to-string-conversion.html

Parameters:

node -

Returns:

parseXml

public static org.w3c.dom.DocumentFragment parseXml(org.w3c.dom.Document doc,
                                                    java.lang.String fragment)

Parses a string containing XML and returns a DocumentFragment. Containing the nodes of the parsed XML.

Parameters:

doc -

fragment -

Returns:

removeChildrenNodes

public static void removeChildrenNodes(org.w3c.dom.Element element)

Eemaldatakse kõik child elemendid parameetrina antud elemendilt.

Parameters:

element -

isEmpty

public static boolean isEmpty(org.w3c.dom.NodeList nl)

NodeList on tühi või mitte.

Parameters:

nl -

Returns:

getPreviousSiblingElement

public static org.w3c.dom.Element getPreviousSiblingElement(org.w3c.dom.Node node)