Интерфейс SQLXML

public interface SQLXML

Сопоставление типа SQL XML в языке программирования JavaTM. XML — это встроенный тип, который хранит значение XML в столбце строки таблицы базы данных. По умолчанию драйверы реализуют объект SQLXML как логический указатель на данные XML, а не как сами данные. Объект SQLXML действителен в течение транзакции, в которой он был создан.

Интерфейс SQLXML предоставляет методы для доступа к значению XML в виде String, Reader или Writer, а также в виде Stream. К значению XML также можно получить доступ через Source или задать его как Result. Эти типы используются с API XML-парсеров, таких как DOM, SAX и StAX, а также с преобразованиями XSLT и вычислениями XPath.

Методы интерфейсов ResultSet, CallableStatement и PreparedStatement, например getSQLXML, позволяют программисту получить доступ к значению XML. Кроме того, этот интерфейс содержит методы для обновления значения XML.

Значение XML экземпляра SQLXML можно получить как BinaryStream с помощью

  SQLXML sqlxml = resultSet.getSQLXML(column);
  InputStream binaryStream = sqlxml.getBinaryStream();

Например, чтобы разобрать значение XML с помощью парсера DOM:

  DocumentBuilder parser = DocumentBuilderFactory.newInstance().newDocumentBuilder();
  Document result = parser.parse(binaryStream);

или разобрать значение XML с помощью парсера SAX и передать его вашему обработчику:

  SAXParser parser = SAXParserFactory.newInstance().newSAXParser();
  parser.parse(binaryStream, myHandler);

или разобрать значение XML с помощью парсера StAX:

  XMLInputFactory factory = XMLInputFactory.newInstance();
  XMLStreamReader streamReader = factory.createXMLStreamReader(binaryStream);

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

Например, чтобы получить узел DOM Document:

  DOMSource domSource = sqlxml.getSource(DOMSource.class);
  Document document = (Document) domSource.getNode();

или задать значение узлу DOM Document myNode:

  DOMResult domResult = sqlxml.setResult(DOMResult.class);
  domResult.setNode(myNode);

или отправить события SAX вашему обработчику:

  SAXSource saxSource = sqlxml.getSource(SAXSource.class);
  XMLReader xmlReader = saxSource.getXMLReader();
  xmlReader.setContentHandler(myHandler);
  xmlReader.parse(saxSource.getInputSource());

или задать результирующее значение из событий SAX:

  SAXResult saxResult = sqlxml.setResult(SAXResult.class);
  ContentHandler contentHandler = saxResult.getHandler();
  contentHandler.startDocument();
  // set the XML elements and attributes into the result
  contentHandler.endDocument();

или получить события StAX:

  StAXSource staxSource = sqlxml.getSource(StAXSource.class);
  XMLStreamReader streamReader = staxSource.getXMLStreamReader();

или задать результирующее значение из событий StAX:

  StAXResult staxResult = sqlxml.setResult(StAXResult.class);
  XMLStreamWriter streamWriter = staxResult.getXMLStreamWriter();

или выполнить преобразования XSLT значения XML с использованием XSLT из xsltFile и записать результат в файл resultFile:

  File xsltFile = new File("a.xslt");
  File myFile = new File("result.xml");
  Transformer xslt = TransformerFactory.newInstance().newTransformer(new StreamSource(xsltFile));
  Source source = sqlxml.getSource(null);
  Result result = new StreamResult(myFile);
  xslt.transform(source, result);

или вычислить выражение XPath для значения XML:

  XPath xpath = XPathFactory.newInstance().newXPath();
  DOMSource domSource = sqlxml.getSource(DOMSource.class);
  Document document = (Document) domSource.getNode();
  String expression = "/foo/@bar";
  String barValue = xpath.evaluate(expression, document);

Чтобы задать в качестве значения XML результат преобразования XSLT:

  File sourceFile = new File("source.xml");
  Transformer xslt = TransformerFactory.newInstance().newTransformer(new StreamSource(xsltFile));
  Source streamSource = new StreamSource(sourceFile);
  Result result = sqlxml.setResult(null);
  xslt.transform(streamSource, result);

Любой Source можно преобразовать в Result с помощью тождественного преобразования, указанного вызовом newTransformer():

  Transformer identity = TransformerFactory.newInstance().newTransformer();
  Source source = sqlxml.getSource(null);
  File myFile = new File("result.xml");
  Result result = new StreamResult(myFile);
  identity.transform(source, result);

Чтобы вывести содержимое Source в стандартный вывод:

  Transformer identity = TransformerFactory.newInstance().newTransformer();
  Source source = sqlxml.getSource(null);
  Result result = new StreamResult(System.out);
  identity.transform(source, result);

Чтобы создать DOMSource из DOMResult:

   DOMSource domSource = new DOMSource(domResult.getNode());

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

Чтение и запись значений XML из объекта SQLXML или в него могут выполняться не более одного раза. Концептуальные состояния «доступен для чтения» и «недоступен для чтения» определяют, вернёт ли один из API чтения значение или выбросит исключение. Концептуальные состояния «доступен для записи» и «недоступен для записи» определяют, задаст ли один из API записи значение или выбросит исключение.

Состояние меняется с доступного для чтения на недоступное для чтения после вызова free() или любого из API чтения: getBinaryStream(), getCharacterStream(), getSource() и getString(). Реализации также могут при этом менять состояние на недоступное для записи.

Состояние меняется с доступного для записи на недоступное для записи после вызова free() или любого из API записи: setBinaryStream(), setCharacterStream(), setResult() и setString(). Реализации также могут при этом менять состояние на недоступное для чтения.

Все методы интерфейса SQLXML должны быть полностью реализованы, если драйвер JDBC поддерживает этот тип данных.