ts.util.resource
クラス DefaultResource

java.lang.Object
  上位を拡張 ts.util.resource.AbstractResource
      上位を拡張 ts.util.resource.DefaultResource
すべての実装されたインタフェース:
Resource
直系の既知のサブクラス:
PropertyResource

public abstract class DefaultResource
extends AbstractResource

階層構造をもった要素であるElement オブジェクトを使ってリソースデータを管理するリソースクラス。
本来階層構造を持たないデータをリソースオブジェクトで扱うことができるように するために用意された抽象クラスである。

バージョン:
$Revision: 1.1.1.1 $, $Date: 2010-10-16 00:03:49 $
作成者:
佐藤隆之.

フィールドの概要
 
インタフェース ts.util.resource.Resource から継承されたフィールド
EMPTY
 
コンストラクタの概要
DefaultResource()
          デフォルトコンストラクタ。
DefaultResource(DefaultResource res)
          コピーコンストラクタ。
 
メソッドの概要
protected abstract  DefaultResource createResource()
          このオブジェクトと同じクラスのリソースオブジェクトを作成する。
protected  java.util.List<Element> findAllElements(java.lang.String key)
          指定されたキーに該当する全ての要素を取得する。
protected  Element findFirstElement(java.lang.String key)
          指定されたキーに最初に該当する要素を取得する。
protected  Element findOrCreateFirstElement(java.util.List<java.lang.String> keyElemLst)
          キー要素リストに最初に該当する下位要素を探索して、存在すればそれを返し、 存在しなければ作成して返す。
protected  Element findOrCreateFirstElement(java.lang.String key)
          引数のキーに最初に該当する下位要素を探索して、存在すればそれを返し、 存在しなければ作成して返す。
 java.util.List<java.lang.String> getAttributes(java.lang.String key, java.lang.String attr)
          指定されたキーに該当する全要素の、指定された属性の値のリストを取得する。
protected  Element getBaseElement()
          基底要素を取得する。
 java.lang.String getBaseElementName()
          基底要素の名前を取得する。
 java.util.List<Resource> getChildren(java.lang.String key)
          指定されたキーに最初に該当する子リソースのリストを取得する。
 java.lang.String getFirstAttribute(java.lang.String key, java.lang.String attr)
          指定されたキーに最初に該当する要素の、指定された属性の値を取得する。
 Resource getFirstChild(java.lang.String key)
          指定されたキーに最初に該当する要素を基底要素とする子リソースを取得する。
 java.lang.String getFirstValue(java.lang.String key)
          指定されたキーに最初に該当する要素の値文字列を取得する。
 Resource getOrCreateFirstChild(java.lang.String key)
          指定されたキーに最初に該当する要素を基底要素とする子リソースを取得する。
protected  Element getRootElement()
          ルート要素を取得する。
 java.util.List<java.lang.String> getValues(java.lang.String key)
          指定されたキーに該当する全要素の値文字列のリストを取得する。
 void removeChildren(java.lang.String key)
          指定されたキーに該当する全ての要素を削除する。
protected  void renew()
          このオブジェクトを再初期化する。
 void setFirstValue(java.lang.String key, java.lang.String value)
          指定されたキーに最初に該当する要素に、値文字列を設定する。
 
クラス ts.util.resource.AbstractResource から継承されたメソッド
attributeMatchMark, attributeParenthesis, attributeSeparator, elementSeparator, getAttributeMatchMark, getAttributeParenthesis, getAttributeSeparator, getElementSeparator, getInputStream, getNameOfKeyElement, getOutputStream, getPath, listAttributesOfKeyElement, load, load, save, save, setAttributeMatchMark, setAttributeMatchMark, setAttributeParenthesis, setAttributeParenthesis, setAttributeSeparator, setAttributeSeparator, setElementSeparator, setElementSeparator, splitKey
 
クラス java.lang.Object から継承されたメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

コンストラクタの詳細

DefaultResource

public DefaultResource()
デフォルトコンストラクタ。


DefaultResource

public DefaultResource(DefaultResource res)
コピーコンストラクタ。

パラメータ:
res - コピー元のリソースオブジェクト。
例外:
java.lang.AssertionError - 引数がヌルの場合(デバッグモードのみ)。
メソッドの詳細

renew

protected void renew()
このオブジェクトを再初期化する。


getRootElement

protected Element getRootElement()
ルート要素を取得する。

戻り値:
ルート要素オブジェクト。

getBaseElement

protected Element getBaseElement()
基底要素を取得する。

戻り値:
基底要素オブジェクト。

getBaseElementName

public java.lang.String getBaseElementName()
基底要素の名前を取得する。

戻り値:
基底要素の名前。

createResource

protected abstract DefaultResource createResource()
このオブジェクトと同じクラスのリソースオブジェクトを作成する。

戻り値:
このオブジェクトと同じクラスのリソースオブジェクト。

findFirstElement

protected Element findFirstElement(java.lang.String key)
                            throws IllegalKeyException
指定されたキーに最初に該当する要素を取得する。
該当する要素が筆頭も存在しない場合はヌルを返す。 引数のキーが不正な場合は例外をスローする。

パラメータ:
key - キー。
戻り値:
引数のキーに最初に対応する要素。
例外:
IllegalKeyException - キーが不正な場合。
java.lang.AssertionError - 引数がヌルの場合(デバッグモードのみ)。

findAllElements

protected java.util.List<Element> findAllElements(java.lang.String key)
                                           throws IllegalKeyException
指定されたキーに該当する全ての要素を取得する。
該当する要素が一つも存在しない場合は空のリストを返す。 引数のキーが不正な場合は例外をスローする。

パラメータ:
key - キー。
戻り値:
引数のキーに対応する全ての要素を格納するリスト。
例外:
IllegalKeyException - キーが不正な場合。
java.lang.AssertionError - 引数がヌルの場合(デバッグモードのみ)。

findOrCreateFirstElement

protected Element findOrCreateFirstElement(java.lang.String key)
                                    throws IllegalKeyException
引数のキーに最初に該当する下位要素を探索して、存在すればそれを返し、 存在しなければ作成して返す。
引数のキーが不正な場合は、例外をスローする。

パラメータ:
key - キー文字列。
戻り値:
引数のキーに最初に対応する、又は作成された要素。
例外:
IllegalKeyException - キーが不正な場合。
java.lang.AssertionError - 引数がヌルの場合(デバッグモードのみ)。

findOrCreateFirstElement

protected Element findOrCreateFirstElement(java.util.List<java.lang.String> keyElemLst)
キー要素リストに最初に該当する下位要素を探索して、存在すればそれを返し、 存在しなければ作成して返す。

パラメータ:
keyElemLst - キー要素リスト。
戻り値:
引数のキーに最初に対応する、又は作成された要素。
例外:
java.lang.AssertionError - 引数がヌルの場合(デバッグモードのみ)。

getFirstValue

public java.lang.String getFirstValue(java.lang.String key)
                               throws IllegalKeyException
指定されたキーに最初に該当する要素の値文字列を取得する。
該当する要素が一つも存在しない場合は空文字列を返す。 引数のキーが不正な場合は例外をスローする。

パラメータ:
key - キー文字列。
戻り値:
引数のキーに最初に該当する要素の値文字列。
例外:
IllegalKeyException - キーが不正な場合。
java.lang.AssertionError - 引数がヌルの場合(デバッグモードのみ)。

getValues

public java.util.List<java.lang.String> getValues(java.lang.String key)
                                           throws IllegalKeyException
指定されたキーに該当する全要素の値文字列のリストを取得する。
該当する要素が一つも存在しない場合は空のリストを返す。 引数のキーが不正な場合は例外をスローする。

パラメータ:
key - キー文字列。
戻り値:
引数のキーに該当する全要素の値文字列のリスト。
例外:
IllegalKeyException - キーが不正な場合。
java.lang.AssertionError - 引数のヌルの場合(デバッグモードのみ)。

getFirstAttribute

public java.lang.String getFirstAttribute(java.lang.String key,
                                          java.lang.String attr)
                                   throws IllegalKeyException
指定されたキーに最初に該当する要素の、指定された属性の値を取得する。
該当する要素が存在しない場合は空文字列を返す。 該当する要素に、指定された名前の属性が存在しない場合は空文字列を返す。 引数のキーが不正な場合は例外をスローする。

パラメータ:
key - キー文字列。
attr - 属性名。
戻り値:
引数のキーに最初に該当する要素の、指定された属性の値。
例外:
IllegalKeyException - キーが不正な場合。
AssertError - 引数がヌルの場合。

getAttributes

public java.util.List<java.lang.String> getAttributes(java.lang.String key,
                                                      java.lang.String attr)
                                               throws IllegalKeyException
指定されたキーに該当する全要素の、指定された属性の値のリストを取得する。
該当する要素が一つも存在しない場合は空のリストを返す。 引数のキーが不正な場合は例外をスローする。

パラメータ:
key - キー文字列。
attr - 属性名。
戻り値:
引数のキーに該当する全要素の、指定された属性の値のリスト。
例外:
IllegalKeyException - キーが不正な場合。
AssertError - 引数がヌルの場合。

getFirstChild

public Resource getFirstChild(java.lang.String key)
                       throws IllegalKeyException
指定されたキーに最初に該当する要素を基底要素とする子リソースを取得する。
指定されたキーに該当する要素が存在しない場合は Resource.EMPTYを返す。 引数のキーが不正な場合は例外をスローする。

パラメータ:
key - キー文字列。
戻り値:
引数のキーに最初に該当する要素の子リソース。
例外:
IllegalKeyException - キーが不正な場合。
java.lang.AssertionError - 引数がヌルの場合(デバッグモードのみ)。

getChildren

public java.util.List<Resource> getChildren(java.lang.String key)
                                     throws IllegalKeyException
指定されたキーに最初に該当する子リソースのリストを取得する。
指定されたキーに該当する要素が存在しない場合は空のリストを返す。 引数のキーが不正な場合は例外をスローする。

パラメータ:
key - キー文字列。
戻り値:
引数のキーに該当する要素の子リソースのリスト。
例外:
IllegalKeyException - キーが不正な場合。
java.lang.AssertionError - 引数がヌルの場合(デバッグモードのみ)。

setFirstValue

public void setFirstValue(java.lang.String key,
                          java.lang.String value)
                   throws IllegalKeyException
指定されたキーに最初に該当する要素に、値文字列を設定する。
指定されたキーに該当する要素が存在しない場合は、その要素を作成して 値を設定する。

パラメータ:
key - キー文字列。
value - 引数のキーに最初に該当する要素に設定する値。
例外:
IllegalKeyException - キーが不正な場合。
java.lang.AssertionError - 引数がヌルの場合(デバッグモードのみ)。

getOrCreateFirstChild

public Resource getOrCreateFirstChild(java.lang.String key)
                               throws IllegalKeyException
指定されたキーに最初に該当する要素を基底要素とする子リソースを取得する。 指定されたキーに該当する要素が存在しない場合は作成して返す。
引数のキーが不正な場合は例外をスローする。

パラメータ:
key - キー文字列。
戻り値:
指定されたキーに最初に該当する要素を基底要素とする子リソース。
例外:
IllegalKeyException - キーが不正な場合。
java.lang.AssertionError - 引数がヌルの場合(デバッグモードのみ)。

removeChildren

public void removeChildren(java.lang.String key)
                    throws IllegalKeyException
指定されたキーに該当する全ての要素を削除する。
指定されたキーに該当する要素が見つからなかった場合は、何もしない。

パラメータ:
key - キー文字列。
例外:
IllegalKeyException - キーが不正な場合。
java.lang.AssertionError - 引数がヌルの場合(デバッグモードのみ)。


Copyright (C) SATOH Takayuki All Rights Reserved.