dssp.brailleLib

クラス XmlUtil

java.lang.Object

dssp.brailleLib.XmlUtil

すべての実装されたインタフェース:

org.xml.sax.ErrorHandler

public class XmlUtil
extends java.lang.Object
implements org.xml.sax.ErrorHandler

XML関連の便利クラス

作成者:

DSSP/Minoru Yagi

メソッドの概要

メソッド

修飾子とタイプ	メソッドと説明
static org.w3c.dom.Element	addElement(org.w3c.dom.Document doc, org.w3c.dom.Node parent, java.lang.String name) Elementを追加する
static org.w3c.dom.Element	addElement(org.w3c.dom.Document doc, java.lang.String path, boolean forced) Elementを追加する ・パス途中のNodeがなければ追加する
static void	addNodeText(org.w3c.dom.Document doc, org.w3c.dom.Node node, java.lang.String text) Nodeに値を追加する
static org.w3c.dom.Document	createDocument(java.lang.String namespace, java.lang.String name) Documentを生成する
void	error(org.xml.sax.SAXParseException exception)
void	fatalError(org.xml.sax.SAXParseException exception)
static org.w3c.dom.Node	getNode(org.w3c.dom.Document doc, java.lang.String xPathText) 指定したパスのノードを検索する [パスの形式] root/child1/child2
static org.w3c.dom.NodeList	getNodeList(org.w3c.dom.Document doc, java.lang.String xPathText) 指定したパスのノードリストを検索する [パスの形式] root/child1/child2
static java.lang.String	getNodeText(org.w3c.dom.Node node) Nodeの値を取得する
static java.lang.String	getString(org.w3c.dom.Document doc, java.lang.String xPathText) 指定したパスのテキストを取得する [パスの形式] root/child1/child2
static java.lang.String	getXmlText(org.w3c.dom.Node node) Nodeをテキストに変換する インデントなしで、getXmlText(Node, boolean)を呼ぶ
static java.lang.String	getXmlText(org.w3c.dom.Node node, boolean indent) Nodeをテキストに変換する
static javax.xml.xpath.XPath	getXPath() XPathを生成する
static org.w3c.dom.Document	parse(java.io.File file) ファイルからDocumentを生成する ・ファイルがない場合は、新しいDocumentを生成する
static org.w3c.dom.Document	parse(java.lang.String text) テキストからDocumentを生成する
static void	setString(org.w3c.dom.Document doc, java.lang.String path, java.lang.String val) 指定したパスにテキストを設定する ・パスの要素がなければ追加する ・パス以下の子ノードは削除する [パスの形式] root/child1/child2
void	warning(org.xml.sax.SAXParseException exception)
static void	write(org.w3c.dom.Document document, java.io.File file) Documentをファイルに書き込む

クラスから継承されたメソッド java.lang.Object

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

メソッドの詳細

getXPath

public static javax.xml.xpath.XPath getXPath()

XPathを生成する

戻り値:

XPath

getString

public static java.lang.String getString(org.w3c.dom.Document doc,
                         java.lang.String xPathText)
                                  throws javax.xml.xpath.XPathExpressionException

指定したパスのテキストを取得する
[パスの形式]
root/child1/child2

パラメータ:

doc - Document

xPathText - パス

戻り値:

テキスト。ノードがない場合は空文字

例外:

java.lang.IllegalArgumentException - 引数がnullか、xPathTextが空文字

javax.xml.xpath.XPathExpressionException - パスが不正

setString

public static void setString(org.w3c.dom.Document doc,
             java.lang.String path,
             java.lang.String val)
                      throws javax.xml.xpath.XPathExpressionException

指定したパスにテキストを設定する
・パスの要素がなければ追加する
・パス以下の子ノードは削除する
[パスの形式]
root/child1/child2

パラメータ:

doc - Document

path - パス

val - テキスト

例外:

java.lang.IllegalArgumentException - 引数がnullか、pathが空文字

javax.xml.xpath.XPathExpressionException - パスが不正

getNode

public static org.w3c.dom.Node getNode(org.w3c.dom.Document doc,
                       java.lang.String xPathText)
                                throws javax.xml.xpath.XPathExpressionException

指定したパスのノードを検索する
[パスの形式]
root/child1/child2

パラメータ:

doc - Document

xPathText - パス

戻り値:

検索したノード

例外:

java.lang.IllegalArgumentException - 引数がnullか、xPathTextが空文字

javax.xml.xpath.XPathExpressionException - パスが不正

getNodeList

public static org.w3c.dom.NodeList getNodeList(org.w3c.dom.Document doc,
                               java.lang.String xPathText)
                                        throws javax.xml.xpath.XPathExpressionException

指定したパスのノードリストを検索する
[パスの形式]
root/child1/child2

パラメータ:

doc - DOcument

xPathText - パス

戻り値:

検索したノードリスト

例外:

java.lang.IllegalArgumentException - 引数がnullか、xPathTextが空文字

javax.xml.xpath.XPathExpressionException - パスが不正

createDocument

public static org.w3c.dom.Document createDocument(java.lang.String namespace,
                                  java.lang.String name)
                                           throws javax.xml.parsers.ParserConfigurationException

Documentを生成する

パラメータ:

namespace - 名前空間

name - ルートのタグ名

戻り値:

Document

例外:

java.lang.IllegalArgumentException - nameがnullか、空文字

javax.xml.parsers.ParserConfigurationException - パスが不正

addElement

public static org.w3c.dom.Element addElement(org.w3c.dom.Document doc,
                             org.w3c.dom.Node parent,
                             java.lang.String name)

Elementを追加する

パラメータ:

doc - Document

parent - 親ノード

name - 追加するElementの名前

戻り値:

追加されたElement

例外:

java.lang.IllegalArgumentException - 引数がnullか、nameが空文字

addElement

public static org.w3c.dom.Element addElement(org.w3c.dom.Document doc,
                             java.lang.String path,
                             boolean forced)
                                      throws javax.xml.xpath.XPathExpressionException

Elementを追加する
・パス途中のNodeがなければ追加する

パラメータ:

doc - Document

path - 追加するElementのパス

forced - true=既に同じパスのElemenがあっても追加する false=追加しないで既にあるElementを返す

戻り値:

追加されたElement

例外:

java.lang.IllegalArgumentException - 引数がnullか、nameが空文字か、既にあるルートパスと異なる

javax.xml.xpath.XPathExpressionException - パスが不正

parse

public static org.w3c.dom.Document parse(java.io.File file)
                                  throws java.io.IOException,
                                         org.xml.sax.SAXException,
                                         javax.xml.parsers.ParserConfigurationException

ファイルからDocumentを生成する ・ファイルがない場合は、新しいDocumentを生成する

パラメータ:

file - ファイル名。nullの場合は新しいDocumentを生成する

戻り値:

Document

例外:

java.io.IOException

org.xml.sax.SAXException

javax.xml.parsers.ParserConfigurationException

parse

public static org.w3c.dom.Document parse(java.lang.String text)
                                  throws java.io.IOException,
                                         org.xml.sax.SAXException,
                                         javax.xml.parsers.ParserConfigurationException

テキストからDocumentを生成する

パラメータ:

text - XMLテキスト

戻り値:

Document

例外:

java.lang.IllegalArgumentException - 引数がnullか、空文字

java.io.IOException

org.xml.sax.SAXException

javax.xml.parsers.ParserConfigurationException

write

public static void write(org.w3c.dom.Document document,
         java.io.File file)
                  throws java.io.IOException,
                         javax.xml.transform.TransformerException,
                         java.io.FileNotFoundException

Documentをファイルに書き込む

パラメータ:

document - Document

file - ファイル名

例外:

java.lang.IllegalArgumentException - 引数がnullか、空文字

javax.xml.transform.TransformerException

java.io.FileNotFoundException

java.io.IOException

getXmlText

public static java.lang.String getXmlText(org.w3c.dom.Node node)
                                   throws javax.xml.transform.TransformerException

Nodeをテキストに変換する
インデントなしで、getXmlText(Node, boolean)を呼ぶ

パラメータ:

node -

戻り値:

テキスト

例外:

javax.xml.transform.TransformerException

getXmlText

public static java.lang.String getXmlText(org.w3c.dom.Node node,
                          boolean indent)
                                   throws javax.xml.transform.TransformerException

Nodeをテキストに変換する

パラメータ:

node -

indent - true=インデント fase = インデントなし

戻り値:

テキスト

例外:

java.lang.IllegalArgumentException - nodeがnull

javax.xml.transform.TransformerException

getNodeText

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

Nodeの値を取得する

パラメータ:

node - Node

戻り値:

値の文字列

例外:

java.lang.IllegalArgumentException - nodeがnull

関連項目:

addNodeText(Document, Node, String)

addNodeText

public static void addNodeText(org.w3c.dom.Document doc,
               org.w3c.dom.Node node,
               java.lang.String text)

Nodeに値を追加する

パラメータ:

doc -

node -

text -

例外:

java.lang.IllegalArgumentException - 引数がnullか、textが空文字

関連項目:

getNodeText(Node)

error

public void error(org.xml.sax.SAXParseException exception)
           throws org.xml.sax.SAXException

定義:

error インタフェース内 org.xml.sax.ErrorHandler

例外:

org.xml.sax.SAXException

fatalError

public void fatalError(org.xml.sax.SAXParseException exception)
                throws org.xml.sax.SAXException

定義:

fatalError インタフェース内 org.xml.sax.ErrorHandler

例外:

org.xml.sax.SAXException

warning

public void warning(org.xml.sax.SAXParseException exception)
             throws org.xml.sax.SAXException

定義:

warning インタフェース内 org.xml.sax.ErrorHandler

例外:

org.xml.sax.SAXException