PFLabeledObjectList (MZPlatform Component API)

java.lang.Object
- java.util.AbstractCollection<E>
- - java.util.AbstractList<E>
  - - java.util.Vector
    - - jp.go.aist.dmrc.platform.util.PFObjectList
      - jp.go.aist.dmrc.platform.util.PFLabeledObjectList

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

java.io.Serializable, java.lang.Cloneable, java.lang.Iterable, java.util.Collection, java.util.List, java.util.RandomAccess, PFDataStructure
```
public class PFLabeledObjectList
extends PFObjectList
```
MZ Platform標準のリストクラス(PFObjectList)の拡張であるラベル付きリストクラス。ラベル付きリストでは、各要素が常にラベル付きオブジェクト(PFLabeledObject)である。
ラベル付きオブジェクトを要素とすることで、各要素に対して要素名でアクセスすることができる。これはユーザ定義型のデータ構造をコンポーネント内部ではなくアプリケーションで設計し、そのデータへのアクセス処理をビルダー上で記述することを目的に導入した。

関連項目:

直列化された形式

フィールドのサマリー
- クラスから継承されたフィールド java.util.Vector
  capacityIncrement, elementCount, elementData
- クラスから継承されたフィールド java.util.AbstractList
  modCount

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

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

PFLabeledObjectList()
デフォルトコンストラクタ

コンストラクタ
コンストラクタと説明
`PFLabeledObjectList()` デフォルトコンストラクタ

メソッドのサマリー

All Methods Instance Methods Concrete Methods
修飾子とタイプ	メソッドと説明
`void`	`add(int i, java.lang.Object o)` 要素を指定位置に追加する。
`void`	`add(int i, java.lang.Object o, java.lang.String type)` 要素を指定位置に追加する(型名指定)。
`void`	`add(int i, java.lang.String str, java.lang.Object o)` 要素を指定位置に追加する(名前指定)。
`void`	`add(int i, java.lang.String str, java.lang.Object o, java.lang.String type)` 要素を指定位置に追加する(名前・型名指定)。
`boolean`	`add(java.lang.Object o)` 要素を最後尾に追加する。
`void`	`add(java.lang.Object o, java.lang.String type)` 要素を最後尾に追加する(型名指定)。
`void`	`add(java.lang.String str, java.lang.Object o)` 要素を最後尾に追加する(名前指定)。
`void`	`add(java.lang.String str, java.lang.Object o, java.lang.String type)` 要素を最後尾に追加する(名前・型名指定)。
`boolean`	`addAll(java.util.Collection c)` 他のコレクション要素を全て最後尾に追加する。
`boolean`	`addAll(int index, java.util.Collection c)` 他のコレクション要素を全て指定位置に追加する。
`void`	`addElement(java.lang.Object o)` 要素を最後尾に追加する。
`protected boolean`	`canGet(int i)` 要素を位置指定で取得可能か調べる。
`boolean`	`canGetDataAt(int i)` 要素内のオブジェクトを位置指定で取得可能か調べる。
`boolean`	`canGetDataByName(java.lang.String name)` 要素内のオブジェクトを名前指定で取得可能か調べる。
`boolean`	`canGetDataByPath(PFObjectList path)` 要素内のオブジェクトを要素名パス指定で取得可能か調べる。
`java.lang.Object`	`getDataAt(int i)` 要素内のオブジェクトを位置指定で取得する。
`java.lang.Object`	`getDataByName(java.lang.String name)` 要素内のオブジェクトを名前指定で取得する。
`java.lang.Object`	`getDataByNameIgnoreCase(java.lang.String name)` 要素内のオブジェクトを、大文字と小文字を区別せずに名前指定で取得する。
`java.lang.Object`	`getDataByPath(PFObjectList path_org)` 要素内のオブジェクトを要素名パス指定で取得する。
`PFObjectList`	`getDataList()` 全要素のオブジェクト抽出リストを取得する。
`int`	`getIndexByData(java.lang.Object o)` 要素内のオブジェクトの位置を取得する。
`int`	`getIndexByName(java.lang.String name)` 要素の位置を名前指定で取得する。
`int`	`getIndexByNameIgnoreCase(java.lang.String name)` 要素の位置を、大文字と小文字を区別せずに名前指定で取得する。
`java.lang.String`	`getNameAt(int i)` 要素の項目名を位置指定で取得する。
`PFObjectList`	`getNameList()` 全要素の項目名リストを取得する。
`java.lang.String`	`getTypeAt(int i)` 要素の型名を位置指定で取得する。
`java.lang.String`	`getTypeByName(java.lang.String name)` 要素の型名を名前指定で取得する。
`java.lang.String`	`getTypeByNameIgnoreCase(java.lang.String name)` 要素の型名を、大文字と小文字を区別せずに名前指定で取得する。
`boolean`	`removeByName(java.lang.String name)` 要素を名前指定で削除する。
`java.lang.Object`	`set(int i, java.lang.Object o)` 要素を位置指定で置き換える。
`void`	`setDataAt(int i, java.lang.Object o)` 要素内のオブジェクトを位置指定で設定する。
`void`	`setDataAt(int i, java.lang.Object o, java.lang.String type)` 要素内のオブジェクトを位置指定で設定する(型名指定)。
`void`	`setDataByName(java.lang.String name, java.lang.Object o)` 要素内のオブジェクトを名前指定で設定する。
`void`	`setDataByName(java.lang.String name, java.lang.Object o, java.lang.String type)` 要素内のオブジェクトを名前指定で設定する(型名指定)。
`void`	`setDataList(PFObjectList items)` 全要素のデータリストを設定する。
`void`	`setElementAt(java.lang.Object o, int i)` 要素を位置指定で置き換える。
`void`	`setNameAt(int i, java.lang.String text)` 要素の名前を位置指定で設定する。
`void`	`setNameList(PFObjectList items)` 全要素の項目名リストを設定する。

クラスから継承されたメソッド jp.go.aist.dmrc.platform.util.PFObjectList
clone, equals, getSourceComponent, printData, setSourceComponent

クラスから継承されたメソッド java.util.Vector
capacity, clear, contains, containsAll, copyInto, elementAt, elements, ensureCapacity, firstElement, forEach, get, hashCode, indexOf, indexOf, insertElementAt, isEmpty, iterator, lastElement, lastIndexOf, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, removeAllElements, removeElement, removeElementAt, removeIf, removeRange, replaceAll, retainAll, setSize, size, sort, spliterator, subList, toArray, toArray, toString, trimToSize

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

インタフェースから継承されたメソッド java.util.Collection
parallelStream, stream

- コンストラクタの詳細
  - PFLabeledObjectList
```
public PFLabeledObjectList()
```
    デフォルトコンストラクタ
- メソッドの詳細
  - add
```
public void add(int i,
                java.lang.String str,
                java.lang.Object o,
                java.lang.String type)
```
    要素を指定位置に追加する(名前・型名指定)。リストに追加されるものは、名前(String)とオブジェクトと型名(String)で構成される組(PFLabeledObject)である。
    
    パラメータ:
    
    i - 位置
    
    str - 名前
    
    o - 追加するオブジェクト
    
    type - 型名
  - add
```
public void add(int i,
                java.lang.String str,
                java.lang.Object o)
```
    要素を指定位置に追加する(名前指定)。リストに追加されるものは、名前(String)とオブジェクトと型名(String)で構成される組(PFLabeledObject)である。ここでは、型名は追加するオブジェクトのクラス名となる。ただし、オブジェクトがnullの場合は型名もnullとなる。
    
    パラメータ:
    
    i - 位置
    
    str - 名前
    
    o - 追加するオブジェクト
  - add
```
public void add(int i,
                java.lang.Object o)
```
    要素を指定位置に追加する。リストに追加されるものは、名前(String)とオブジェクトと型名(String)で構成される組(PFLabeledObject)である。ここでは、名前は指定位置のインデックス、型名は追加するオブジェクトのクラス名となる。ただし、オブジェクトがnullの場合は型名もnullとなる。
    
    定義:
    
    add インタフェース内 java.util.List
    
    オーバーライド:
    
    add クラス内 java.util.Vector
    
    パラメータ:
    
    i - 位置
    
    o - 追加するオブジェクト
  - add
```
public void add(java.lang.String str,
                java.lang.Object o)
```
    要素を最後尾に追加する(名前指定)。リストに追加されるものは、名前(String)とオブジェクトと型名(String)で構成される組(PFLabeledObject)である。ここでは、型名は追加するオブジェクトのクラス名となる。ただし、オブジェクトがnullの場合は型名もnullとなる。
    
    パラメータ:
    
    str - 名前
    
    o - 追加するオブジェクト
  - add
```
public boolean add(java.lang.Object o)
```
    要素を最後尾に追加する。リストに追加されるものは、名前(String)とオブジェクトと型名(String)で構成される組(PFLabeledObject)である。ここでは、名前は最後尾のインデックス、型名は追加するオブジェクトのクラス名となる。ただし、オブジェクトがnullの場合は型名もnullとなる。
    
    定義:
    
    add インタフェース内 java.util.Collection
    
    定義:
    
    add インタフェース内 java.util.List
    
    オーバーライド:
    
    add クラス内 java.util.Vector
    
    パラメータ:
    
    o - 追加するオブジェクト
  - add
```
public void add(int i,
                java.lang.Object o,
                java.lang.String type)
```
    要素を指定位置に追加する(型名指定)。リストに追加されるものは、名前(String)とオブジェクトと型名(String)で構成される組(PFLabeledObject)である。ここでは、名前は指定位置のインデックスとなる。
    
    パラメータ:
    
    i - 位置
    
    o - 追加するオブジェクト
    
    type - 型名
  - add
```
public void add(java.lang.String str,
                java.lang.Object o,
                java.lang.String type)
```
    要素を最後尾に追加する(名前・型名指定)。リストに追加されるものは、名前(String)とオブジェクトと型名(String)で構成される組(PFLabeledObject)である。
    
    パラメータ:
    
    str - 名前
    
    o - 追加するオブジェクト
    
    type - 型名
  - add
```
public void add(java.lang.Object o,
                java.lang.String type)
```
    要素を最後尾に追加する(型名指定)。リストに追加されるものは、名前(String)とオブジェクトと型名(String)で構成される組(PFLabeledObject)である。ここでは、名前は最後尾のインデックスとなる。
    
    パラメータ:
    
    o - 追加するオブジェクト
    
    type - 型名
  - addElement
```
public void addElement(java.lang.Object o)
```
    要素を最後尾に追加する。 addと同一の処理を行う。
    
    オーバーライド:
    
    addElement クラス内 java.util.Vector
    
    パラメータ:
    
    o - 追加するオブジェクト
  - addAll
```
public boolean addAll(java.util.Collection c)
```
    他のコレクション要素を全て最後尾に追加する。対象とするコレクションがラベル付きリスト(PFLabeledObjectList)の場合は直接要素を追加する。それ以外の場合は、ラベル付きリスト(PFLabeledObjectList)の要素を作成して追加する。
    
    定義:
    
    addAll インタフェース内 java.util.Collection
    
    定義:
    
    addAll インタフェース内 java.util.List
    
    オーバーライド:
    
    addAll クラス内 java.util.Vector
    
    パラメータ:
    
    c - 追加するコレクション
  - addAll
```
public boolean addAll(int index,
                      java.util.Collection c)
```
    他のコレクション要素を全て指定位置に追加する。対象とするコレクションがラベル付きリスト(PFLabeledObjectList)の場合は直接要素を追加する。それ以外の場合は、ラベル付きリスト(PFLabeledObjectList)の要素を作成して追加する。
    
    定義:
    
    addAll インタフェース内 java.util.List
    
    オーバーライド:
    
    addAll クラス内 java.util.Vector
    
    パラメータ:
    
    index - 位置
    
    c - 追加するコレクション
  - removeByName
```
public boolean removeByName(java.lang.String name)
```
    要素を名前指定で削除する。戻り値は削除結果であるため、削除した要素を後で利用する場合にはあらかじめ取得しておく必要がある。
    
    パラメータ:
    
    name - 名前
    
    戻り値:
    
    削除結果(boolean)
  - getDataList
```
public PFObjectList getDataList()
```
    全要素のオブジェクト抽出リストを取得する。
    
    戻り値:
    
    オブジェクトのリスト
  - getNameList
```
public PFObjectList getNameList()
```
    全要素の項目名リストを取得する。
    
    戻り値:
    
    項目名のリスト
  - setNameList
```
public void setNameList(PFObjectList items)
```
    全要素の項目名リストを設定する。リスト要素はPFLabeledObjectであり、その名前だけを設定する。
    
    パラメータ:
    
    items - 項目名のリスト
  - getNameAt
```
public java.lang.String getNameAt(int i)
```
    要素の項目名を位置指定で取得する。
    
    パラメータ:
    
    i - 位置
    
    戻り値:
    
    名前
  - getDataAt
```
public java.lang.Object getDataAt(int i)
```
    要素内のオブジェクトを位置指定で取得する。
    
    パラメータ:
    
    i - 位置
    
    戻り値:
    
    オブジェクト
  - getIndexByName
```
public int getIndexByName(java.lang.String name)
```
    要素の位置を名前指定で取得する。同名の要素がある場合には最初のインデックスが得られる。対応する要素がない場合には-1が返る。
    
    パラメータ:
    
    name - 名前
    
    戻り値:
    
    要素の位置(int)
  - canGet
```
protected boolean canGet(int i)
```
    要素を位置指定で取得可能か調べる。
    
    パラメータ:
    
    i - 位置
    
    戻り値:
    
    結果(boolean)
  - canGetDataAt
```
public boolean canGetDataAt(int i)
```
    要素内のオブジェクトを位置指定で取得可能か調べる。
    
    パラメータ:
    
    i - 位置
    
    戻り値:
    
    結果(boolean)
  - canGetDataByName
```
public boolean canGetDataByName(java.lang.String name)
```
    要素内のオブジェクトを名前指定で取得可能か調べる。
    
    パラメータ:
    
    name - 名前
    
    戻り値:
    
    結果(boolean)
  - canGetDataByPath
```
public boolean canGetDataByPath(PFObjectList path)
```
    要素内のオブジェクトを要素名パス指定で取得可能か調べる。
    
    パラメータ:
    
    path - 要素名パスのリスト(PFObjectList)
    
    戻り値:
    
    結果(boolean)
  - getTypeAt
```
public java.lang.String getTypeAt(int i)
```
    要素の型名を位置指定で取得する。要素が空の場合には、空文字を返す。
    
    パラメータ:
    
    i - 位置
    
    戻り値:
    
    型名(String)
  - getTypeByName
```
public java.lang.String getTypeByName(java.lang.String name)
```
    要素の型名を名前指定で取得する。要素が空の場合には、空文字を返す。
    
    パラメータ:
    
    name - 名前
    
    戻り値:
    
    型名(String)
  - getDataByPath
```
public java.lang.Object getDataByPath(PFObjectList path_org)
```
    要素内のオブジェクトを要素名パス指定で取得する。
    
    パラメータ:
    
    path_org - 要素名パス(PFObjectList)
    
    戻り値:
    
    オブジェクト
  - getDataByName
```
public java.lang.Object getDataByName(java.lang.String name)
```
    要素内のオブジェクトを名前指定で取得する。該当するオブジェクトが存在しない場合はnullが返る。
    
    パラメータ:
    
    name - 名前
    
    戻り値:
    
    オブジェクト
  - setDataByName
```
public void setDataByName(java.lang.String name,
                          java.lang.Object o)
```
    要素内のオブジェクトを名前指定で設定する。指定した名前の要素がなければ要素を最後尾に追加する。
    
    パラメータ:
    
    name - 名前
    
    o - 設定するオブジェクト
  - setDataByName
```
public void setDataByName(java.lang.String name,
                          java.lang.Object o,
                          java.lang.String type)
```
    要素内のオブジェクトを名前指定で設定する(型名指定)。指定した名前の要素がなければ要素を最後尾に追加する。
    
    パラメータ:
    
    name - 名前
    
    o - 設定するオブジェクト
    
    type - 型名
  - setNameAt
```
public void setNameAt(int i,
                      java.lang.String text)
```
    要素の名前を位置指定で設定する。
    
    パラメータ:
    
    i - 位置
    
    text - 名前
  - setDataAt
```
public void setDataAt(int i,
                      java.lang.Object o)
```
    要素内のオブジェクトを位置指定で設定する。
    
    パラメータ:
    
    i - 位置
    
    o - 設定するオブジェクト
  - setDataAt
```
public void setDataAt(int i,
                      java.lang.Object o,
                      java.lang.String type)
```
    要素内のオブジェクトを位置指定で設定する(型名指定)。
    
    パラメータ:
    
    i - 位置
    
    o - 設定するオブジェクト
    
    type - 型名
  - set
```
public java.lang.Object set(int i,
                            java.lang.Object o)
```
    要素を位置指定で置き換える。ただし、引数として与える要素にPFLabeledObject以外を与えても無視する。指定位置のデータを置き換えたい場合はsetDataAt(int,Object)を使用すること。
    
    定義:
    
    set インタフェース内 java.util.List
    
    オーバーライド:
    
    set クラス内 java.util.Vector
    
    パラメータ:
    
    i - 位置
    
    o - 置き換える要素(PFLabeledObject)
  - setElementAt
```
public void setElementAt(java.lang.Object o,
                         int i)
```
    要素を位置指定で置き換える。 setと同一の処理を行う。
    
    オーバーライド:
    
    setElementAt クラス内 java.util.Vector
    
    パラメータ:
    
    o - 置き換える要素(PFLabeledObject)
    
    i - 位置
  - getIndexByNameIgnoreCase
```
public int getIndexByNameIgnoreCase(java.lang.String name)
```
    要素の位置を、大文字と小文字を区別せずに名前指定で取得する。同名の要素がある場合には最初のインデックスが得られる。対応する要素がない場合には-1が返る。
    
    パラメータ:
    
    name - 名前
    
    戻り値:
    
    要素の位置(int)
  - getTypeByNameIgnoreCase
```
public java.lang.String getTypeByNameIgnoreCase(java.lang.String name)
```
    要素の型名を、大文字と小文字を区別せずに名前指定で取得する。要素が空の場合には、空文字を返す。
    
    パラメータ:
    
    name - 名前
    
    戻り値:
    
    型名(String)
  - getDataByNameIgnoreCase
```
public java.lang.Object getDataByNameIgnoreCase(java.lang.String name)
```
    要素内のオブジェクトを、大文字と小文字を区別せずに名前指定で取得する。該当するオブジェクトが存在しない場合はnullが返る。
    
    パラメータ:
    
    name - 名前
    
    戻り値:
    
    オブジェクト
  - setDataList
```
public void setDataList(PFObjectList items)
```
    全要素のデータリストを設定する。リスト要素はPFLabeledObjectであり、そのデータだけを設定する。
    
    パラメータ:
    
    items - データのリスト
  - getIndexByData
```
public int getIndexByData(java.lang.Object o)
```
    要素内のオブジェクトの位置を取得する。
    
    パラメータ:
    
    o - オブジェクト
    
    戻り値:
    
    位置(インデックス)

クラス PFLabeledObjectList

フィールドのサマリー

クラスから継承されたフィールド java.util.Vector

クラスから継承されたフィールド java.util.AbstractList

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

メソッドのサマリー

クラスから継承されたメソッド jp.go.aist.dmrc.platform.util.PFObjectList

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

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

インタフェースから継承されたメソッド java.util.Collection

コンストラクタの詳細

PFLabeledObjectList

メソッドの詳細

add

add

add

add

add

add

add

add

addElement

addAll

addAll

removeByName

getDataList

getNameList

setNameList

getNameAt

getDataAt

getIndexByName

canGet

canGetDataAt

canGetDataByName

canGetDataByPath

getTypeAt

getTypeByName

getDataByPath

getDataByName

setDataByName

setDataByName

setNameAt

setDataAt

setDataAt

set

setElementAt

getIndexByNameIgnoreCase

getTypeByNameIgnoreCase

getDataByNameIgnoreCase

setDataList

getIndexByData