PFMongoFilter (MZ Platform Component API (Ver. 4.0))

java.lang.Object
- jp.go.aist.dmrc.platform.beans.mongodb.PFMongoFilter

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

java.io.Serializable, PFComponent, PFXMLSerializable
```
public class PFMongoFilter
extends java.lang.Object
implements PFComponent, PFXMLSerializable
```
mongodb検索時に使用するフィルタのコンポーネント。

バージョン:

1.0

関連項目:

直列化された形式

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

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

PFMongoFilter()
コンポーネントを生成する。

コンストラクタ
コンストラクタと説明
`PFMongoFilter()` コンポーネントを生成する。

メソッドのサマリー

すべてのメソッドインスタンス・メソッド concreteメソッド
修飾子とタイプ	メソッドと説明
`void`	`addEqualFilter(java.lang.String key, java.lang.Object value)` 現在のフィルタに、キーに紐付く値が指示した値と一致するドキュメントを検索するフィルタをAND条件で追加する。
`void`	`addGreaterThanEqualFilter(java.lang.String key, java.lang.Object value)` 現在のフィルタに、キーに紐付く値が指示した値以上であるドキュメントを検索するフィルタをAND条件で追加する。
`void`	`addGreaterThanFilter(java.lang.String key, java.lang.Object value)` 現在のフィルタに、キーに紐付く値が指示した値より大きいドキュメントを検索するフィルタをAND条件で追加する。
`void`	`addLessThanEqualFilter(java.lang.String key, java.lang.Object value)` 現在のフィルタに、キーに紐付く値が指示した値以下であるドキュメントを検索するフィルタをAND条件で追加する。
`void`	`addLessThanFilter(java.lang.String key, java.lang.Object value)` 現在のフィルタに、キーに紐付く値が指示した値より小さいドキュメントを検索するフィルタをAND条件で追加する。
`void`	`addNotEqualFilter(java.lang.String key, java.lang.Object value)` 現在のフィルタに、キーに紐付く値が指示した値と一致しないドキュメントを検索するフィルタをAND条件で追加する。
`Bson`	`getBsonDocument()` フィルタのBSONドキュメントを取得する。
`int`	`getComponentID()` コンポーネントIDを取得する。
`java.lang.String`	`getComponentKey()` コンポーネントキーを取得する。
`PFMultiLocaleString`	`getComponentKeys()` 全ロケール分のコンポーネントキーを返す。
`java.lang.String`	`getComponentName()` コンポーネント名称を取得する。
`java.lang.String`	`getComponentPublicName()` コンポーネント公開名を取得する.
`java.lang.String`	`getComponentString()` コンポーネントの文字列表現を取得する。
`boolean`	`isAllowPullTransfer()` 他PFからのPull型コンポーネント転送要求に対する可否属性を取得する.
`boolean`	`isAllowPushTransfer()` 他PFへのPush型コンポーネント転送要求に対する可否属性を取得する.
`boolean`	`isAllowRemoteInvocation()` 他PFからのコンポーネント連携要求に対する可否属性を取得する.
`void`	`localeUpdated()` ロケール変更に対応する。
`void`	`readXML(PFXMLLoader in)` XMLを入力する.
`void`	`setAllowPullTransfer(boolean flag)` 他PFからのPull型コンポーネント転送要求に対する可否属性を設定する.
`void`	`setAllowPushTransfer(boolean flag)` 他PFへのPush型コンポーネント転送要求に対する可否属性を設定する.
`void`	`setAllowRemoteInvocation(boolean flag)` 他PFからのコンポーネント連携要求に対する可否属性を設定する.
`void`	`setAndFilter(PFMongoFilter filter1, PFMongoFilter filter2)` 2つのフィルタをAND条件で結合したフィルタを設定する。
`void`	`setAndFilter(PFObjectList filterList)` 複数のフィルタをAND条件で結合したフィルタを設定する。
`void`	`setComponentID(int id)` コンポーネントIDを設定する。
`void`	`setComponentKey(java.lang.String key)` コンポーネントキーを設定する。
`void`	`setComponentKeys(PFMultiLocaleString keys)` 全ロケール分のコンポーネントキーを設定する。
`void`	`setComponentPublicName(java.lang.String publicName)` コンポーネント公開名を設定する.
`void`	`setEqualFilter(java.lang.String key, java.lang.Object value)` キーに紐付く値が指示した値と一致するドキュメントを検索するフィルタを設定する。
`void`	`setGreaterThanEqualFilter(java.lang.String key, java.lang.Object value)` キーに紐付く値が指示した値以上であるドキュメントを検索するフィルタを設定する。
`void`	`setGreaterThanFilter(java.lang.String key, java.lang.Object value)` キーに紐付く値が指示した値より大きいドキュメントを検索するフィルタを設定する。
`void`	`setInFilter(java.lang.String key, PFObjectList filterList)` キーに紐付く値が値リストの中のいずれかの値と一致するドキュメントを検索するフィルタを設定する。
`void`	`setLessThanEqualFilter(java.lang.String key, java.lang.Object value)` キーに紐付く値が指示した値以下であるドキュメントを検索するフィルタを設定する。
`void`	`setLessThanFilter(java.lang.String key, java.lang.Object value)` キーに紐付く値が指示した値より小さいドキュメントを検索するフィルタを設定する。
`void`	`setNinFilter(java.lang.String key, PFObjectList filterList)` キーに紐付く値が値リストの中のどの値とも一致しないドキュメントを検索するフィルタを設定する。
`void`	`setNorFilter(PFMongoFilter filter1, PFMongoFilter filter2)` 2つのフィルタをNOR条件で結合したフィルタを設定する。
`void`	`setNotEqualFilter(java.lang.String key, java.lang.Object value)` キーに紐付く値が指示した値と一致しないドキュメントを検索するフィルタを設定する。
`void`	`setOrFilter(PFMongoFilter filter1, PFMongoFilter filter2)` 2つのフィルタをOR条件で結合したフィルタを設定する。
`void`	`setOrFilter(PFObjectList filterList)` 複数のフィルタをOR条件で結合したフィルタを設定する。
`java.lang.String`	`toString()`
`void`	`writeXML(PFXMLGenerator out)` XMLを出力する.

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

- コンストラクタの詳細
  - PFMongoFilter
```
public PFMongoFilter()
```
    コンポーネントを生成する。
- メソッドの詳細
  - getComponentName
```
public java.lang.String getComponentName()
```
    コンポーネント名称を取得する。
    
    定義:
    
    getComponentName インタフェース内 PFComponent
    
    戻り値:
    
    コンポーネント名
  - getComponentKey
```
public java.lang.String getComponentKey()
```
    コンポーネントキーを取得する。
    
    定義:
    
    getComponentKey インタフェース内 PFComponent
    
    戻り値:
    
    コンポーネントキー
  - setComponentKey
```
public void setComponentKey(java.lang.String key)
```
    コンポーネントキーを設定する。
    
    定義:
    
    setComponentKey インタフェース内 PFComponent
    
    パラメータ:
    
    key - コンポーネントキー
  - getComponentKeys
```
public PFMultiLocaleString getComponentKeys()
```
    全ロケール分のコンポーネントキーを返す。
    
    戻り値:
    
    全ロケール分のコンポーネントキー
  - setComponentKeys
```
public void setComponentKeys(PFMultiLocaleString keys)
```
    全ロケール分のコンポーネントキーを設定する。
    
    パラメータ:
    
    keys - 全ロケール分のコンポーネントキー
  - getComponentID
```
public int getComponentID()
```
    コンポーネントIDを取得する。
    
    定義:
    
    getComponentID インタフェース内 PFComponent
    
    戻り値:
    
    コンポーネントID
  - setComponentID
```
public void setComponentID(int id)
```
    コンポーネントIDを設定する。
    コンポーネントIDはプラットフォームPFComponentBusから設定される。 各コンポーネント内では操作しないこと。
    
    定義:
    
    setComponentID インタフェース内 PFComponent
    
    パラメータ:
    
    id - 設定するコンポーネントID
  - getComponentString
```
public java.lang.String getComponentString()
```
    コンポーネントの文字列表現を取得する。
    形式："Component Name" [ ID : "ID" ]
    
    定義:
    
    getComponentString インタフェース内 PFComponent
    
    戻り値:
    
    文字列表現
  - getComponentPublicName
```
public java.lang.String getComponentPublicName()
```
    コンポーネント公開名を取得する.
    
    定義:
    
    getComponentPublicName インタフェース内 PFComponent
    
    戻り値:
    
    コンポーネント公開名
  - setComponentPublicName
```
public void setComponentPublicName(java.lang.String publicName)
                            throws PFComponentException
```
    コンポーネント公開名を設定する.
    空文字のみの公開名は、nullに置き換える。数字のみの公開名は許可しない。また、既存コンポーネントとの重複も認めない.
    
    定義:
    
    setComponentPublicName インタフェース内 PFComponent
    
    パラメータ:
    
    publicName - 設定するコンポーネント公開名
    
    例外:
    
    PFComponentException - 規約に反する名前が設定されようとした場合
  - isAllowRemoteInvocation
```
public boolean isAllowRemoteInvocation()
```
    他PFからのコンポーネント連携要求に対する可否属性を取得する.
    
    定義:
    
    isAllowRemoteInvocation インタフェース内 PFComponent
    
    戻り値:
    
    コンポーネント連携要求可否属性
  - setAllowRemoteInvocation
```
public void setAllowRemoteInvocation(boolean flag)
```
    他PFからのコンポーネント連携要求に対する可否属性を設定する.
    
    定義:
    
    setAllowRemoteInvocation インタフェース内 PFComponent
    
    パラメータ:
    
    flag - コンポーネント連携要求に対する可否
  - isAllowPullTransfer
```
public boolean isAllowPullTransfer()
```
    他PFからのPull型コンポーネント転送要求に対する可否属性を取得する.
    
    定義:
    
    isAllowPullTransfer インタフェース内 PFComponent
    
    戻り値:
    
    Pull型コンポーネント転送要求可否属性
  - setAllowPullTransfer
```
public void setAllowPullTransfer(boolean flag)
```
    他PFからのPull型コンポーネント転送要求に対する可否属性を設定する.
    
    定義:
    
    setAllowPullTransfer インタフェース内 PFComponent
    
    パラメータ:
    
    flag - Pull型コンポーネント転送要求に対する可否
  - isAllowPushTransfer
```
public boolean isAllowPushTransfer()
```
    他PFへのPush型コンポーネント転送要求に対する可否属性を取得する.
    
    定義:
    
    isAllowPushTransfer インタフェース内 PFComponent
    
    戻り値:
    
    Push型コンポーネント転送要求可否属性
  - setAllowPushTransfer
```
public void setAllowPushTransfer(boolean flag)
```
    他PFへのPush型コンポーネント転送要求に対する可否属性を設定する.
    
    定義:
    
    setAllowPushTransfer インタフェース内 PFComponent
    
    パラメータ:
    
    flag - Push型コンポーネント転送要求に対する可否
  - localeUpdated
```
public void localeUpdated()
```
    ロケール変更に対応する。
    
    定義:
    
    localeUpdated インタフェース内 PFComponent
  - setEqualFilter
```
public void setEqualFilter(java.lang.String key,
                           java.lang.Object value)
```
    キーに紐付く値が指示した値と一致するドキュメントを検索するフィルタを設定する。比較する値は比較されるデータの型と一致するラッパークラスのオブジェクトである必要がある。アプリケーションビルダで定数として指定した場合はすべて文字列型として解釈されるので注意。
    
    パラメータ:
    
    key - 比較するキー名
    
    value - 比較する値
  - setGreaterThanFilter
```
public void setGreaterThanFilter(java.lang.String key,
                                 java.lang.Object value)
```
    キーに紐付く値が指示した値より大きいドキュメントを検索するフィルタを設定する。比較する値は比較されるデータの型と一致するラッパークラスのオブジェクトである必要がある。アプリケーションビルダで定数として指定した場合はすべて文字列型として解釈されるので注意。
    
    パラメータ:
    
    key - 比較するキー名
    
    value - 比較する値
  - setLessThanFilter
```
public void setLessThanFilter(java.lang.String key,
                              java.lang.Object value)
```
    キーに紐付く値が指示した値より小さいドキュメントを検索するフィルタを設定する。比較する値は比較されるデータの型と一致するラッパークラスのオブジェクトである必要がある。アプリケーションビルダで定数として指定した場合はすべて文字列型として解釈されるので注意。
    
    パラメータ:
    
    key - 比較するキー名
    
    value - 比較する値
  - setGreaterThanEqualFilter
```
public void setGreaterThanEqualFilter(java.lang.String key,
                                      java.lang.Object value)
```
    キーに紐付く値が指示した値以上であるドキュメントを検索するフィルタを設定する。比較する値は比較されるデータの型と一致するラッパークラスのオブジェクトである必要がある。アプリケーションビルダで定数として指定した場合はすべて文字列型として解釈されるので注意。
    
    パラメータ:
    
    key - 比較するキー名
    
    value - 比較する値
  - setLessThanEqualFilter
```
public void setLessThanEqualFilter(java.lang.String key,
                                   java.lang.Object value)
```
    キーに紐付く値が指示した値以下であるドキュメントを検索するフィルタを設定する。比較する値は比較されるデータの型と一致するラッパークラスのオブジェクトである必要がある。アプリケーションビルダで定数として指定した場合はすべて文字列型として解釈されるので注意。
    
    パラメータ:
    
    key - 比較するキー名
    
    value - 比較する値
  - setNotEqualFilter
```
public void setNotEqualFilter(java.lang.String key,
                              java.lang.Object value)
```
    キーに紐付く値が指示した値と一致しないドキュメントを検索するフィルタを設定する。比較する値は比較されるデータの型と一致するラッパークラスのオブジェクトである必要がある。アプリケーションビルダで定数として指定した場合はすべて文字列型として解釈されるので注意。
    
    パラメータ:
    
    key - 比較するキー名
    
    value - 比較する値
  - setNorFilter
```
public void setNorFilter(PFMongoFilter filter1,
                         PFMongoFilter filter2)
```
    2つのフィルタをNOR条件で結合したフィルタを設定する。
    
    パラメータ:
    
    filter1 - フィルタ1
    
    filter2 - フィルタ2
  - setOrFilter
```
public void setOrFilter(PFMongoFilter filter1,
                        PFMongoFilter filter2)
```
    2つのフィルタをOR条件で結合したフィルタを設定する。
    
    パラメータ:
    
    filter1 - フィルタ1
    
    filter2 - フィルタ2
  - setOrFilter
```
public void setOrFilter(PFObjectList filterList)
```
    複数のフィルタをOR条件で結合したフィルタを設定する。
    
    パラメータ:
    
    filterList - フィルタのリスト
  - setAndFilter
```
public void setAndFilter(PFMongoFilter filter1,
                         PFMongoFilter filter2)
```
    2つのフィルタをAND条件で結合したフィルタを設定する。
    
    パラメータ:
    
    filter1 - フィルタ1
    
    filter2 - フィルタ2
  - setAndFilter
```
public void setAndFilter(PFObjectList filterList)
```
    複数のフィルタをAND条件で結合したフィルタを設定する。
    
    パラメータ:
    
    filterList - フィルタのリスト
  - setInFilter
```
public void setInFilter(java.lang.String key,
                        PFObjectList filterList)
```
    キーに紐付く値が値リストの中のいずれかの値と一致するドキュメントを検索するフィルタを設定する。比較する値は比較されるデータの型と一致するラッパークラスのオブジェクトである必要がある。アプリケーションビルダで定数として指定した場合はすべて文字列型として解釈されるので注意。
    
    パラメータ:
    
    key - 比較するキー名
    
    filterList - 比較する値リスト
  - setNinFilter
```
public void setNinFilter(java.lang.String key,
                         PFObjectList filterList)
```
    キーに紐付く値が値リストの中のどの値とも一致しないドキュメントを検索するフィルタを設定する。比較する値は比較されるデータの型と一致するラッパークラスのオブジェクトである必要がある。アプリケーションビルダで定数として指定した場合はすべて文字列型として解釈されるので注意。
    
    パラメータ:
    
    key - 比較するキー名
    
    filterList - 比較する値リスト
  - addEqualFilter
```
public void addEqualFilter(java.lang.String key,
                           java.lang.Object value)
```
    現在のフィルタに、キーに紐付く値が指示した値と一致するドキュメントを検索するフィルタをAND条件で追加する。比較する値は比較されるデータの型と一致するラッパークラスのオブジェクトである必要がある。アプリケーションビルダで定数として指定した場合はすべて文字列型として解釈されるので注意。
    
    パラメータ:
    
    key - 比較するキー名
    
    value - 比較する値
  - addGreaterThanFilter
```
public void addGreaterThanFilter(java.lang.String key,
                                 java.lang.Object value)
```
    現在のフィルタに、キーに紐付く値が指示した値より大きいドキュメントを検索するフィルタをAND条件で追加する。比較する値は比較されるデータの型と一致するラッパークラスのオブジェクトである必要がある。アプリケーションビルダで定数として指定した場合はすべて文字列型として解釈されるので注意。
    
    パラメータ:
    
    key - 比較するキー名
    
    value - 比較する値
  - addLessThanFilter
```
public void addLessThanFilter(java.lang.String key,
                              java.lang.Object value)
```
    現在のフィルタに、キーに紐付く値が指示した値より小さいドキュメントを検索するフィルタをAND条件で追加する。比較する値は比較されるデータの型と一致するラッパークラスのオブジェクトである必要がある。アプリケーションビルダで定数として指定した場合はすべて文字列型として解釈されるので注意。
    
    パラメータ:
    
    key - 比較するキー名
    
    value - 比較する値
  - addGreaterThanEqualFilter
```
public void addGreaterThanEqualFilter(java.lang.String key,
                                      java.lang.Object value)
```
    現在のフィルタに、キーに紐付く値が指示した値以上であるドキュメントを検索するフィルタをAND条件で追加する。比較する値は比較されるデータの型と一致するラッパークラスのオブジェクトである必要がある。アプリケーションビルダで定数として指定した場合はすべて文字列型として解釈されるので注意。
    
    パラメータ:
    
    key - 比較するキー名
    
    value - 比較する値
  - addLessThanEqualFilter
```
public void addLessThanEqualFilter(java.lang.String key,
                                   java.lang.Object value)
```
    現在のフィルタに、キーに紐付く値が指示した値以下であるドキュメントを検索するフィルタをAND条件で追加する。比較する値は比較されるデータの型と一致するラッパークラスのオブジェクトである必要がある。アプリケーションビルダで定数として指定した場合はすべて文字列型として解釈されるので注意。
    
    パラメータ:
    
    key - 比較するキー名
    
    value - 比較する値
  - addNotEqualFilter
```
public void addNotEqualFilter(java.lang.String key,
                              java.lang.Object value)
```
    現在のフィルタに、キーに紐付く値が指示した値と一致しないドキュメントを検索するフィルタをAND条件で追加する。比較する値は比較されるデータの型と一致するラッパークラスのオブジェクトである必要がある。アプリケーションビルダで定数として指定した場合はすべて文字列型として解釈されるので注意。
    
    パラメータ:
    
    key - 比較するキー名
    
    value - 比較する値
  - getBsonDocument
```
public Bson getBsonDocument()
```
    フィルタのBSONドキュメントを取得する。
    
    戻り値:
    
    BSONドキュメント
  - toString
```
public java.lang.String toString()
```
    オーバーライド:
    
    toString クラス内 java.lang.Object
  - writeXML
```
public void writeXML(PFXMLGenerator out)
              throws java.io.IOException
```
    XMLを出力する.
    
    定義:
    
    writeXML インタフェース内 PFXMLSerializable
    
    パラメータ:
    
    out - XML出力ユーティリティ
    
    例外:
    
    java.io.IOException
  - readXML
```
public void readXML(PFXMLLoader in)
```
    XMLを入力する.
    
    定義:
    
    readXML インタフェース内 PFXMLSerializable
    
    パラメータ:
    
    in - XML入力ユーティリティ

クラス PFMongoFilter

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

メソッドのサマリー

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

コンストラクタの詳細

PFMongoFilter

メソッドの詳細

getComponentName

getComponentKey

setComponentKey

getComponentKeys

setComponentKeys

getComponentID

setComponentID

getComponentString

getComponentPublicName

setComponentPublicName

isAllowRemoteInvocation

setAllowRemoteInvocation

isAllowPullTransfer

setAllowPullTransfer

isAllowPushTransfer

setAllowPushTransfer

localeUpdated

setEqualFilter

setGreaterThanFilter

setLessThanFilter

setGreaterThanEqualFilter

setLessThanEqualFilter

setNotEqualFilter

setNorFilter

setOrFilter

setOrFilter

setAndFilter

setAndFilter

setInFilter

setNinFilter

addEqualFilter

addGreaterThanFilter

addLessThanFilter

addGreaterThanEqualFilter

addLessThanEqualFilter

addNotEqualFilter

getBsonDocument

toString

writeXML

readXML