概要 | パッケージ | クラス | 使用 | 階層ツリー | 非推奨 API | 索引 | ヘルプ
前のクラス 次のクラス | フレームあり フレームなし
概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド

## info.bix.tokai.bixpp.binding
クラス RecordingDefinition

    java.lang.Object
      info.bix.tokai.bixpp.binding.RecordingDefinition

すべての実装されたインタフェース:
  java.io.Serializable

    public class RecordingDefinition

extends java.lang.Object
implements java.io.Serializable

記録データを定義を表すRecordingDefinitionタグに対応した、複数のデータ定義を含むことができるコンテナです。 データの定義は、数値データを表す`DataItem`、 イベントデータを表す`EventItem`、 画像データを表す`ImageItem`、 音声データを表す`SoundItem`、 多次元配列を表す`VectorItem`を用いて構成されています。 各データはIndexを元に区別されています。

各データの定義例は、`DataItem`クラス、`EventItem`クラス、 `ImageItem`クラス、`SoundItem`クラス、 `VectorItem`クラスを参照してください。

作成者:
  Shiozawa
関連項目:
  `DefinitionItem`, `DataItem`, `EventItem`, `ImageItem`, `SoundItem`, `VectorItem`, 直列化された形式

コンストラクタの概要
`RecordingDefinition()`

メソッドの概要
`boolean` | `addAllDefinitionItem(java.util.Collection<? extends DefinitionItem> c)` データ定義を全て追加します。
`void` | `addDefinitionItem(DefinitionItem item)` データ定義を追加します。
`void` | `addDefinitionItem(int index, DefinitionItem item)` データ定義を指定した位置に挿入します。
`void` | `clearDataItem()` 数値データの定義を表す`DataItem`を消去します。
`void` | `clearDefinitionItem()` データ定義を消去します。
`void` | `clearEventItem()` イベントデータの定義を表す`EventItem`を消去します。
`void` | `clearImageItem()` 画像データの定義を表す`ImageItem`を消去します。
`void` | `clearSoundItem()` 音声データの定義を表す`SoundItem`を消去します。
`void` | `clearVectorItem()` 多次元配列の定義を表す`VectorItem`を消去します。
`DataItem[]` | `getDataItem()` 数値データの定義を表す`DataItem`を返します。
`int` | `getDataItemCount()` 数値データの定義を表す`DataItem`の数を返します。
`DefinitionItem[]` | `getDefinitionItem()` データ定義を返します。
`DefinitionItem` | `getDefinitionItem(int arrayIndex)` 指定された位置にある定義を返します。
`DefinitionItem` | `getDefinitionItemByIndex(long index)` 指定されたIndex値の`DefinitionItem`を返します。
`int` | `getDefinitionItemCount()` データ定義の数を返します。
`DescriptionItem[]` | `getDescriptionItem()` `RecordingDefinition`内の全ての文字列データの定義`DescriptionItem`を配列で返します。
`int` | `getDescriptionItemCount()` 文字列データの定義を表す`DescriptionItem`の数を返します。
`EventItem[]` | `getEventItem()` イベントデータの定義を表す`EventItem`の定義を返します。
`int` | `getEventItemCount()` イベントデータの定義を表す`EventItem`の数を返します。
`ImageItem[]` | `getImageItem()` 画像データの定義を表す`ImageItem`を返します。
`int` | `getImageItemCount()` 画像データの定義を表す`ImageItem`の数を返します。
`SoundItem[]` | `getSoundItem()` 音声データの定義を表す`SoundItem`を返します。
`int` | `getSoundItemCount()` 音声データの定義を表す`SoundItem`の数を返します。
`VectorItem[]` | `getVectorItem()` 多次元配列の定義を表す`VectorItem`を返します。
`int` | `getVectorItemCount()` 多次元配列の定義を表す`VectorItem`の数を返します。
`boolean` | `removeDefinitionItem(DefinitionItem item)` データ定義を消去します。
`void` | `setDefinitionItem(DefinitionItem[] definitionItemArray)` 指定した全てのデータ定義を上書きします。
`void` | `setDefinitionItem(int index, DefinitionItem item)` 指定された位置にあるデータ定義を置き換えます。

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

コンストラクタの詳細

### RecordingDefinition

    public RecordingDefinition()

メソッドの詳細

### addDefinitionItem

    public void addDefinitionItem(DefinitionItem item)

  データ定義を追加します。

  パラメータ:
    `item` - データ定義
  例外:
    `java.lang.IllegalArgumentException` - 引数にnullを指定した場合

### addDefinitionItem

    public void addDefinitionItem(int index,
                                  DefinitionItem item)

  データ定義を指定した位置に挿入します。

  パラメータ:
    `index` - データ定義が挿入されるインデックス値
    `item` - データ定義
  例外:
    `java.lang.IllegalArgumentException` - 引数にnullを指定した場合

### addAllDefinitionItem

    public boolean addAllDefinitionItem(java.util.Collection<? extends DefinitionItem> c)

  データ定義を全て追加します。

  例外:
    `java.lang.IllegalArgumentException` - 引数にnullを指定した場合

### setDefinitionItem

    public void setDefinitionItem(int index,
                                  DefinitionItem item)

  指定された位置にあるデータ定義を置き換えます。

  パラメータ:
    `index` - 置換されるデータ定義のインデックス値
    `item` - データ定義
  例外:
    `java.lang.IllegalArgumentException` - 引数にnullを指定した場合

### setDefinitionItem

    public void setDefinitionItem(DefinitionItem[] definitionItemArray)

  指定した全てのデータ定義を上書きします。

  パラメータ:
    `definitionItemArray` - データ定義
  例外:
    `java.lang.IllegalArgumentException` - 引数にnullを指定した場合

### clearDefinitionItem

    public void clearDefinitionItem()

  データ定義を消去します。

### removeDefinitionItem

    public boolean removeDefinitionItem(DefinitionItem item)

  データ定義を消去します。 削除が行われた場合はtrueを、行われなかった場合はfalseを返します。

  パラメータ:
    `item` - 消去するデータ定義

### clearDataItem

    public void clearDataItem()

  数値データの定義を表す`DataItem`を消去します。

### clearEventItem

    public void clearEventItem()

  イベントデータの定義を表す`EventItem`を消去します。

### clearImageItem

    public void clearImageItem()

  画像データの定義を表す`ImageItem`を消去します。

### clearSoundItem

    public void clearSoundItem()

  音声データの定義を表す`SoundItem`を消去します。

### clearVectorItem

    public void clearVectorItem()

  多次元配列の定義を表す`VectorItem`を消去します。

### getDefinitionItem

    public DefinitionItem[] getDefinitionItem()

  データ定義を返します。

  戻り値:
    データ定義

### getDefinitionItemCount

    public int getDefinitionItemCount()

  データ定義の数を返します。

  戻り値:
    データ定義の数

### getDefinitionItem

    public DefinitionItem getDefinitionItem(int arrayIndex)

  指定された位置にある定義を返します。 BIX-pp内でのIndex番号から取得したい場合は、引数が`double`の `getDefinitionItem`を使用してください。

  パラメータ:
    `arrayIndex` - リスト内の指定した位置
  戻り値:
    指定された位置にある定義

### getDataItem

    public DataItem[] getDataItem()

  数値データの定義を表す`DataItem`を返します。

### getDataItemCount

    public int getDataItemCount()

  数値データの定義を表す`DataItem`の数を返します。

### getEventItem

    public EventItem[] getEventItem()

  イベントデータの定義を表す`EventItem`の定義を返します。

### getEventItemCount

    public int getEventItemCount()

  イベントデータの定義を表す`EventItem`の数を返します。

### getImageItem

    public ImageItem[] getImageItem()

  画像データの定義を表す`ImageItem`を返します。

### getImageItemCount

    public int getImageItemCount()

  画像データの定義を表す`ImageItem`の数を返します。

### getSoundItem

    public SoundItem[] getSoundItem()

  音声データの定義を表す`SoundItem`を返します。

### getSoundItemCount

    public int getSoundItemCount()

  音声データの定義を表す`SoundItem`の数を返します。

### getVectorItem

    public VectorItem[] getVectorItem()

  多次元配列の定義を表す`VectorItem`を返します。

### getVectorItemCount

    public int getVectorItemCount()

  多次元配列の定義を表す`VectorItem`の数を返します。

### getDescriptionItem

    public DescriptionItem[] getDescriptionItem()

  `RecordingDefinition`内の全ての文字列データの定義`DescriptionItem`を配列で返します。

  戻り値:
    `RecordingDefinition`内の全ての`DescriptionItem`の配列

### getDescriptionItemCount

    public int getDescriptionItemCount()

  文字列データの定義を表す`DescriptionItem`の数を返します。

  戻り値:
    `DescriptionItem`の数

### getDefinitionItemByIndex

    public DefinitionItem getDefinitionItemByIndex(long index)

  指定されたIndex値の`DefinitionItem`を返します。 そのIndex値の`DefinitionItem`が無かった場合、nullを返します。

  パラメータ:
    `index` - `RecordingDefinition`内に定義されたIndex値
  戻り値:
    指定されたIndex値の`DefinitionItem`

概要 | パッケージ | クラス | 使用 | 階層ツリー | 非推奨 API | 索引 | ヘルプ
前のクラス 次のクラス | フレームあり フレームなし
概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド