com.fiverworks.xone.model
クラス XoneObject

java.lang.Object
  拡張com.fiverworks.xone.model.XoneObject
すべての実装インタフェース:
Cloneable, Comparable
直系の既知のサブクラス:
XoneAnyInstance, XoneClass, XoneInstance

public abstract class XoneObject
extends Object
implements Cloneable, Comparable

Xoneのクラス(XoneClass)、インスタンス(XoneInstance)、Anyインスタンス(XoneAnyInstance)のスーパークラスです。


フィールドの概要
protected  String className
           
protected  com.fiverworks.xone.model.XoneMap elements
           
protected  String hint
           
protected  com.fiverworks.xone.model.XoneMap lists
           
protected  String name
           
protected  String path
           
protected static ResourceBundle rb
           
protected  String type
           
static String XONE_NULL
          nullを示す文字列
 
メソッドの概要
 void adaptClass(XoneClass xc)
          このオブジェクトに新たにクラスを適用します。
 void adaptClass(XoneClass xc, String name)
          このオブジェクトに新たにクラスを適用します。
 void addAllElementLists(XoneElementList[] lists)
          エレメントリストを追加します。
 void addAllElements(XoneElement[] elements)
          エレメントを追加します。
 XoneElement addElement(String name, String type)
          エレメントを追加します。
 XoneElement addElement(String name, String type, String value)
          エレメントを追加します。
 XoneElement addElement(String name, String type, String[] values)
          エレメントを追加します。
 XoneElement addElement(XoneElement element)
          エレメントを追加します。
 XoneElementList addElementList(String listName)
          エレメントリストを追加します。
 XoneElementList addElementList(XoneElementList list)
          エレメントリストを追加します。
 Object clone()
          オブジェクトのコピーを返します。
 int compareTo(Object o)
          指定されたオブジェクトと比較します。
 boolean containsElement(String name)
          エレメントが含まれているかどうかを返します。
 boolean containsElement(XoneElement element)
          エレメントが含まれているかどうかを返します。
 boolean containsElementList(String listName)
          エレメントリストが含まれているかどうかを返します。
 boolean containsElementList(XoneElementList list)
          エレメントリストが含まれているかどうかを返します。
 Iterator elementIterator()
          エレメントのイテレータを取得します。
 Iterator elementListIterator()
          エレメントリストのイテレータを取得します。
 Iterator elementListNameIterator()
          エレメントリストの名前のイテレータを取得します。
 int elementListSize()
          エレメントリストの数を取得します。
 Iterator elementNameIterator()
          エレメントの名前のイテレータを取得します。
 int elementSize()
          エレメントの数を取得します。
 XoneElementList[] getAllElementLists()
          すべてのエレメントリストを取得します。
 XoneElement[] getAllElements()
          すべてのエレメントを取得します。
 String getClassName()
          オブジェクトのクラス名を取得します。
 XoneElement getElement(String name)
          エレメントを取得します。
 XoneElementList getElementList(String listName)
          エレメントリストを取得します。
 String getElementType(String name)
          エレメントの型を取得します。
 String getElementValue(String name)
          エレメントの値を取得します。
 Object getElementValueAsType(String name)
          エレメントの値をその型に対応するObjectで取得します。
 String getHint()
          hintを取得します。
 String getName()
          オブジェクト名を取得します。
 String getParent()
          オブジェクトの親フォルダ名を返します。
 String getPath()
          オブジェクトのパスを返します。
 String getRestriction(String name)
          エレメントの制約式を取得します。
 String getRestrictionMessage(String name)
          エレメントの制約式のメッセージを取得します。
 String getSerializedElements()
          エレメントおよびエレメントリストのシリアライズされた表現を返します(システムの内部で使用)。
 String getType()
          オブジェクトのタイプを返します。
 boolean isAnyInstance()
          オブジェクトがAnyインスタンスかどうか調べます。
 boolean isClass()
          オブジェクトがクラスかどうか調べます。
 boolean isInstance()
          オブジェクトがインスタンスかどうか調べます。
 boolean isValid()
          評価して正しいかどうか返します。
 boolean isValidationEnabled()
          評価が可能かどうか返します。
 void removeAllElementLists()
          すべてのエレメントリストを削除します。
 void removeAllElements()
          すべてのエレメントを削除します。
 XoneElement removeElement(String name)
          エレメントを削除します。
 XoneElement removeElement(XoneElement element)
          エレメントを削除します。
 XoneElementList removeElementList(String listName)
          エレメントリストを削除します。
 XoneElementList removeElementList(XoneElementList list)
          エレメントリストを削除します。
 void setClassName(String className)
          クラス名をセットします。
 void setElementValue(String name, String value)
          エレメントの値をセットします。
 void setElementValue(String name, String[] values)
          エレメントの値をセットします。
 void setHint(String hint)
          hintを設定します。
 void setName(String name)
          オブジェクト名をセットします。
 String toString()
          オブジェクトの文字列表現を返します。
 ValidateResult[] validate()
          評価した結果を返します。
 
クラス java.lang.Object から継承したメソッド
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

フィールドの詳細

rb

protected static final ResourceBundle rb

elements

protected com.fiverworks.xone.model.XoneMap elements

lists

protected com.fiverworks.xone.model.XoneMap lists

type

protected String type

className

protected String className

name

protected String name

path

protected String path

hint

protected String hint

XONE_NULL

public static final String XONE_NULL
nullを示す文字列

関連項目:
定数フィールド値
メソッドの詳細

addElement

public XoneElement addElement(String name,
                              String type)
エレメントを追加します。このメソッドはAnyインスタンスのみ有効で、それ以外のオブジェクトだと例外が発生します。

パラメータ:
name - エレメント名
type - エレメントの型
戻り値:
追加したエレメント
例外:
XoneRuntimeException

addElement

public XoneElement addElement(String name,
                              String type,
                              String value)
エレメントを追加します。このメソッドはAnyインスタンスのみ有効で、それ以外のオブジェクトだと例外が発生します。

パラメータ:
value - エレメントの値
name - エレメント名
type - エレメントの型
戻り値:
追加したエレメント
例外:
XoneRuntimeException

addElement

public XoneElement addElement(String name,
                              String type,
                              String[] values)
エレメントを追加します。このメソッドはAnyインスタンスのみ有効で、それ以外のオブジェクトだと例外が発生します。

パラメータ:
values - エレメントの値
name - エレメント名
type - エレメントの型
戻り値:
追加したエレメント
例外:
XoneRuntimeException

addElement

public XoneElement addElement(XoneElement element)
エレメントを追加します。このメソッドはAnyインスタンスのみ有効で、それ以外のオブジェクトだと例外が発生します。

パラメータ:
element - 追加するエレメント
戻り値:
追加したエレメント
例外:
XoneRuntimeException

addAllElements

public void addAllElements(XoneElement[] elements)
エレメントを追加します。このメソッドはAnyインスタンスのみ有効で、それ以外のオブジェクトだと例外が発生します。

パラメータ:
elements - 追加するエレメント
例外:
XoneRuntimeException

removeElement

public XoneElement removeElement(String name)
エレメントを削除します。Anyインスタンスのみ有効で、それ以外のオブジェクトだと例外が発生します。

パラメータ:
name - 削除するエレメント名
戻り値:
削除したエレメント
例外:
XoneRuntimeException

removeElement

public XoneElement removeElement(XoneElement element)
エレメントを削除します。このメソッドはAnyインスタンスのみ有効で、それ以外のオブジェクトだと例外が発生します。

パラメータ:
element - 削除するエレメント
戻り値:
削除したエレメント
例外:
XoneRuntimeException

removeAllElements

public void removeAllElements()
すべてのエレメントを削除します。このメソッドはAnyインスタンスのみ有効で、それ以外のオブジェクトだと例外が発生します。

例外:
XoneRuntimeException

getElement

public XoneElement getElement(String name)
エレメントを取得します。

パラメータ:
name - 取得するエレメント名
戻り値:
取得したエレメント(エレメントが存在しなければnull)

getElementType

public String getElementType(String name)
エレメントの型を取得します。

パラメータ:
name - 取得するエレメント名
戻り値:
取得した型(エレメントが存在しなければnull)

getElementValue

public String getElementValue(String name)
エレメントの値を取得します。

パラメータ:
name - 取得するエレメント名
戻り値:
取得した値(エレメントが存在しない場合や値がnullのときはnull)

getElementValueAsType

public Object getElementValueAsType(String name)
エレメントの値をその型に対応するObjectで取得します。
エレメントの型がプリミティブ型の場合は、取得した値をキャストして利用できます。
ただし、Javaのプリミティブ型の配列型は、そのラッパークラスの配列になります。
  例:エレメントabcの型がXoneModel.INT_ARRAYの場合
  Integer[] ia = (Integer[])xo.getElementValueAsType("abc");
 
エレメントの型がプリミティブ型でない場合は、String型になります。

パラメータ:
name - 取得するエレメント名
戻り値:
取得した値(エレメントが存在しない場合や値がnullのときはnull)

setElementValue

public void setElementValue(String name,
                            String value)
エレメントの値をセットします。

パラメータ:
name - 取得するエレメント名
value - エレメントの値
例外:
XoneRuntimeException - nameのエレメントが存在しない場合、あるいはvalueが不正な場合

setElementValue

public void setElementValue(String name,
                            String[] values)
エレメントの値をセットします。

パラメータ:
values - エレメントの値
name - 取得するエレメント名
例外:
XoneRuntimeException - nameのエレメントが存在しない場合、あるいはvaluesが不正な場合

getAllElements

public XoneElement[] getAllElements()
すべてのエレメントを取得します。

戻り値:
取得したエレメントの配列(エレメントが1つもないときは要素数が0の配列)

containsElement

public boolean containsElement(String name)
エレメントが含まれているかどうかを返します。

パラメータ:
name - エレメント名
戻り値:
含まれていればtrue

containsElement

public boolean containsElement(XoneElement element)
エレメントが含まれているかどうかを返します。

パラメータ:
element - エレメント
戻り値:
含まれていればtrue

elementNameIterator

public Iterator elementNameIterator()
エレメントの名前のイテレータを取得します。

戻り値:
取得したイテレータ

elementIterator

public Iterator elementIterator()
エレメントのイテレータを取得します。

戻り値:
取得したイテレータ

elementSize

public int elementSize()
エレメントの数を取得します。

戻り値:
取得したエレメントの数

addElementList

public XoneElementList addElementList(String listName)
エレメントリストを追加します。このメソッドはAnyインスタンスのみ有効で、それ以外のオブジェクトだと例外が発生します。

パラメータ:
listName - エレメントリスト名
戻り値:
追加したエレメントリスト
例外:
XoneRuntimeException

addElementList

public XoneElementList addElementList(XoneElementList list)
エレメントリストを追加します。このメソッドはAnyインスタンスのみ有効で、それ以外のオブジェクトだと例外が発生します。

パラメータ:
list - エレメントリスト
戻り値:
追加したエレメントリスト
例外:
XoneRuntimeException

addAllElementLists

public void addAllElementLists(XoneElementList[] lists)
エレメントリストを追加します。このメソッドはAnyインスタンスのみ有効で、それ以外のオブジェクトだと例外が発生します。

パラメータ:
lists - エレメントリスト
例外:
XoneRuntimeException

removeElementList

public XoneElementList removeElementList(String listName)
エレメントリストを削除します。このメソッドはAnyインスタンスのみ有効で、それ以外のオブジェクトだと例外が発生します。

パラメータ:
listName - エレメントリスト名
戻り値:
削除したエレメントリスト
例外:
XoneRuntimeException

removeElementList

public XoneElementList removeElementList(XoneElementList list)
エレメントリストを削除します。このメソッドはAnyインスタンスのみ有効で、それ以外のオブジェクトだと例外が発生します。

パラメータ:
list - エレメントリスト
戻り値:
削除したエレメントリスト
例外:
XoneRuntimeException

removeAllElementLists

public void removeAllElementLists()
すべてのエレメントリストを削除します。このメソッドはAnyインスタンスのみ有効で、それ以外のオブジェクトだと例外が発生します。

例外:
XoneRuntimeException

getElementList

public XoneElementList getElementList(String listName)
エレメントリストを取得します。

パラメータ:
listName - エレメントリスト名
戻り値:
取得したエレメントリスト(エレメントリストが存在しなければnull)

containsElementList

public boolean containsElementList(String listName)
エレメントリストが含まれているかどうかを返します。

パラメータ:
listName - エレメントリスト名
戻り値:
含まれていればtrue

containsElementList

public boolean containsElementList(XoneElementList list)
エレメントリストが含まれているかどうかを返します。

パラメータ:
list - エレメントリスト
戻り値:
含まれていればtrue

getAllElementLists

public XoneElementList[] getAllElementLists()
すべてのエレメントリストを取得します。

戻り値:
取得したエレメントリストの配列(エレメントリストが1つもないときは要素数が0の配列)

elementListNameIterator

public Iterator elementListNameIterator()
エレメントリストの名前のイテレータを取得します。

戻り値:
取得したイテレータ

elementListIterator

public Iterator elementListIterator()
エレメントリストのイテレータを取得します。

戻り値:
取得したイテレータ

elementListSize

public int elementListSize()
エレメントリストの数を取得します。

戻り値:
取得したエレメントの数

isValidationEnabled

public boolean isValidationEnabled()
評価が可能かどうか返します。このメソッドはインスタンス以外のオブジェクトだとfalseを返します。

戻り値:
評価可能な場合はtrue

validate

public ValidateResult[] validate()
評価した結果を返します。このメソッドはインスタンスのみ有効で、それ以外のオブジェクトだと例外が発生します。

戻り値:
評価した結果
例外:
XoneRuntimeException

isValid

public boolean isValid()
評価して正しいかどうか返します。このメソッドはインスタンスのみ有効で、それ以外のオブジェクトだと例外が発生します。

戻り値:
正しければtrue
例外:
XoneRuntimeException

getRestriction

public String getRestriction(String name)
エレメントの制約式を取得します。このメソッドはインスタンスとクラスで有効で、Anyインスタンスではnullを返します。

パラメータ:
name - 取得するエレメント名
戻り値:
取得した制約式

getRestrictionMessage

public String getRestrictionMessage(String name)
エレメントの制約式のメッセージを取得します。このメソッドはインスタンスとクラスで有効で、Anyインスタンスではnullを返します。

パラメータ:
name - 取得するエレメント名
戻り値:
取得した制約式のメッセージ

getType

public String getType()
オブジェクトのタイプを返します。XoneModelで定義されているINSTANCE,CLASS,ANY_INSTANCEのいずれかを返します。

戻り値:
取得したタイプ

isInstance

public boolean isInstance()
オブジェクトがインスタンスかどうか調べます。

戻り値:
インスタンスの時はtrue

isAnyInstance

public boolean isAnyInstance()
オブジェクトがAnyインスタンスかどうか調べます。

戻り値:
Anyインスタンスの時はtrue

isClass

public boolean isClass()
オブジェクトがクラスかどうか調べます。

戻り値:
クラスの時はtrue

getClassName

public String getClassName()
オブジェクトのクラス名を取得します。

戻り値:
取得したクラス名

setClassName

public void setClassName(String className)
クラス名をセットします。このメソッドはAnyインスタンスのみ有効で、それ以外のオブジェクトだと例外が発生します。

パラメータ:
className - クラス名
例外:
XoneRuntimeException

getName

public String getName()
オブジェクト名を取得します。

戻り値:
取得したオブジェクト名

setName

public void setName(String name)
オブジェクト名をセットします。このメソッドはAnyインスタンスのみ有効で、それ以外のオブジェクトだと例外が発生します。

パラメータ:
name - セットする名前
例外:
XoneRuntimeException

toString

public String toString()
オブジェクトの文字列表現を返します。

戻り値:
オブジェクトの文字列表現

getSerializedElements

public String getSerializedElements()
エレメントおよびエレメントリストのシリアライズされた表現を返します(システムの内部で使用)。

戻り値:
オブジェクトの文字列表現

getPath

public String getPath()
オブジェクトのパスを返します。

戻り値:
オブジェクトのパス

getParent

public String getParent()
オブジェクトの親フォルダ名を返します。

戻り値:
オブジェクトの親フォルダ名(ないときはnull)

clone

public Object clone()
オブジェクトのコピーを返します。
インスタンスの場合はクラスが必要なので、Cacheからクラスを探し、見つからなければ例外を投げます。

戻り値:
コピーしたオブジェクト
例外:
XoneRuntimeException - このオブジェクトがインスタンスで、クラスが見つからない場合

adaptClass

public void adaptClass(XoneClass xc)
このオブジェクトに新たにクラスを適用します。インスタンスのみ有効で、それ以外のオブジェクトだと例外が発生します。

パラメータ:
xc - 適用するクラス
例外:
XoneRuntimeException

adaptClass

public void adaptClass(XoneClass xc,
                       String name)
このオブジェクトに新たにクラスを適用します。インスタンスのみ有効で、それ以外のオブジェクトだと例外が発生します。

パラメータ:
name - 新しいインスタンスの名前
xc - 適用するクラス
例外:
XoneRuntimeException - このオブジェクトがインスタンスで、クラスが見つからない場合

getHint

public String getHint()
hintを取得します。

戻り値:
hintの値。

setHint

public void setHint(String hint)
hintを設定します。

パラメータ:
hint - hintの新しい値。

compareTo

public int compareTo(Object o)
指定されたオブジェクトと比較します。

定義:
インタフェース Comparable 内の compareTo
パラメータ:
o - 比較するオブジェクト
戻り値:
パラメータの名前がこの名前に等しい場合は0。パラメータの名前がこの名前より辞書順で小さければ0より小さい値。パラメータの名前がこの名前より辞書順で大きい場合は0より大きい値