EdbObject (EDB/Java API Specification)

java.lang.Object
- jp.ac.tokushima_u.edb.EdbObject

All Implemented Interfaces:

EdbCensorSpi, EdbEIDHolder, EdbXMLSpi

Direct Known Subclasses:

EdbPhantom, EdbTable, EdbTuple
```
public class EdbObject
extends Object
implements EdbXMLSpi, EdbEIDHolder, EdbCensorSpi
```
テーブル，タプルなどの EDB オブジェクトの基本的な機能を実装したクラスです．

Field Summary

Fields
Modifier and Type Field and Description

(package private) int age

(package private) EdbBase base

protected EDB edb

protected boolean fixed

Fields
Modifier and Type	Field and Description
`(package private) int`	`age`
`(package private) EdbBase`	`base`
`protected EDB`	`edb`
`protected boolean`	`fixed`

Constructor Summary

Constructors
Constructor and Description

EdbObject(EDB ec)

EdbObject(EDB ec, Element root)

EdbObject(EDB ec, int eid)

Constructors
Constructor and Description
`EdbObject(EDB ec)`
`EdbObject(EDB ec, Element root)`
`EdbObject(EDB ec, int eid)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`atPresent()` 基準日において，このオブジェクトが有効どうかを判別します．
`EdbCensor`	`censor()` 承認状態を得る．
`void`	`checkChangable()` このオブジェクトの内容を変更可能かどうかをチェックします．
`protected EdbPhantom`	`createPhantom()` このオブジェクトの Phantom を作成します．
`(package private) static EdbTuple`	`createTuple(EDB ec, EdbTable table)`
`(package private) EdbObject`	`duplicate(EDB ec)`
`EdbEID`	`eid()` EIDを取得する．
`boolean`	`equals(EdbObject obj)` このオブジェクトの表すデータと等しいかどうかを判定します．
`boolean`	`equalsXN(String xn)` このオブジェクトの XML 名と同じかどうか判定します．
`boolean`	`equivalents(EdbObject obj)` 更新時の履歴情報を除き，このオブジェクトの表すデータと等しいかどうかを判定します．
`int`	`getAge()` このオブジェクトが表すデータのデータベースの年齢を取得します．
`boolean`	`getAvailable()` ベース情報の有効・無効を取得します．
`EdbDate2`	`getAvailablePeriod()` 期間限定されている期間を得る．
`EdbDate2`	`getAvailablePeriod(EdbDate2 period)` 期間限定されている期間と指定された期間のオーバラップしている期間を得る．
`EdbBase`	`getBase()` ベース情報を取得します．
`EdbCaption`	`getCaption()` 見出しを取得します．
`EdbCaption`	`getCaption(EdbPhantomListener lis)` 見出しを取得します．
`EdbCaption`	`getCaption(int mode)` 見出しを取得します．
`EdbCaption`	`getCaption(int mode, EdbPhantomListener lis)` 見出しを取得します．
`(package private) EdbCaption`	`getCaption(int mode, EdbPhantomListener lis, int recurse)`
`EdbDate`	`getDateFrom()` ベース情報の有効期間（始まり）を取得します．
`EdbDate`	`getDateTo()` ベース情報の有効期間（終わり）を取得します．
`EDB`	`getEDB()` EDB コンテキストを取得します．
`(package private) int`	`getEID()` ベース情報の EID を取得します．
`int`	`getEOID()` ベース情報の EOID を取得します．
`MLText`	`getMLName()` 見出しを作成します．
`MLText`	`getMLName(EdbPhantomListener listener)` 見出しを作成します．
`MLText`	`getMLName(int mode)` 見出しを作成します．
`MLText`	`getMLName(int mode, EdbPhantomListener listener)` 見出しを作成します．
`int`	`getMTime()` ベース情報の登録時刻(UNIX time)を取得します．
`String`	`getXN()` このオブジェクトの XML 名を取得します．
`int`	`hashCode()` このオブジェクトのハッシュコードを取得します．
`boolean`	`inPeriod(EdbDate d)` 指定された日付において，このオブジェクトが有効どうかを判別します．
`boolean`	`inPeriod(int d)` 指定された日付において，このオブジェクトが有効どうかを判別します．
`boolean`	`isFixed()` このオブジェクトの内容が固定されているかどうかを判定します．
`boolean`	`isPhantom()` このオブジェクトがファントムかどうかを返します．
`boolean`	`isTable()` このオブジェクトがテーブルかどうかを返します．
`boolean`	`isTuple()` このオブジェクトがタプルかどうかを返します．
`String`	`makeCaption()` 見出しを作成します．
`String`	`makeCaption(EdbPhantomListener listener)` 見出しを作成します．
`String`	`makeCaption(int mode)` 見出しを作成します．
`String`	`makeCaption(int mode, EdbPhantomListener listener)` 見出しを作成します．
`StringBuilder`	`makeCompletedXML()` オブジェクトが表すデータの完全な XML 文字列を作成します．
`StringBuilder`	`makeXML()` オブジェクトが表すデータの XML 文字列を作成します．
`StringBuilder`	`makeXML(int mode)` オブジェクトが表すデータの XML 文字列を作成します．
`EdbEID`	`mapto()` ベース情報のマップ先の情報の EID を取得します．
`boolean`	`maptoIsValid()` ベース情報のマップ先の情報の EID が予約領域より上の値かどうかを判定します．
`EdbEID`	`operator()` ベース情報の登録者の EID を取得します．
`boolean`	`overlapPeriod(EdbDate2 p)` 指定された期間において，このオブジェクトが有効な期間を含むかどうかを判別します．
`boolean`	`overlapPeriod(int f, int t)` 指定された期間において，このオブジェクトが有効な期間を含むかどうかを判別します．
`EdbEID`	`owner()` ベース情報の所有者の EID を取得します．
`(package private) static EdbCatalogue`	`parseDatabase(EDB ec, Element root)`
`(package private) static EdbCatalogue`	`parseDefinition(EDB ec, Element root)`
`(package private) static EdbObject`	`parseXMLObject(EDB ec, Element elem)`
`(package private) static void`	`tableSpiAdd(String xn, Class<? extends EdbTableSpi> c)`
`(package private) static void`	`tupleSpiAdd(String xn, Class<? extends EdbTupleSpi> c)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface jp.ac.tokushima_u.edb.EdbEIDHolder
createFormedUTLFId, createLogisticsId, eidIsValid

Methods inherited from interface jp.ac.tokushima_u.edb.EdbCensorSpi
isConfirmed, isRejected, isUnconfirmed

- Field Detail
  - fixed
```
protected boolean fixed
```
  - edb
```
protected EDB edb
```
  - base
```
EdbBase base
```
  - age
```
int age
```
- Constructor Detail
  - EdbObject
```
EdbObject(EDB ec,
          int eid)
```
  - EdbObject
```
EdbObject(EDB ec)
```
  - EdbObject
```
EdbObject(EDB ec,
          Element root)
```
- Method Detail
  - isFixed
```
public final boolean isFixed()
```
    このオブジェクトの内容が固定されているかどうかを判定します．
    このメソッドは，このオブジェクトがキャッシュされている情報の場合に true を返し，キャッシュに入っているオブジェクトそのものを変更されてしまうのを防ぐために使用されます．
    
    Returns:
    
    固定されている場合は true，その他 false を返します．
  - checkChangable
```
public final void checkChangable()
```
    このオブジェクトの内容を変更可能かどうかをチェックします．
    ここではオブジェクトの内容が固定されているかどうかを調べ，固定されている場合に例外をスローします．
    
    Specified by:
    
    checkChangable in interface EdbXMLSpi
    
    Throws:
    
    EdbFixedObjectException - 固定状態にあるオブジェクトを改変しようとした．
    
    See Also:
    
    isFixed()
  - getAge
```
public final int getAge()
```
    このオブジェクトが表すデータのデータベースの年齢を取得します．
    
    Returns:
    
    データベースの年齢を返します．
  - tableSpiAdd
```
static void tableSpiAdd(String xn,
                        Class<? extends EdbTableSpi> c)
```
  - tupleSpiAdd
```
static void tupleSpiAdd(String xn,
                        Class<? extends EdbTupleSpi> c)
```
  - duplicate
```
EdbObject duplicate(EDB ec)
```
  - parseXMLObject
```
static EdbObject parseXMLObject(EDB ec,
                                Element elem)
```
  - createTuple
```
static EdbTuple createTuple(EDB ec,
                            EdbTable table)
```
  - parseDefinition
```
static EdbCatalogue parseDefinition(EDB ec,
                                    Element root)
```
  - parseDatabase
```
static EdbCatalogue parseDatabase(EDB ec,
                                  Element root)
```
  - createPhantom
```
protected final EdbPhantom createPhantom()
```
    このオブジェクトの Phantom を作成します．
    
    Returns:
    
    EdbPhantom オブジェクトを返します．
  - getEDB
```
public final EDB getEDB()
```
    EDB コンテキストを取得します．
    
    Returns:
    
    EDB オブジェクトを返します．
  - isTable
```
public boolean isTable()
```
    このオブジェクトがテーブルかどうかを返します．
    
    Returns:
    
    テーブルの場合は true，その他 false を返します．
  - isTuple
```
public boolean isTuple()
```
    このオブジェクトがタプルかどうかを返します．
    
    Returns:
    
    タプルの場合は true，その他 false を返します．
  - isPhantom
```
public boolean isPhantom()
```
    このオブジェクトがファントムかどうかを返します．
    
    Returns:
    
    ファントムの場合は true，その他 false を返します．
  - getBase
```
public final EdbBase getBase()
```
    ベース情報を取得します．
    
    Returns:
    
    EdbBase オブジェクトを返します．
  - getEID
```
final int getEID()
```
    ベース情報の EID を取得します．
    
    Returns:
    
    EID を返します．
  - eid
```
public final EdbEID eid()
```
    EIDを取得する．
    返り値は常に非nullである．無効なEIDに対しては，EdbEID.NULLを返す．
    
    Specified by:
    
    eid in interface EdbEIDHolder
    
    Returns:
    
    EID.
  - getEOID
```
public final int getEOID()
```
    ベース情報の EOID を取得します．
    
    Returns:
    
    EOID を返します．
  - mapto
```
public final EdbEID mapto()
```
    ベース情報のマップ先の情報の EID を取得します．
    
    Returns:
    
    マップ先の情報の EID を返します．
    
    See Also:
    
    EdbBase.mapto()
  - maptoIsValid
```
public final boolean maptoIsValid()
```
    ベース情報のマップ先の情報の EID が予約領域より上の値かどうかを判定します．
    
    Returns:
    
    マップ先の情報の EID が予約領域より上の値の場合は true を，その他 false を返します．
  - getMTime
```
public final int getMTime()
```
    ベース情報の登録時刻(UNIX time)を取得します．
    
    Returns:
    
    登録時刻(UNIX time)を返します．
  - operator
```
public final EdbEID operator()
```
    ベース情報の登録者の EID を取得します．
    
    Returns:
    
    登録者の EID を返します．
    
    See Also:
    
    EdbBase.operator()
  - getAvailable
```
public final boolean getAvailable()
```
    ベース情報の有効・無効を取得します．
    
    Returns:
    
    有効な場合は true，無効な場合は false を返します．
  - censor
```
public final EdbCensor censor()
```
    承認状態を得る．
    
    Specified by:
    
    censor in interface EdbCensorSpi
    
    Returns:
    
    承認状態
  - getDateFrom
```
public final EdbDate getDateFrom()
```
    ベース情報の有効期間（始まり）を取得します．
    有効期間は，期間限定が指定された場合にオブジェクトが表すデータの有効期間となります．期間限定が指定されていない場合は無視されます．
    
    Returns:
    
    有効期間（始まり）を返します．
  - getDateTo
```
public final EdbDate getDateTo()
```
    ベース情報の有効期間（終わり）を取得します．
    有効期間は，期間限定が指定された場合にオブジェクトが表すデータの有効期間となります．期間限定が指定されていない場合は無視されます．
    
    Returns:
    
    有効期間（終わり）を返します．
  - owner
```
public final EdbEID owner()
```
    ベース情報の所有者の EID を取得します．
    
    Returns:
    
    所有者の EID を返します．
    
    See Also:
    
    EdbBase.owner()
  - getXN
```
public String getXN()
```
    このオブジェクトの XML 名を取得します．
    
    Specified by:
    
    getXN in interface EdbXMLSpi
    
    Returns:
    
    XML 名を返します．
  - equalsXN
```
public final boolean equalsXN(String xn)
```
    このオブジェクトの XML 名と同じかどうか判定します．
    
    Specified by:
    
    equalsXN in interface EdbXMLSpi
    
    Parameters:
    
    xn - 比較するXML 名
    
    Returns:
    
    同じ場合は true，その他 false を返します．
  - makeXML
```
public StringBuilder makeXML()
```
    オブジェクトが表すデータの XML 文字列を作成します．
    
    Specified by:
    
    makeXML in interface EdbXMLSpi
    
    Returns:
    
    作成された XML 文字列を返します．
  - makeCompletedXML
```
public StringBuilder makeCompletedXML()
```
    オブジェクトが表すデータの完全な XML 文字列を作成します．
    
    Specified by:
    
    makeCompletedXML in interface EdbXMLSpi
    
    Returns:
    
    作成された XML 文字列を返します．
  - makeXML
```
public StringBuilder makeXML(int mode)
```
    オブジェクトが表すデータの XML 文字列を作成します．
    
    Specified by:
    
    makeXML in interface EdbXMLSpi
    
    Parameters:
    
    mode - XMLの作成モード，0 又は XML の作成モードの定数の値
    
    Returns:
    
    作成された XML 文字列を返します．
    
    See Also:
    
    EdbXML.MODE_MULTILINE, EdbXML.MODE_COMPLETION, EdbXML.MODE_NOT_ROOT
  - makeCaption
```
public final String makeCaption()
```
    見出しを作成します．
    
    Returns:
    
    見出しを返します．
  - makeCaption
```
public String makeCaption(int mode,
                          EdbPhantomListener listener)
```
    見出しを作成します．
    
    Parameters:
    
    mode - 見出しを作成するときのモード．0 又は見出しを作成するときのモードの定数の値の組み合わせ
    
    listener - リスナ
    
    Returns:
    
    見出しを返します．
    
    See Also:
    
    EdbCaption.CAP_long, EdbCaption.CAP_norecurse, EdbCaption.CAP_nomapto, EdbCaption.CAP_nobracket, EdbCaption.CAP_noreverse, EdbCaption.CAP_delimiter_comma, EdbCaption.CAP_delimiter_newline
  - makeCaption
```
public final String makeCaption(int mode)
```
    見出しを作成します．
    
    Parameters:
    
    mode - 見出しを作成するときのモード．0 又は見出しを作成するときのモードの定数の値の組み合わせ
    
    Returns:
    
    見出しを返します．
    
    See Also:
    
    EdbCaption.CAP_long, EdbCaption.CAP_norecurse, EdbCaption.CAP_nomapto, EdbCaption.CAP_nobracket, EdbCaption.CAP_noreverse, EdbCaption.CAP_delimiter_comma, EdbCaption.CAP_delimiter_newline
  - makeCaption
```
public final String makeCaption(EdbPhantomListener listener)
```
    見出しを作成します．
    
    Parameters:
    
    listener - リスナ
    
    Returns:
    
    見出しを返します．
  - getMLName
```
public final MLText getMLName()
```
    見出しを作成します．
    
    Returns:
    
    見出しを返します．
  - getMLName
```
public MLText getMLName(int mode,
                        EdbPhantomListener listener)
```
    見出しを作成します．
    
    Parameters:
    
    mode - 見出しを作成するときのモード．0 又は見出しを作成するときのモードの定数の値の組み合わせ
    
    listener - リスナ
    
    Returns:
    
    見出しを返します．
    
    See Also:
    
    EdbCaption.CAP_long, EdbCaption.CAP_norecurse, EdbCaption.CAP_nomapto, EdbCaption.CAP_nobracket, EdbCaption.CAP_noreverse, EdbCaption.CAP_delimiter_comma, EdbCaption.CAP_delimiter_newline
  - getMLName
```
public final MLText getMLName(int mode)
```
    見出しを作成します．
    
    Parameters:
    
    mode - 見出しを作成するときのモード．0 又は見出しを作成するときのモードの定数の値の組み合わせ
    
    Returns:
    
    見出しを返します．
    
    See Also:
    
    EdbCaption.CAP_long, EdbCaption.CAP_norecurse, EdbCaption.CAP_nomapto, EdbCaption.CAP_nobracket, EdbCaption.CAP_noreverse, EdbCaption.CAP_delimiter_comma, EdbCaption.CAP_delimiter_newline
  - getMLName
```
public final MLText getMLName(EdbPhantomListener listener)
```
    見出しを作成します．
    
    Parameters:
    
    listener - リスナ
    
    Returns:
    
    見出しを返します．
  - getCaption
```
EdbCaption getCaption(int mode,
                      EdbPhantomListener lis,
                      int recurse)
```
  - getCaption
```
public EdbCaption getCaption(int mode,
                             EdbPhantomListener lis)
```
    見出しを取得します．
    
    Parameters:
    
    mode - 見出しを作成するときのモード．0 又は見出しを作成するときのモードの定数の値の組み合わせ
    
    lis - リスナ
    
    Returns:
    
    見出しを返します．
    
    See Also:
    
    EdbCaption.CAP_long, EdbCaption.CAP_norecurse, EdbCaption.CAP_nomapto, EdbCaption.CAP_nobracket, EdbCaption.CAP_noreverse, EdbCaption.CAP_delimiter_comma, EdbCaption.CAP_delimiter_newline
  - getCaption
```
public EdbCaption getCaption(EdbPhantomListener lis)
```
    見出しを取得します．
    
    Parameters:
    
    lis - リスナ
    
    Returns:
    
    見出しを返します．
  - getCaption
```
public EdbCaption getCaption(int mode)
```
    見出しを取得します．
    
    Parameters:
    
    mode - 見出しを作成するときのモード．0 又は見出しを作成するときのモードの定数の値の組み合わせ
    
    Returns:
    
    見出しを返します．
    
    See Also:
    
    EdbCaption.CAP_long, EdbCaption.CAP_norecurse, EdbCaption.CAP_nomapto, EdbCaption.CAP_nobracket, EdbCaption.CAP_noreverse, EdbCaption.CAP_delimiter_comma, EdbCaption.CAP_delimiter_newline
  - getCaption
```
public EdbCaption getCaption()
```
    見出しを取得します．
    
    Returns:
    
    見出しを返します．
  - equals
```
public boolean equals(EdbObject obj)
```
    このオブジェクトの表すデータと等しいかどうかを判定します．
    このメソッドは，完全に同じXML表現になるときに true を返します．
    
    Parameters:
    
    obj - EDB オブジェクト
    
    Returns:
    
    等しい場合は true，その他 false を返します．
  - hashCode
```
public final int hashCode()
```
    このオブジェクトのハッシュコードを取得します．
    ここでは，ベース情報の EID をハッシュコードとして利用します．
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    ハッシュコードを返します．
  - equivalents
```
public boolean equivalents(EdbObject obj)
```
    更新時の履歴情報を除き，このオブジェクトの表すデータと等しいかどうかを判定します．
    このメソッドは，EOID ，最終修正年月日，操作者が異なっている場合にも，その他が同じであれば true を返します．これはデータベースの登録で，情報の実質的な修正を意味しないときを表します．
    
    Parameters:
    
    obj - EDB オブジェクト
    
    Returns:
    
    等しい場合は true，その他 false を返します．
  - inPeriod
```
public boolean inPeriod(int d)
```
    指定された日付において，このオブジェクトが有効どうかを判別します．
    指定された日付が，このオブジェクトの有効期間内にあるかどうかを判定します．
    
    Parameters:
    
    d - 日付
    
    Returns:
    
    内にある場合は true，その他 false を返します．
    
    See Also:
    
    getDateFrom(), getDateTo()
  - inPeriod
```
public boolean inPeriod(EdbDate d)
```
    指定された日付において，このオブジェクトが有効どうかを判別します．
    指定された日付が，このオブジェクトの有効期間内にあるかどうかを判定します．
    
    Parameters:
    
    d - 日付
    
    Returns:
    
    内にある場合は true，その他 false を返します．
    
    See Also:
    
    getDateFrom(), getDateTo()
  - atPresent
```
public boolean atPresent()
```
    基準日において，このオブジェクトが有効どうかを判別します．
    基準日が，このオブジェクトの有効期間内にあるかどうかを判定します．
    
    Returns:
    
    内にある場合は true，その他 false を返します．
    
    See Also:
    
    getDateFrom(), getDateTo()
  - overlapPeriod
```
public boolean overlapPeriod(int f,
                             int t)
```
    指定された期間において，このオブジェクトが有効な期間を含むかどうかを判別します．
    指定された期間が，このオブジェクトのもつ有効期間と重なる部分をもつかどうかを判定します．
    
    Parameters:
    
    f - 期間(始まり)
    
    t - 期間(終わり)
    
    Returns:
    
    有効な場合は true，その他 false を返します．
    
    See Also:
    
    getDateFrom(), getDateTo()
  - overlapPeriod
```
public boolean overlapPeriod(EdbDate2 p)
```
    指定された期間において，このオブジェクトが有効な期間を含むかどうかを判別します．
    指定された期間が，このオブジェクトのもつ有効期間と重なる部分をもつかどうかを判定します．
    
    Parameters:
    
    p - 期間
    
    Returns:
    
    有効な場合は true，その他 false を返します．
    
    See Also:
    
    getDateFrom(), getDateTo()
  - getAvailablePeriod
```
public EdbDate2 getAvailablePeriod()
```
    期間限定されている期間を得る．
    
    Returns:
    
    期間限定されている期間．
  - getAvailablePeriod
```
public EdbDate2 getAvailablePeriod(EdbDate2 period)
```
    期間限定されている期間と指定された期間のオーバラップしている期間を得る．
    
    Parameters:
    
    period - 期間.
    
    Returns:
    
    期間限定とオーバラップしている期間.

Class EdbObject

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface jp.ac.tokushima_u.edb.EdbEIDHolder

Methods inherited from interface jp.ac.tokushima_u.edb.EdbCensorSpi

Field Detail

fixed

edb

base

age

Constructor Detail

EdbObject

EdbObject

EdbObject

Method Detail

isFixed

checkChangable

getAge

tableSpiAdd

tupleSpiAdd

duplicate

parseXMLObject

createTuple

parseDefinition

parseDatabase

createPhantom

getEDB

isTable

isTuple

isPhantom

getBase

getEID

eid

getEOID

mapto

maptoIsValid

getMTime

operator

getAvailable

censor

getDateFrom

getDateTo

owner

getXN

equalsXN

makeXML

makeCompletedXML

makeXML

makeCaption

makeCaption

makeCaption

makeCaption

getMLName

getMLName

getMLName

getMLName

getCaption

getCaption

getCaption

getCaption

getCaption

equals

hashCode

equivalents

inPeriod

inPeriod

atPresent

overlapPeriod

overlapPeriod

getAvailablePeriod

getAvailablePeriod