IndexFactoryBean (Spring Data for Pivotal GemFire 2.2.13.RELEASE API)

java.lang.ObjectSE
- org.springframework.data.gemfire.support.AbstractFactoryBeanSupport<org.apache.geode.cache.query.Index>
- - org.springframework.data.gemfire.IndexFactoryBean

実装済みのインターフェース一覧:
Aware, BeanClassLoaderAware, BeanFactoryAware, BeanNameAware, FactoryBean<org.apache.geode.cache.query.Index>, InitializingBean
```
public class IndexFactoryBean
extends AbstractFactoryBeanSupport<org.apache.geode.cache.query.Index>
implements InitializingBean
```
Spring FactoryBean は、宣言的なアプローチを使用して Indexes を構築、構成、初期化するために使用されます。
導入:
1.0.0
作成者:
Costin Leau, David Turanski, John Blum
関連事項:
Region、RegionService、Index、QueryService, FactoryBean, InitializingBean, ConfigurableBeanFactory, IndexFactoryBean.IndexWrapper, IndexConfigurer, AbstractFactoryBeanSupport

ネストされたクラスの概要
ネストされたクラス
修飾子と型クラスと説明
protected static class IndexFactoryBean.IndexWrapper

ネストされたクラス
修飾子と型	クラスと説明
`protected static class`	`IndexFactoryBean.IndexWrapper`

フィールド概要
フィールド
修飾子と型フィールドと説明
static StringSE BASIC_INDEX_DEFINITION
static StringSE DETAILED_INDEX_DEFINITION
- クラス org.springframework.data.gemfire.support.AbstractFactoryBeanSupport から継承されたフィールド
  DEFAULT_SINGLETON
- インターフェース org.springframework.beans.factory.FactoryBean から継承されたフィールド
  OBJECT_TYPE_ATTRIBUTE

フィールド
修飾子と型	フィールドと説明
`static StringSE`	`BASIC_INDEX_DEFINITION`
`static StringSE`	`DETAILED_INDEX_DEFINITION`

コンストラクター概要
コンストラクター
コンストラクターと説明
IndexFactoryBean()

コンストラクター
コンストラクターと説明
`IndexFactoryBean()`

方法の概要

すべてのメソッドインスタンスメソッド具象メソッド
修飾子と型	メソッドと説明
`void`	`afterPropertiesSet()`
`protected void`	`applyIndexConfigurers(StringSE indexName, IndexConfigurer... indexConfigurers)` 指定された `IndexConfigurers` の配列をこの `IndexFactoryBean` に適用する null セーフな操作。
`protected void`	`applyIndexConfigurers(StringSE indexName, IterableSE<IndexConfigurer> indexConfigurers)` 指定された `Iterable`SE または `IndexConfigurers` をこの `IndexFactoryBean` に適用する null セーフ操作。
`protected IndexConfigurer`	`getCompositeRegionConfigurer()` Spring コンテナーの初期化時にこの `IndexFactoryBean` に追加構成を適用するために使用される複合 `IndexConfigurer` への参照を返します。
`org.apache.geode.cache.query.Index`	`getIndex()` この `IndexFactoryBean` によって作成された `Index` への参照を返します。
`org.apache.geode.cache.query.Index`	`getObject()`
`ClassSE<?>`	`getObjectType()`
`protected boolean`	`isDefine()` この `IndexFactoryBean` によって宣言および定義された `Index` が最初にのみ定義されるか、定義されて作成されるかを示すブール値を返します。
`boolean`	`isIgnoreIfExists()` `IndexExistsException` または `IndexNameConflictException` がスローされたときに、この `IndexFactoryBean` によって定義された `Index` を無視するかどうかを決定します。
`boolean`	`isOverride()` この `IndexFactoryBean` によって作成される `Index` と同じ定義だが名前が異なる既存の `Index` をオーバーライドするかどうかを決定します。
`void`	`setCache(org.apache.geode.cache.RegionService cache)` `RegionService` への参照を設定します。
`void`	`setDefine(boolean define)` この `IndexFactoryBean` によって宣言および定義された `Index` が最初にのみ定義されるか、定義されて作成されるかを示すブール条件を設定します。
`void`	`setExpression(StringSE expression)`
`void`	`setFrom(StringSE from)`
`void`	`setIgnoreIfExists(boolean ignore)` `IndexExistsException` または `IndexNameConflictException` がスローされたときに、この `IndexFactoryBean` によって定義された `Index` を無視するかどうかを構成します。
`void`	`setImports(StringSE imports)`
`void`	`setIndexConfigurers(IndexConfigurer... indexConfigurers)` アノテーションベースの構成を使用する場合に、この `IndexFactoryBean` に追加の構成を適用するために使用される `IndexConfigurers` の配列を設定する null セーフ操作。
`void`	`setIndexConfigurers(ListSE<IndexConfigurer> indexConfigurers)` アノテーションベースの構成を使用するときに、この `IndexFactoryBean` に追加の構成を適用するために使用される `IndexConfigurers` の `Iterable`SE を設定するための null セーフ操作。
`void`	`setName(StringSE name)` `Index` の名前を設定します。
`void`	`setOverride(boolean override)` この `IndexFactoryBean` によって作成される `Index` と同じ定義だが名前が異なる既存の `Index` をオーバーライドするかどうかを構成します。
`void`	`setQueryService(org.apache.geode.cache.query.QueryService service)` `Index` を作成するために使用される `QueryService` を設定します。
`void`	`setType(IndexType type)` `Index` の `type` を設定します。
`void`	`setType(StringSE type)` `Index` の `type` を `String`SE として設定します。

クラス org.springframework.data.gemfire.support.AbstractFactoryBeanSupport から継承されたメソッド
getBeanClassLoader, getBeanFactory, getBeanName, getLog, isSingleton, logDebug, logDebug, logError, logError, logInfo, logInfo, logWarning, logWarning, newLog, setBeanClassLoader, setBeanFactory, setBeanName

クラス java.lang.ObjectSE から継承されたメソッド
cloneSE, equalsSE, finalizeSE, getClassSE, hashCodeSE, notifySE, notifyAllSE, toStringSE, waitSE, waitSE, waitSE

- フィールドの詳細
  - BASIC_INDEX_DEFINITION
```
public static final StringSE BASIC_INDEX_DEFINITION
```
    関連事項:
    定数フィールド値
  - DETAILED_INDEX_DEFINITION
```
public static final StringSE DETAILED_INDEX_DEFINITION
```
    関連事項:
    定数フィールド値
- コンストラクターの詳細
  - IndexFactoryBean
```
public IndexFactoryBean()
```
- メソッドの詳細
  - afterPropertiesSet
```
public void afterPropertiesSet()
                        throws ExceptionSE
```
    次で指定:
    インターフェース InitializingBean 内の afterPropertiesSet
    例外:
    ExceptionSE
  - applyIndexConfigurers
```
protected void applyIndexConfigurers(StringSE indexName,
                                     IndexConfigurer... indexConfigurers)
```
    指定された IndexConfigurers の配列をこの IndexFactoryBean に適用する null セーフな操作。
    パラメーター:
    indexName - Index の名前を含む StringSE。
    indexConfigurers - この IndexFactoryBean に適用される IndexConfigurers の配列。
    関連事項:
    RegionConfigurer, applyIndexConfigurers(String, Iterable)
  - applyIndexConfigurers
```
protected void applyIndexConfigurers(StringSE indexName,
                                     IterableSE<IndexConfigurer> indexConfigurers)
```
    指定された IterableSE または IndexConfigurers をこの IndexFactoryBean に適用する null セーフ操作。
    パラメーター:
    indexName - Index の名前を含む StringSE。
    indexConfigurers - この IndexFactoryBean には IterableSE または IndexConfigurers が適用されます。
    関連事項:
    RegionConfigurer
  - getCompositeRegionConfigurer
```
protected IndexConfigurer getCompositeRegionConfigurer()
```
    Spring コンテナーの初期化時にこの IndexFactoryBean に追加構成を適用するために使用される複合 IndexConfigurer への参照を返します。
    戻り値:
    コンポジット IndexConfigurer。
    関連事項:
    IndexConfigurer
  - getIndex
```
public org.apache.geode.cache.query.Index getIndex()
```
    この IndexFactoryBean によって作成された Index への参照を返します。
    戻り値:
    この IndexFactoryBean によって作成された Index への参照。
    関連事項:
    Index
  - getObject
```
public org.apache.geode.cache.query.Index getObject()
```
    次で指定:
    インターフェース FactoryBean<org.apache.geode.cache.query.Index> 内の getObject
  - getObjectType
```
public ClassSE<?> getObjectType()
```
    次で指定:
    インターフェース FactoryBean<org.apache.geode.cache.query.Index> 内の getObjectType
  - setCache
```
public void setCache(org.apache.geode.cache.RegionService cache)
```
    RegionService への参照を設定します。
    パラメーター:
    cache - RegionService への参照。
    関連事項:
    RegionService
  - setName
```
public void setName(StringSE name)
```
    Index の名前を設定します。
    パラメーター:
    name - StringSE には、Index に付けられた名前が含まれています。
  - setQueryService
```
public void setQueryService(org.apache.geode.cache.query.QueryService service)
```
    Index を作成するために使用される QueryService を設定します。
    パラメーター:
    service - QueryService は Index を作成するために使用されます。
    関連事項:
    QueryService
  - setDefine
```
public void setDefine(boolean define)
```
    この IndexFactoryBean によって宣言および定義された Index が最初にのみ定義されるか、定義されて作成されるかを示すブール条件を設定します。定義のみの場合、IndexFactoryBean は Spring コンテナーのライフサイクルの終了時にコールバックを受信し、その後、1 回の操作ですべての「定義のみ」の Indexes を 1 回「作成」します。
    パラメーター:
    define - 定義または定義 / 作成ステータスを示すブール値。true の場合、この IndexFactoryBean によって宣言された Index は最初にのみ定義され、その後、この Bean が Spring コンテナーから適切なコールバックを受け取ったときに作成されます。false の場合、Index はすぐに作成されます。
  - isDefine
```
protected boolean isDefine()
```
    この IndexFactoryBean によって宣言および定義された Index が最初にのみ定義されるか、定義されて作成されるかを示すブール値を返します。定義のみの場合、IndexFactoryBean は Spring コンテナーのライフサイクルの終了時にコールバックを受信し、その後、1 回の操作ですべての「定義のみ」の Indexes を 1 回「作成」します。
    戻り値:
    定義または定義 / 作成ステータスを示すブール値。true の場合、この IndexFactoryBean によって宣言された Index は最初にのみ定義され、その後、この Bean が Spring コンテナーから適切なコールバックを受け取ったときに作成されます。false の場合、Index はすぐに作成されます。
  - setExpression
```
public void setExpression(StringSE expression)
```
    パラメーター:
    expression - 設定するインデックス式
  - setFrom
```
public void setFrom(StringSE from)
```
    パラメーター:
    from - 句からセットまでのインデックス
  - setImports
```
public void setImports(StringSE imports)
```
    パラメーター:
    imports - 設定するインデックスインポート
  - setIgnoreIfExists
```
public void setIgnoreIfExists(boolean ignore)
```
    IndexExistsException または IndexNameConflictException がスローされたときに、この IndexFactoryBean によって定義された Index を無視するかどうかを構成します。同じ定義だが名前が異なる別の Index が存在する場合、IndexExistsException がスローされます。同じ名前だが定義が異なる可能性のある別の Index が存在する場合、IndexNameConflictException がスローされます。ignoreIfExists が true に設定され、IndexExistsException がスローされた場合、既存の Index がこの IndexFactoryBean 作成のオブジェクトとして返され、既存の Index の名前がこの Bean のエイリアスとして追加されます。ignoreIfExists が true に設定され、IndexNameConflictException がスローされた場合、既存の Index がこの IndexFactoryBean 作成のオブジェクトとして返されます。この IndexFactoryBean と既存の Index の定義が異なる場合は、警告が記録されます。ignoreIfExists は override よりも優先されます。デフォルトは false です。
    パラメーター:
    ignore - この IndexFactoryBean によって定義された Index を無視するかどうかを示すブール値。デフォルトは false です。
    関連事項:
    setOverride(boolean)
  - isIgnoreIfExists
```
public boolean isIgnoreIfExists()
```
    IndexExistsException または IndexNameConflictException がスローされたときに、この IndexFactoryBean によって定義された Index を無視するかどうかを決定します。同じ定義だが名前が異なる別の Index が存在する場合、IndexExistsException がスローされます。同じ名前だが定義が異なる可能性のある別の Index が存在する場合、IndexNameConflictException がスローされます。ignoreIfExists が true に設定され、IndexExistsException がスローされた場合、既存の Index がこの IndexFactoryBean 作成のオブジェクトとして返され、既存の Index の名前がこの Bean のエイリアスとして追加されます。ignoreIfExists が true に設定され、IndexNameConflictException がスローされた場合、既存の Index がこの IndexFactoryBean 作成のオブジェクトとして返されます。この IndexFactoryBean と既存の Index の定義が異なる場合は、警告が記録されます。ignoreIfExists は override よりも優先されます。デフォルトは false です。
    戻り値:
    この IndexFactoryBean によって定義された Index を無視するかどうかを示すブール値。デフォルトは false です。
    関連事項:
    setIgnoreIfExists(boolean)
  - setIndexConfigurers
```
public void setIndexConfigurers(IndexConfigurer... indexConfigurers)
```
    アノテーションベースの構成を使用する場合に、この IndexFactoryBean に追加の構成を適用するために使用される IndexConfigurers の配列を設定する null セーフ操作。
    パラメーター:
    indexConfigurers - この IndexFactoryBean に追加の構成を適用するために使用される IndexConfigurers の配列。
    関連事項:
    IndexConfigurer, setIndexConfigurers(List)
  - setIndexConfigurers
```
public void setIndexConfigurers(ListSE<IndexConfigurer> indexConfigurers)
```
    アノテーションベースの構成を使用するときに、この IndexFactoryBean に追加の構成を適用するために使用される IndexConfigurers の IterableSE を設定するための null セーフ操作。
    パラメーター:
    indexConfigurers - IndexConfigurers の IterableSE は、この IndexFactoryBean に追加の構成を適用するために使用されます。
    関連事項:
    IndexConfigurer
  - setOverride
```
public void setOverride(boolean override)
```
    この IndexFactoryBean によって作成される Index と同じ定義だが名前が異なる既存の Index をオーバーライドするかどうかを設定します。同じ定義だが名前が異なる別の Index が存在する場合、IndexExistsException がスローされます。同じ名前だがおそらく定義が異なる別の Index が存在する場合、IndexNameConflictException がスローされます。オーバーライドを true に設定すると、IndexExistsException がスローされると、オーバーライドは実質的に既存の Index の名前を変更するのと同じになります。つまり、既存の Index は removed になり、同じ定義を持つ新しい name でこの IndexFactoryBean によって再作成されます。オーバーライドを true に設定すると、IndexNameConflictException がスローされると、既存の Index をオーバーライドすることは、既存の Index 定義を変更することと同じです。これが発生すると、警告がログに記録されます。既存の Index 定義が同じ場合、オーバーライドすると実質的に Index が再構築されます。ignoreIfExists は override よりも優先されます。デフォルトは false です。
    パラメーター:
    override - 既存の Index がこの IndexFactoryBean によって削除され、再作成されるかどうかを示すブール値。デフォルトは false です。
    関連事項:
    setIgnoreIfExists(boolean)
  - isOverride
```
public boolean isOverride()
```
    この IndexFactoryBean によって作成される Index と同じ定義だが名前が異なる既存の Index をオーバーライドするかどうかを決定します。同じ定義だが名前が異なる別の Index が存在する場合、IndexExistsException がスローされます。同じ名前だが定義が異なる可能性のある別の Index が存在する場合、IndexNameConflictException がスローされます。オーバーライドが true に設定されている場合、IndexExistsException がスローされると、オーバーライドは実質的に既存の Index の名前を変更することと同じです。つまり、既存の Index は removed になり、同じ定義を持つ新しい name でこの IndexFactoryBean によって再作成されます。オーバーライドが true に設定されている場合、IndexNameConflictException がスローされると、既存の Index をオーバーライドすることは、既存の Index 定義を変更することと同じです。これが発生すると、警告がログに記録されます。既存の Index 定義が同じ場合、オーバーライドすると実質的に Index が再構築されます。ignoreIfExists は override よりも優先されます。デフォルトは false です。
    戻り値:
    既存の Index がこの IndexFactoryBean によって削除され、再作成されるかどうかを示すブール値。デフォルトは false です。
    関連事項:
    setOverride(boolean)
  - setType
```
public void setType(StringSE type)
```
    Index の type を StringSE として設定します。
    パラメーター:
    type - Index の type を指定する StringSE。
    関連事項:
    IndexType.valueOf(String), setType(IndexType)
  - setType
```
public void setType(IndexType type)
```
    Index の type を設定します。
    パラメーター:
    type - Index の型を示す IndexType。
    関連事項:
    IndexType

クラス IndexFactoryBean

ネストされたクラスの概要

フィールド概要

クラス org.springframework.data.gemfire.support.AbstractFactoryBeanSupport から継承されたフィールド

インターフェース org.springframework.beans.factory.FactoryBean から継承されたフィールド

コンストラクター概要

方法の概要

クラス org.springframework.data.gemfire.support.AbstractFactoryBeanSupport から継承されたメソッド

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

フィールドの詳細

BASIC_INDEX_DEFINITION

DETAILED_INDEX_DEFINITION

コンストラクターの詳細

IndexFactoryBean

メソッドの詳細

afterPropertiesSet

applyIndexConfigurers

applyIndexConfigurers

getCompositeRegionConfigurer

getIndex

getObject

getObjectType

setCache

setName

setQueryService

setDefine

isDefine

setExpression

setFrom

setImports

setIgnoreIfExists

isIgnoreIfExists

setIndexConfigurers

setIndexConfigurers

setOverride

isOverride

setType

setType