AttributeTable (PIAX GTrans 3.1.0 API)

java.lang.Object
- org.piax.common.attribs.AttributeTable

```
public class AttributeTable
extends Object
```
A class that corresponds to a table of attributes.

フィールドのサマリー

フィールド
修飾子とタイプ	フィールドと説明
`PeerId`	`peerId`
`RowData`	`superRow` テーブルに一つ特別のrowの挿入を許す。
`Object`	`superRowLock`
`ObjectId`	`tableId`

コンストラクタのサマリー

コンストラクタ
コンストラクタと説明

AttributeTable(PeerId peerId, ObjectId tableId)

コンストラクタ
コンストラクタと説明
`AttributeTable(PeerId peerId, ObjectId tableId)`

メソッドのサマリー

All Methods Instance Methods Concrete Methods
修飾子とタイプ	メソッドと説明
`void`	`bindOverlay(String attribName, TransportIdPath suffix)` 指定されたattribNameを持つAttributeに、指定されたTransportIdPathをsuffixとして持ち、型の互換性のあるOverlayをbindさせる。
`void`	`clear()`
`void`	`declareAttrib(String attribName)`
`void`	`declareAttrib(String attribName, Class<?> type)`
`Attribute`	`getAttrib(String attribName)` 指定された名前を持つAttributeを取得する。
`Overlay<Destination,Key>`	`getBindOverlay(String attribName)`
`List<String>`	`getDeclaredAttribNames()`
`Set<RowData>`	`getMatchedRows(String attribName, Object value)`
`RowData`	`getRow(Id rowId)` 指定されたrowIdを持つRowDataを取得する。
`List<RowData>`	`getRows()`
`void`	`insertRow(RowData row)` RowDataを挿入する。
`Attribute`	`newAttribIfAbsent(String attribName)` 指定された名前を持つAttributeを取得する。
`RowData`	`newRow(Id rowId)` 指定されたrowIdを持つRowDataを新たに生成する。
`RowData`	`removeRow(Id rowId)`
`boolean`	`satisfies(RowData row, List<VarDestinationPair> conds)`
`RowData`	`setSuperRow(Id rowId)` 指定されたrowIdを持つRowDataをsuperRowとしてセットする。
`String`	`toString()`
`void`	`unbindOverlay(String attribName)`
`void`	`unsetSuperRow()` superRowをunsetする。

クラスから継承されたメソッド java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- フィールドの詳細
  - peerId
```
public final PeerId peerId
```
  - tableId
```
public final ObjectId tableId
```
  - superRow
```
public RowData superRow
```
    テーブルに一つ特別のrowの挿入を許す。このrowの持つ属性値がマッチするとき、その属性がセットされていないすべてのrowがマッチの対象となる
  - superRowLock
```
public Object superRowLock
```
- コンストラクタの詳細
  - AttributeTable
```
public AttributeTable(PeerId peerId,
                      ObjectId tableId)
```
- メソッドの詳細
  - clear
```
public void clear()
```
  - newAttribIfAbsent
```
public Attribute newAttribIfAbsent(String attribName)
```
    指定された名前を持つAttributeを取得する。もし、そのAttributeが存在しない場合は新規に作成する。
    
    パラメータ:
    
    attribName - 属性名
    
    戻り値:
    
    attribNameを持つAttribute
  - getAttrib
```
public Attribute getAttrib(String attribName)
```
    指定された名前を持つAttributeを取得する。 newAttribIfAbsentと違って、Attributeの作成は行わない。そのAttributeが存在しない場合はnullが返される。
    
    パラメータ:
    
    attribName - 属性名
    
    戻り値:
    
    attribNameを持つAttribute、存在しない場合はnull
  - getDeclaredAttribNames
```
public List<String> getDeclaredAttribNames()
```
  - declareAttrib
```
public void declareAttrib(String attribName)
                   throws IllegalStateException
```
    例外:
    
    IllegalStateException
  - declareAttrib
```
public void declareAttrib(String attribName,
                          Class<?> type)
                   throws IllegalStateException
```
    例外:
    
    IllegalStateException
  - bindOverlay
```
public void bindOverlay(String attribName,
                        TransportIdPath suffix)
                 throws IllegalArgumentException,
                        NoSuchOverlayException,
                        IncompatibleTypeException
```
    指定されたattribNameを持つAttributeに、指定されたTransportIdPathをsuffixとして持ち、型の互換性のあるOverlayをbindさせる。
    
    パラメータ:
    
    attribName - attribName
    
    suffix - suffixとして指定されたTransportIdPath
    
    例外:
    
    IllegalArgumentException - 該当するAttributeが存在しない場合
    
    NoSuchOverlayException - 該当するOverlayが存在しない場合
    
    IncompatibleTypeException - 型の互換性が原因で候補が得られない場合
  - unbindOverlay
```
public void unbindOverlay(String attribName)
                   throws IllegalArgumentException,
                          IllegalStateException
```
    例外:
    
    IllegalArgumentException
    
    IllegalStateException
  - getBindOverlay
```
public Overlay<Destination,Key> getBindOverlay(String attribName)
                                        throws IllegalArgumentException
```
    例外:
    
    IllegalArgumentException
  - getMatchedRows
```
public Set<RowData> getMatchedRows(String attribName,
                                   Object value)
                            throws IllegalArgumentException,
                                   IllegalStateException
```
    例外:
    
    IllegalArgumentException
    
    IllegalStateException
  - satisfies
```
public boolean satisfies(RowData row,
                         List<VarDestinationPair> conds)
```
  - setSuperRow
```
public RowData setSuperRow(Id rowId)
                    throws IdConflictException
```
    指定されたrowIdを持つRowDataをsuperRowとしてセットする。すでにRowDataが存在する場合はIdConflictExceptionがthrowされる。
    
    パラメータ:
    
    rowId - rowId
    
    戻り値:
    
    superRow
    
    例外:
    
    IdConflictException - すでにsuperRowが存在する場合
  - unsetSuperRow
```
public void unsetSuperRow()
```
    superRowをunsetする。
  - newRow
```
public RowData newRow(Id rowId)
               throws IdConflictException
```
    指定されたrowIdを持つRowDataを新たに生成する。すでにRowDataが存在する場合はIdConflictExceptionがthrowされる。
    
    パラメータ:
    
    rowId - rowId
    
    戻り値:
    
    rowIdを持つRowData
    
    例外:
    
    IdConflictException - すでにRowDataが存在する場合
  - insertRow
```
public void insertRow(RowData row)
               throws IllegalStateException,
                      IdConflictException
```
    RowDataを挿入する。すでに同じrowIdを持つRowDataが存在する場合はIdConflictExceptionがthrowされる。
    この挿入によって起こりうる不整合に注意する必要がある。属性値を別に持つRowDataを新たにtableに挿入することで、属性名との不整合が起こりうる。このため、Attributeに対してunboundなRowDataでないと挿入は許されない。
    
    パラメータ:
    
    row - RowData
    
    例外:
    
    IllegalStateException - RowDataがAttributeに対してunboundでない場合
    
    IdConflictException - すでに同じrowIdを持つRowDataが存在する場合
  - removeRow
```
public RowData removeRow(Id rowId)
```
  - getRow
```
public RowData getRow(Id rowId)
```
    指定されたrowIdを持つRowDataを取得する。 RowDataが存在しない場合はnullが返される。
    
    パラメータ:
    
    rowId - rowId
    
    戻り値:
    
    rowIdを持つRowData
  - getRows
```
public List<RowData> getRows()
```
  - toString
```
public String toString()
```
    オーバーライド:
    
    toString クラス内 Object

クラス AttributeTable

フィールドのサマリー

コンストラクタのサマリー

メソッドのサマリー

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

フィールドの詳細

peerId

tableId

superRow

superRowLock

コンストラクタの詳細

AttributeTable

メソッドの詳細

clear

newAttribIfAbsent

getAttrib

getDeclaredAttribNames

declareAttrib

declareAttrib

bindOverlay

unbindOverlay

getBindOverlay

getMatchedRows

satisfies

setSuperRow

unsetSuperRow

newRow

insertRow

removeRow

getRow

getRows

toString