Как передавать XML-данные с помощью XOM?

Скажем, я хочу вывести огромный набор результатов поиска, как XML, в PrintWriter или OutputStream, используя XOM. Полученный XML будет выглядеть так:

<?xml version="1.0" encoding="UTF-8"?>
<resultset>
    <result>
       [child elements and data]
    </result>
    ...
    ...
    [1000s of result elements more]
</resultset>

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

Гранулярность вывода одного <result> за раз в порядке, поэтому я хочу сгенерировать один <result> за другим и записать его в поток. Другими словами, я просто хотел бы сделать что-то вроде этого псевдокода (автоматическая промывка включена, поэтому не беспокойтесь об этом):

open stream/writer
write declaration
write start tag for <resultset>
while more results:
    write next <result> element
write end tag for <resultset> 
close stream/writer

Я смотрел Serializer, но необходимые методы writeStartTag(Element), writeEndTag(Element), write(DocType) защищены, а не публично! Нет ли другого способа, кроме подкласса Serializer, чтобы использовать эти методы или вручную записывать начальные и конечные теги непосредственно в поток как строки, минуя XOM вообще? (Последнее не так уж плохо в этом простом примере, но в общем случае оно получилось бы довольно уродливым.)

Я что-то пропустил или просто не сделал для этого XOM?

С dom4j Я мог бы сделать это легко, используя XMLWriter - у него есть конструкторы, которые принимают Writer или OutputStream, а методы writeOpen(Element), writeClose(Element), writeDocType(DocumentType) и т.д. Сравните с XOM Serializer, где единственный общедоступный метод write это тот, который принимает целое Document.

(Это связано с моим вопросом о лучшей замене dom4j, где XOM является сильным соперником.)

Ответы

Ответ 1

Я столкнулся с той же проблемой, но нашел довольно простым сделать то, что вы упомянули в качестве опции и подкласса Serializer следующим образом:

public class StreamSerializer extends Serializer {

    public StreamSerializer(OutputStream out) {
        super(out);
    }

    @Override
    public void write(Element element) throws IOException {
        super.write(element);
    }

    @Override
    public void writeXMLDeclaration() throws IOException {
        super.writeXMLDeclaration();
    }

    @Override
    public void writeEndTag(Element element) throws IOException {
        super.writeEndTag(element);
    }

    @Override
    public void writeStartTag(Element element) throws IOException {
        super.writeStartTag(element);
    }

}

Затем вы все равно можете использовать различные конфигурации XOM, такие как setIdent и т.д., но используйте его следующим образом:

Element rootElement = new Element("resultset");
StreamSerializer serializer = new StreamSerializer(out);
serializer.setIndent(4);
serializer.writeXMLDeclaration();
serializer.writeStartTag(rootElement);
while(hasNextElement()) {
    serializer.write(nextElement());
}
serializer.writeEndTag(rootElement);
serializer.flush();

Ответ 2

Насколько я знаю, XOM не поддерживает потоковое воспроизведение напрямую.

То, что я использовал, когда захотелось передать свои XML-документы, было NUX, который имеет потоковый XML-сериализатор, аналогичный стандартным классам Serializer в XOM. NUX совместим с XOM. Я загрузил источники NUX, извлек несколько классов NUX (интерфейс StreamingSerializer, StreamingXMLSerializer - который работает для документов XOM, StreamingVerifier и NamespacesInScope), поместил их в мой проект и работает как шарм. Жаль, что это не прямо в XOM: - (

NUX очень хороший компаньон для XOM: http://acs.lbl.gov/software/nux/, рабочее зеркало скачать: nux-1.6.tar.gz

Ссылка на API: http://acs.lbl.gov/software/nux/api/nux/xom/io/StreamingSerializer.html

Вот пример кода (методы вызывают в порядке: start(), n * nextResult(), finish(), сериализатор - StreamingXMLSerializer из NUX):

void start() {
    serializer.writeXMLDeclaration();

    Element root = new Element("response");
    root.addAttribute(new Attribute("found", Integer.toString(123)));
    root.addAttribute(new Attribute("count", Integer.toString(542)));

    serializer.writeStartTag(root);

    serializer.flush();
}

void nextResult(Result result) {
    Element element = result.createXMLRepresentation();
    serializer.write(element);
    serializer.flush();
}

void finish() {
    serializer.writeEndTag();
    serializer.flush();
}