Как найти позицию в xml

DOM: Как узнать позицию в XML-файле?

Проблема проста: XML-документ, считанный в представление DOM, как-то обрабатывается.
Ну то есть так:

   DocumentBuilderFactory factory = DocumentBuilderFactory.newInstance();
   DocumentBuilder builder = factory.newDocumentBuilder();
   Document document = builder.parse(configFile);
   ...

В некоторый момент становится ясно, что структура файла нарушена. Печатаем сообщение об ошибке.
Хочется в нём указать хотя бы строку в исходном файле, где находится ошибка.

Как это сделать — узнать строку в исходном XML?
Нагуглить не получается, в сорцах J2SE 5.0 не вижу ничего полезного…

Re: DOM: Как узнать позицию в XML-файле?

Здравствуйте, Аноним, Вы писали:

А>Проблема проста: XML-документ, считанный в представление DOM, как-то обрабатывается.
А>Ну то есть так:

А>

А>   DocumentBuilderFactory factory = DocumentBuilderFactory.newInstance();
А>   DocumentBuilder builder = factory.newDocumentBuilder();
А>   Document document = builder.parse(configFile);
А>   ...
А>

А>В некоторый момент становится ясно, что структура файла нарушена. Печатаем сообщение об ошибке.
А>Хочется в нём указать хотя бы строку в исходном файле, где находится ошибка.

А>Как это сделать — узнать строку в исходном XML?

SAXException может содержать полезную информацию, если он не содержит, значит надо сменить SAX Parser.

Re[2]: DOM: Как узнать позицию в XML-файле?

Здравствуйте, dshe, Вы писали:

D>SAXException может содержать полезную информацию, если он не содержит, значит надо сменить SAX Parser.

Дело ведь в том, что я не использую SAX. У меня уже есть модель DOM. Насколько я понимаю, пользователь не имеет контроля над подстроением DOM и, соответственно, над SAX парсерами и SAX исключениями.

Re[3]: DOM: Как узнать позицию в XML-файле?

Здравствуйте, Аноним, Вы писали:

А>Здравствуйте, dshe, Вы писали:

D>>SAXException может содержать полезную информацию, если он не содержит, значит надо сменить SAX Parser.

А>Дело ведь в том, что я не использую SAX. У меня уже есть модель DOM. Насколько я понимаю, пользователь не имеет контроля над подстроением DOM и, соответственно, над SAX парсерами и SAX исключениями.

Какие тогда ты классы используешь?
javax.xml.parsers.DocumentBuilder.parse(…) методы бросают SAXException

Приведи более полный пример кода с импортами и обработкой исключений.

Re[3]: DOM: Как узнать позицию в XML-файле?

Здравствуйте, Аноним, Вы писали:

А>Здравствуйте, dshe, Вы писали:

D>>SAXException может содержать полезную информацию, если он не содержит, значит надо сменить SAX Parser.

А>Дело ведь в том, что я не использую SAX. У меня уже есть модель DOM. Насколько я понимаю, пользователь не имеет контроля над подстроением DOM и, соответственно, над SAX парсерами и SAX исключениями.

В DOM Document’е информация об источнике не хранится. Т.е. если парсинг прошел успешно и документ сформирован, то узнать, какой тэг на какой строке в каком файле находится, в общем случае невозможно. Попробуй валидировать xml парсером (по DTD или схеме) в момент построения DOM Document’а.

Re[4]: DOM: Как узнать позицию в XML-файле?

Здравствуйте, dshe, Вы писали:

D>В DOM Document’е информация об источнике не хранится. Т.е. если парсинг прошел успешно и документ сформирован, то узнать, какой тэг на какой строке в каком файле находится, в общем случае невозможно. Попробуй валидировать xml парсером (по DTD или схеме) в момент построения DOM Document’а.

Нет, это не подходит, к сожалению… Документ уже построен, я его обхожу несколько раз и нахожу некоторые зависимости между нодами. Если зависимости нарушаются — говорю: такая вот нода — плохая (то бишь тег). Документы здоровые, однотиптных тегов много, и информация об их местонахождении в файле была бы очень полезна.

Вот шаблон, на котором у меня всё построено:

import java.io.*;
import java.util.*;

import org.w3c.dom.*;
import org.xml.sax.SAXException;

import javax.xml.parsers.DocumentBuilder; 
import javax.xml.parsers.DocumentBuilderFactory;  
import javax.xml.parsers.ParserConfigurationException;

public class XMLTest {
    public static void main(String[] a) throws Exception {
        DocumentBuilderFactory factory = DocumentBuilderFactory.newInstance();
        DocumentBuilder builder = factory.newDocumentBuilder();
        Document document = builder.parse(a[0]);
        NodeList nodes = document.getElementsByTagName("tag");

        if(nodes.getLength() > 1) {
            System.out.println("tag node has more tyhat one instances");
            return;
        }

        nodes = nodes.item(0).getChildNodes();

        for(int i = 0; i < nodes.getLength(); i++) {
            Node node = nodes.item(i);
        
            System.out.println("Node type: '" + node.getNodeType() + "'");
            System.out.println("Node name: '" + node.getNodeName() + "'");
            System.out.println("Node value: '" + node.getNodeValue() + "'");
        }
    }
}

Re: DOM: Как узнать позицию в XML-файле?

Здравствуйте, Аноним, Вы писали:

А>В некоторый момент становится ясно, что структура файла нарушена. Печатаем сообщение об ошибке.
А>Хочется в нём указать хотя бы строку в исходном файле, где находится ошибка.

1) синтаксические проблемы далеко не всегда настолько просты, что можно показать адекватный номер строки. иногда доступен только тот номер, на котором стало понятно, что все плохо, и он может сильно отличаться от того места, где реально накосячили.
с этим практически ничего поделать нельзя — xml по задумке должен генерироваться, а не пишется от начала до конца руками, поэтому делать заточки в парсерах на глубокий анализ ошибок в общем-то их производителям не выгодно.

2) большинство остальных проблем имеет смысл попробовать решить с помощью парсера на основе XML Schema Definition, проверяющего валидность. в некоторых случаях и с номерами строк должно стать получше, и кода вам писать меньше для всех ситуаций, контроль которых покроется возможностями XSD

3) все, что не покроется XSD, т.е. совсем высокоуровнеый анализ, можно делать с использованием каких-то ключевых данных, которые в Вашем XML наверняка есть. уникальные строковые имена — или что-то подобное. тогда в сообщениях о семантических ошибках достаточно включать эту информацию, и нужный тег можно будет без труда найти

Re[5]: DOM: Как узнать позицию в XML-файле?

Здравствуйте, Аноним, Вы писали:

А>Нет, это не подходит, к сожалению… Документ уже построен, я его обхожу несколько раз и нахожу некоторые зависимости между нодами. Если зависимости нарушаются — говорю: такая вот нода — плохая (то бишь тег). Документы здоровые, однотиптных тегов много, и информация об их местонахождении в файле была бы очень полезна.

А не пробовал всю валидацию в XSD схему засунуть? И не использовать код для этого.

У меня это работает, следуя этому примеру:

Generating DOM from XML preserving line numbers

Это решение следует методу, предложенному Майклом Кей. Вот как вы его используете:

// XmlTest.java

import java.io.ByteArrayInputStream;
import java.io.InputStream;

import org.w3c.dom.Document;
import org.w3c.dom.Node;

public class XmlTest {
    public static void main(final String[] args) throws Exception {

        String xmlString = "<foo>n"
                         + "    <bar>n"
                         + "        <moo>Hello World!</moo>n"
                         + "    </bar>n"
                         + "</foo>";

        InputStream is = new ByteArrayInputStream(xmlString.getBytes());
        Document doc = PositionalXMLReader.readXML(is);
        is.close();

        Node node = doc.getElementsByTagName("moo").item(0);

        System.out.println("Line number: " + node.getUserData("lineNumber"));
    }
}

Если вы запустите эту программу, она выйдет: «Номер строки: 3»

PositionalXMLReader — это слегка измененная версия приведенного выше примера.

// PositionalXMLReader.java

import java.io.IOException;
import java.io.InputStream;
import java.util.Stack;

import javax.xml.parsers.DocumentBuilder;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.parsers.SAXParser;
import javax.xml.parsers.SAXParserFactory;

import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.Node;
import org.xml.sax.Attributes;
import org.xml.sax.Locator;
import org.xml.sax.SAXException;
import org.xml.sax.helpers.DefaultHandler;

public class PositionalXMLReader {
    final static String LINE_NUMBER_KEY_NAME = "lineNumber";

    public static Document readXML(final InputStream is) throws IOException, SAXException {
        final Document doc;
        SAXParser parser;
        try {
            final SAXParserFactory factory = SAXParserFactory.newInstance();
            parser = factory.newSAXParser();
            final DocumentBuilderFactory docBuilderFactory = DocumentBuilderFactory.newInstance();
            final DocumentBuilder docBuilder = docBuilderFactory.newDocumentBuilder();
            doc = docBuilder.newDocument();
        } catch (final ParserConfigurationException e) {
            throw new RuntimeException("Can't create SAX parser / DOM builder.", e);
        }

        final Stack<Element> elementStack = new Stack<Element>();
        final StringBuilder textBuffer = new StringBuilder();
        final DefaultHandler handler = new DefaultHandler() {
            private Locator locator;

            @Override
            public void setDocumentLocator(final Locator locator) {
                this.locator = locator; // Save the locator, so that it can be used later for line tracking when traversing nodes.
            }

            @Override
            public void startElement(final String uri, final String localName, final String qName, final Attributes attributes)
                    throws SAXException {
                addTextIfNeeded();
                final Element el = doc.createElement(qName);
                for (int i = 0; i < attributes.getLength(); i++) {
                    el.setAttribute(attributes.getQName(i), attributes.getValue(i));
                }
                el.setUserData(LINE_NUMBER_KEY_NAME, String.valueOf(this.locator.getLineNumber()), null);
                elementStack.push(el);
            }

            @Override
            public void endElement(final String uri, final String localName, final String qName) {
                addTextIfNeeded();
                final Element closedEl = elementStack.pop();
                if (elementStack.isEmpty()) { // Is this the root element?
                    doc.appendChild(closedEl);
                } else {
                    final Element parentEl = elementStack.peek();
                    parentEl.appendChild(closedEl);
                }
            }

            @Override
            public void characters(final char ch[], final int start, final int length) throws SAXException {
                textBuffer.append(ch, start, length);
            }

            // Outputs text accumulated under the current node
            private void addTextIfNeeded() {
                if (textBuffer.length() > 0) {
                    final Element el = elementStack.peek();
                    final Node textNode = doc.createTextNode(textBuffer.toString());
                    el.appendChild(textNode);
                    textBuffer.delete(0, textBuffer.length());
                }
            }
        };
        parser.parse(is, handler);

        return doc;
    }
}