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

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

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

java.io.Serializable, PFComponent, PFXMLSerializable
```
public class PFMongoSortCondition
extends java.lang.Object
implements PFComponent, PFXMLSerializable
```
mongodb検索時に使用するソート条件のコンポーネント。

バージョン:

1.0

関連項目:

直列化された形式

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

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

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

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

メソッドのサマリー

すべてのメソッドインスタンス・メソッド concreteメソッド
修飾子とタイプ	メソッドと説明
`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`	`setAscendingSort(PFObjectList keys)` 指定されたキー配列の順での昇順ソートを設定する。
`void`	`setAscendingSort(java.lang.String key)` 指定されたキーでの昇順ソートを設定する。
`void`	`setComponentID(int id)` コンポーネントIDを設定する。
`void`	`setComponentKey(java.lang.String key)` コンポーネントキーを設定する。
`void`	`setComponentKeys(PFMultiLocaleString keys)` 全ロケール分のコンポーネントキーを設定する。
`void`	`setComponentPublicName(java.lang.String publicName)` コンポーネント公開名を設定する.
`void`	`setDescendingSort(PFObjectList keys)` 指定されたキー配列の順での降順ソートを設定する。
`void`	`setDescendingSort(java.lang.String key)` 指定されたキーでの降順ソートを設定する。
`void`	`setOrderBySort(PFObjectList sorts)` 指定されたソート条件配列の順に従って組み合わせソートを設定する。
`java.lang.String`	`toString()`
`void`	`writeXML(PFXMLGenerator out)` XMLを出力する.

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

- コンストラクタの詳細
  - PFMongoSortCondition
```
public PFMongoSortCondition()
```
    コンポーネントを生成する。
- メソッドの詳細
  - 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
  - setAscendingSort
```
public void setAscendingSort(java.lang.String key)
```
    指定されたキーでの昇順ソートを設定する。
    
    パラメータ:
    
    key - ソート対象となるキー名
  - setAscendingSort
```
public void setAscendingSort(PFObjectList keys)
```
    指定されたキー配列の順での昇順ソートを設定する。
    
    パラメータ:
    
    keys - ソート対象となるキー名
  - setDescendingSort
```
public void setDescendingSort(java.lang.String key)
```
    指定されたキーでの降順ソートを設定する。
    
    パラメータ:
    
    key - ソート対象となるキー名
  - setDescendingSort
```
public void setDescendingSort(PFObjectList keys)
```
    指定されたキー配列の順での降順ソートを設定する。
    
    パラメータ:
    
    keys - ソート対象となるキー名
  - setOrderBySort
```
public void setOrderBySort(PFObjectList sorts)
```
    指定されたソート条件配列の順に従って組み合わせソートを設定する。
    
    パラメータ:
    
    sorts - ソート対象となるキー名
  - 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入力ユーティリティ

クラス PFMongoSortCondition

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

メソッドのサマリー

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

コンストラクタの詳細

PFMongoSortCondition

メソッドの詳細

getComponentName

getComponentKey

setComponentKey

getComponentKeys

setComponentKeys

getComponentID

setComponentID

getComponentString

getComponentPublicName

setComponentPublicName

isAllowRemoteInvocation

setAllowRemoteInvocation

isAllowPullTransfer

setAllowPullTransfer

isAllowPushTransfer

setAllowPushTransfer

localeUpdated

setAscendingSort

setAscendingSort

setDescendingSort

setDescendingSort

setOrderBySort

getBsonDocument

toString

writeXML

readXML