BaseCrawlingJob (javadoc-all-dev 8.0.0 API)

java.lang.Object
- jp.co.intra_mart.foundation.job_scheduler.BaseJob
- - jp.co.intra_mart.foundation.contentssearch.indexing.job.BaseCrawlingJob

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

直系の既知のサブクラス:: IMBoxCrawlingJob, MatterCrawlingJob, PageCrawlingJob

public abstract class BaseCrawlingJob
extends BaseJob

ジョブスケジューラサービスから実行されるクローラジョブを実装するための基底クラスです。

全文検索サーバの更新処理には分散トランザクションの概念がないため、すべてのクローラジョブは直列で実行される必要があります。
複数のクローラジョブを実行する場合には可能な限り同一のジョブネットに登録し、そのジョブネットを同時実行禁止に設定して下さい。

複数クローラジョブが登録されたジョブネットを利用する場合、プロパティの「最適化実施フラグ」をfalseとし、
ジョブネットの最後に最適化専用のジョブ（OptmizeJob）を実行する事が推奨されます。

JobSchedulerContextからパラメータを取得するためのユーティリティメソッドが用意されています。
プロパティの設定値については、以下の通りです。

 プロパティ:
 
   プロパティ名 キー デフォルト値 備考
   クローリングタイプ crawlingType "DELTA" クローラの動作タイプを設定します。
動作タイプの種別はCrawlingTypeにて定義されています。
   コミット実施フラグ withCommit true 処理終了時に更新データを確定するかを設定します。
   最適化実施フラグ withOptimize false 処理終了時にデータの最適化をするかを設定します。
最適化処理は負荷が高いため、複数クローラを実行する際はジョブネットの最後にOptimizeJobを設定することを推奨します。
   最大セグメント数 maxSegments 1 最適化の度合いを設定します。
1に近づくほど強い最適化を行いますが、処理の所要時間が伸びます。
   検索サーバグループ名 groupName "default" 処理対象とする検索サーバグループIDを指定します。
通常はデフォルト値から変更する必要はありません。

プロパティ名	キー	デフォルト値	備考
クローリングタイプ	crawlingType	"DELTA"	クローラの動作タイプを設定します。動作タイプの種別は`CrawlingType`にて定義されています。
コミット実施フラグ	withCommit	true	処理終了時に更新データを確定するかを設定します。
最適化実施フラグ	withOptimize	false	処理終了時にデータの最適化をするかを設定します。最適化処理は負荷が高いため、複数クローラを実行する際はジョブネットの最後に`OptimizeJob`を設定することを推奨します。
最大セグメント数	maxSegments	1	最適化の度合いを設定します。 1に近づくほど強い最適化を行いますが、処理の所要時間が伸びます。
検索サーバグループ名	groupName	"default"	処理対象とする検索サーバグループIDを指定します。通常はデフォルト値から変更する必要はありません。

導入されたバージョン:: 8.0.0
バージョン:: 8.0.7

フィールドのサマリー

フィールド
修飾子とタイプ	フィールドと説明
`protected static String`	`DEFAULT_GROUP_NAME` プロパティ[検索サーバグループ名]のキー値です。
`protected static int`	`DEFAULT_MAX_SEGMENTS` プロパティ[最大セグメント数]の初期値です。
`protected static boolean`	`DEFAULT_WITH_COMMIT` プロパティ[コミット実施フラグ]の初期値です。
`protected static boolean`	`DEFAULT_WITH_OPTIMIZE` プロパティ[最適化実施フラグ]の初期値です。
`protected String`	`groupName` 検索サーバグループID
`protected static String`	`KEY_CRAWLING_TYPE` プロパティ[クローリングタイプ]のキー値です。
`protected static String`	`KEY_GROUP_NAME` プロパティ[検索サーバグループ名]のキー値です。
`protected static String`	`KEY_MAX_SEGMENTS` プロパティ[最大セグメント数]のキー値です。
`protected static String`	`KEY_WITH_COMMIT` プロパティ[コミット実施フラグ]のキー値です。
`protected static String`	`KEY_WITH_OPTIMIZE` プロパティ[最適化実施フラグ]のキー値です。

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

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

BaseCrawlingJob()

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

メソッドのサマリー

すべてのメソッドインスタンス・メソッド abstractメソッド concreteメソッド
修飾子とタイプ	メソッドと説明
`protected void`	`commit(UpdateService updateService)` コンテンツの削除・更新を確定します。
`JobResult`	`execute()` クローリング処理を実行します。
`protected void`	`executeDelete(UpdateService updateService)` コンテンツの削除処理を実装します。
`protected abstract void`	`executeDelta(UpdateService updateService)` コンテンツの作成(差分作成)処理を実装します。
`protected void`	`executeReindex(UpdateService updateService)` コンテンツの再作成処理を実装します。
`protected CrawlingType`	`getCrawlingType()` ジョブパラメータからクローリングタイプを取得します。
`protected String`	`getGroupName()` ジョブパラメータから検索サーバグループ名を取得します。
`protected String`	`getTenantId()` アカウントコンテキストからテナントIDを取得します。
`protected abstract String`	`getType()` コンテンツタイプを表す文字列を返します。
`protected UpdateService`	`getUpdateService()` 更新サービスを取得します。
`protected void`	`initialize()` クローラの初期化処理を行います。
`protected void`	`optimize(UpdateService updateService)` 登録済みコンテンツの最適化処理を行います。

クラスから継承されたメソッド jp.co.intra_mart.foundation.job_scheduler.BaseJob
canParseToBoolean, getJobContext, getParameter, getParameter, getParameterAsBoolean, getParameterAsBoolean, getParameterAsInteger, getParameterAsInteger

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

- フィールドの詳細
  - KEY_CRAWLING_TYPE
```
protected static final String KEY_CRAWLING_TYPE
```
    プロパティ[クローリングタイプ]のキー値です。
    
    関連項目:
    
    定数フィールド値
  - KEY_GROUP_NAME
```
protected static final String KEY_GROUP_NAME
```
    プロパティ[検索サーバグループ名]のキー値です。
    
    関連項目:
    
    定数フィールド値
  - KEY_WITH_COMMIT
```
protected static final String KEY_WITH_COMMIT
```
    プロパティ[コミット実施フラグ]のキー値です。
    
    関連項目:
    
    定数フィールド値
  - KEY_WITH_OPTIMIZE
```
protected static final String KEY_WITH_OPTIMIZE
```
    プロパティ[最適化実施フラグ]のキー値です。
    
    関連項目:
    
    定数フィールド値
  - KEY_MAX_SEGMENTS
```
protected static final String KEY_MAX_SEGMENTS
```
    プロパティ[最大セグメント数]のキー値です。
    
    関連項目:
    
    定数フィールド値
  - DEFAULT_WITH_COMMIT
```
protected static final boolean DEFAULT_WITH_COMMIT
```
    プロパティ[コミット実施フラグ]の初期値です。
    
    関連項目:
    
    定数フィールド値
  - DEFAULT_WITH_OPTIMIZE
```
protected static final boolean DEFAULT_WITH_OPTIMIZE
```
    プロパティ[最適化実施フラグ]の初期値です。
    
    関連項目:
    
    定数フィールド値
  - DEFAULT_GROUP_NAME
```
protected static final String DEFAULT_GROUP_NAME
```
    プロパティ[検索サーバグループ名]のキー値です。
    
    関連項目:
    
    定数フィールド値
  - DEFAULT_MAX_SEGMENTS
```
protected static final int DEFAULT_MAX_SEGMENTS
```
    プロパティ[最大セグメント数]の初期値です。
    
    関連項目:
    
    定数フィールド値
  - groupName
```
protected String groupName
```
    検索サーバグループID
- コンストラクタの詳細
  - BaseCrawlingJob
```
public BaseCrawlingJob()
```
- メソッドの詳細
  - execute
```
public JobResult execute()
                  throws JobExecuteException
```
    クローリング処理を実行します。
    ジョブの実行処理を行います。
    
    定義:
    
    execute インタフェース内 Job
    
    定義:
    
    execute クラス内 BaseJob
    
    戻り値:
    
    この実行処理の結果を返却します。null値が返却された場合は、正常終了として扱います。
    
    例外:
    
    JobExecuteException - ジョブ実行中に例外がスローされた場合、実行処理の結果がエラーとして扱います。メッセージにはスローされた例外のローカライズメッセージが使用されます。
    
    関連項目:
    
    BaseJob.execute()
  - initialize
```
protected void initialize()
                   throws JobExecuteException
```
    クローラの初期化処理を行います。
    標準実装ではなにも処理を行いません。必要に応じてオーバーライドして下さい。
    
    例外:
    
    JobExecuteException - 初期化処理に失敗した場合
  - getType
```
protected abstract String getType()
```
    コンテンツタイプを表す文字列を返します。
    
    戻り値:
    
    コンテンツタイプ
  - executeDelta
```
protected abstract void executeDelta(UpdateService updateService)
                              throws JobExecuteException
```
    コンテンツの作成(差分作成)処理を実装します。
    
    パラメータ:
    
    updateService - 更新サービス
    
    例外:
    
    JobExecuteException - コンテンツ作成処理に失敗した場合
  - executeDelete
```
protected void executeDelete(UpdateService updateService)
                      throws JobExecuteException
```
    コンテンツの削除処理を実装します。
    標準の実装では、getType()メソッドから取得したコンテンツタイプと同じタイプのコンテンツを全て削除します。
    削除処理においてコンテンツデータ以外を削除する場合には、以下の例のようにオーバライドして下さい。
```
 @Override
 protected void executeDelete(final UpdateService updateService) throws JobExecuteException {
     // コンテンツの削除
     super.executeDelete(updateService);
     // 外部データの削除
     ...
 }
 
```
    パラメータ:
    
    updateService - 更新サービス
    
    例外:
    
    JobExecuteException - コンテンツ削除処理に失敗した場合
  - executeReindex
```
protected void executeReindex(UpdateService updateService)
                       throws JobExecuteException
```
    コンテンツの再作成処理を実装します。
    標準の実装では、executeDelete(UpdateService)の実行後にexecuteDelta(UpdateService)を実行します。
    
    パラメータ:
    
    updateService - 更新サービス
    
    例外:
    
    JobExecuteException - コンテンツ再作成処理に失敗した場合
  - commit
```
protected void commit(UpdateService updateService)
               throws ContentsSearchExecutionException
```
    コンテンツの削除・更新を確定します。
    
    パラメータ:
    
    updateService - 更新サービス
    
    例外:
    
    ContentsSearchExecutionException - コミットに失敗した場合
  - optimize
```
protected void optimize(UpdateService updateService)
                 throws ContentsSearchExecutionException
```
    登録済みコンテンツの最適化処理を行います。
    
    パラメータ:
    
    updateService - 更新サービス
    
    例外:
    
    ContentsSearchExecutionException - 最適化に失敗した場合
  - getGroupName
```
protected String getGroupName()
```
    ジョブパラメータから検索サーバグループ名を取得します。
    
    戻り値:
    
    検索サーバグループ名
  - getUpdateService
```
protected UpdateService getUpdateService()
                                  throws JobExecuteException
```
    更新サービスを取得します。
    
    戻り値:
    
    更新サービス
    
    例外:
    
    JobExecuteException - 更新サービスの初期化に失敗した場合
  - getTenantId
```
protected String getTenantId()
```
    アカウントコンテキストからテナントIDを取得します。
    
    戻り値:
    
    テナントID
  - getCrawlingType
```
protected CrawlingType getCrawlingType()
                                throws InvalidParameterException
```
    ジョブパラメータからクローリングタイプを取得します。
    
    戻り値:
    
    クローリングタイプ
    
    例外:
    
    InvalidParameterException - パラメータにクローリングタイプに変換出来ない値が設定されていた場合

クラス BaseCrawlingJob

プロパティ:

フィールドのサマリー

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

メソッドのサマリー

クラスから継承されたメソッド jp.co.intra_mart.foundation.job_scheduler.BaseJob

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

フィールドの詳細

KEY_CRAWLING_TYPE

KEY_GROUP_NAME

KEY_WITH_COMMIT

KEY_WITH_OPTIMIZE

KEY_MAX_SEGMENTS

DEFAULT_WITH_COMMIT

DEFAULT_WITH_OPTIMIZE

DEFAULT_GROUP_NAME

DEFAULT_MAX_SEGMENTS

groupName

コンストラクタの詳細

BaseCrawlingJob

メソッドの詳細

execute

initialize

getType

executeDelta

executeDelete

executeReindex

commit

optimize

getGroupName

getUpdateService

getTenantId

getCrawlingType