com.hamaf.hikyaku.util
クラス XPathUtil

java.lang.Object
  上位を拡張 com.hamaf.hikyaku.util.XPathUtil

public class XPathUtil
extends java.lang.Object

タイトル: Xpath での Xml アクセス ツール クラス.

説明: Xml(Document Object)の操作を提供します。


処理するElementはXPath形式となります。

バージョン:
$Revision: 1.1 $, $Date: 2011/05/04 08:10:24 $, 新規作成
作成者:
Hamanaka

コンストラクタの概要
XPathUtil()
           
 
メソッドの概要
static void addChildElement(org.w3c.dom.Element elm, java.lang.String path, java.lang.String name, java.lang.String val)
          Describe addChildElement method : add Element child of path.
static void deleteElement(org.w3c.dom.Element argElm, java.lang.String path)
          Describe deleteElement method : Delete Element from Element.
static void deleteText(org.w3c.dom.Element argElm, java.lang.String path)
          Describe deleteText method : Delete Text from Element.
static java.lang.String generateXPath(org.w3c.dom.Node nd)
          Describe generateXPath method : Generate XPath String from Element Node.
static java.lang.String getValueWithPath(org.w3c.dom.Element elm, java.lang.String path)
          Describe getValueWithPath method : get Element Value by XPath.
static org.w3c.dom.NodeList searchElement(org.w3c.dom.Element argElm, java.lang.String path)
          Describe searchElement method : Search Element With Value.
static org.w3c.dom.Element searchElementWithPath(org.w3c.dom.Element argElm, java.lang.String path)
          Describe searchElementWithPath method : Element search by XPath.
static void setElementValue(org.w3c.dom.Element argElm, java.lang.String setPath, java.lang.String value)
          Describe setElementValue method : value set to Element.
static void setElementValueAt(org.w3c.dom.Element argElm, java.lang.String parent, java.lang.String addTag, java.lang.String value, java.lang.String posTag)
          Describe setElementValueAt method : value set to orgDom Element At Befor Pos.
 
クラス java.lang.Object から継承されたメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

コンストラクタの詳細

XPathUtil

public XPathUtil()
メソッドの詳細

setElementValue

public static final void setElementValue(org.w3c.dom.Element argElm,
                                         java.lang.String setPath,
                                         java.lang.String value)
                                  throws java.lang.Exception
Describe setElementValue method : value set to Element.
ElementへXPath Formatで指定されたElementと、渡された値を設定する。
設定するElementに子供のNodeが存在する場合はそれを削除します。
設定するエレメントは存在しなければ生成します。

パラメータ:
argElm - an Element : 操作するElement
setPath - a String : 値を設定するエレメントのXPath表現
value - a String : 設定する値
例外:
java.lang.Exception - if an error occurs

setElementValueAt

public static final void setElementValueAt(org.w3c.dom.Element argElm,
                                           java.lang.String parent,
                                           java.lang.String addTag,
                                           java.lang.String value,
                                           java.lang.String posTag)
                                    throws java.lang.Exception
Describe setElementValueAt method : value set to orgDom Element At Befor Pos.
Elementないの指定したタグの前に指定されたElementを追加し、渡された値を設定する。
指定された親エレメントが存在しなければ何もしません。
指定された位置エレメントが存在しなければ最後に追加します。

パラメータ:
argElm - an Element : 操作するElement
parent - a String : 値を設定するエレメントの親エレメントのXPath表現
addTag - a String : 設定するタグの名称
value - a String : 設定する値
posTag - a String : このタグの前にタグが追加される
例外:
java.lang.Exception

addChildElement

public static final void addChildElement(org.w3c.dom.Element elm,
                                         java.lang.String path,
                                         java.lang.String name,
                                         java.lang.String val)
                                  throws java.lang.Exception
Describe addChildElement method : add Element child of path.
エレメントnamepathの子供として追加する。

パラメータ:
elm - an Element : 操作するElement
path - a String : 追加する親エレメントのXPath文字列
name - a String : 追加するエレメント名
val - a String : 追加するエレメントの設定する値(null可)
例外:
java.lang.Exception - if an error occurs

getValueWithPath

public static final java.lang.String getValueWithPath(org.w3c.dom.Element elm,
                                                      java.lang.String path)
Describe getValueWithPath method : get Element Value by XPath.
ElementよりXPathで指定されたタグ(Element)の値取得する

パラメータ:
elm - an Element : 検索するElement
path - a String : 値を取得したいElementのXPath
戻り値:
a String : 取得した値

searchElementWithPath

public static final org.w3c.dom.Element searchElementWithPath(org.w3c.dom.Element argElm,
                                                              java.lang.String path)
Describe searchElementWithPath method : Element search by XPath.
ElementよりXPathで指定されたタグ(Element)を取得する

パラメータ:
argElm - an Element : 検索するElement
path - a String : 取得したいElementのXPath
戻り値:
an Element : 検索結果のElement

searchElement

public static final org.w3c.dom.NodeList searchElement(org.w3c.dom.Element argElm,
                                                       java.lang.String path)
Describe searchElement method : Search Element With Value.
値または属性値で一致するElementを検索しNodeListとして戻す。

パラメータ:
argElm -
path -
戻り値:
a NodeList :

deleteElement

public static final void deleteElement(org.w3c.dom.Element argElm,
                                       java.lang.String path)
Describe deleteElement method : Delete Element from Element.
指定したElementを渡されたElementから削除する。

パラメータ:
argElm - an Element : 削除もとのElement
path - a String : 削除するElementのXPath文字列

deleteText

public static final void deleteText(org.w3c.dom.Element argElm,
                                    java.lang.String path)
Describe deleteText method : Delete Text from Element.
指定されたElementのText(TextNode)を削除する。

パラメータ:
argElm - an Element : Textを削除するElementを含むElement
path - a String : Textを削除するElementのXPath文字列

generateXPath

public static final java.lang.String generateXPath(org.w3c.dom.Node nd)
Describe generateXPath method : Generate XPath String from Element Node.
渡されたorg.w3c.dom.NodeのルートエレメントからのXPath文字列を生成する。

パラメータ:
nd - a Node : XPath文字列を生成するNode
戻り値:
a String : 生成したXPath文字列