Oracle® Fusion Middleware Oracle WebCenter Captureのためのスクリプトの開発 11g リリース1 (11.1.1) E51442-01 |
|
前 |
次 |
この章では、クライアント用のスクリプト作成について説明します。スクリプトは、クライアント・イベントに対するフックとなります。
ユーザーが作成したクライアント・スクリプトが実行されるのは、特定のCaptureクライアント・イベントがトリガーされたときです。フレームワークによって、スクリプト作成のためのファクトリ・インタフェースと、拡張の構成および起動のための拡張プロバイダ・インタフェースが定義されます。拡張プロバイダのこの実装によって、JavaScriptを使用したカスタマイズが可能になります。
この章では、次の項目について説明します。
この項では、クライアント・イベントを定義します。
BatchScanBegin
バッチへのスキャンの開始直前に発生します。
public void BatchScanBegin(BatchScanEvent event);
BatchScanComplete
バッチへのスキャンの完了時に発生します。
public void BatchScanComplete(BatchScanEvent event);
BatchSelected
バッチが選択されたときに発生します。
public void BatchSelect(BatchSelectedEvent event);
CaptureImage
イメージをスキャン・ソースからキャプチャする直前に発生します。
public void CaptureImage(ImageCaptureEvent event);
DBSearchComplete
データベース検索が完了して、結果を処理する直前に発生します。
public void DBSearchComplete(DBSearchEvent event);
DBSearchResults
データベース検索結果の処理中に発生します。
public void DBSearchResults(DBSearchEvent event);
DBSearchStart
データベース検索の直前に発生します。
public void DBSearchStart(DBSearchEvent event);
DocumentCreated
ドキュメントの作成が完了した後に発生します。
public void DocumentCreated(DocumentCreatedEvent event);
DocumentRemoved
ドキュメントの削除が完了した後に発生します。
public void DocumentRemoved(DocumentRemovedEvent event);
DocumentSelected
ドキュメントが選択されたときに発生します。
public void DocumentSelect(DocumentSelectedEvent event);
FieldGotFocus
メタデータ・フィールドが入力フォーカスを受け取ったときに発生します。
public void FieldGotFocus(FieldEvent event);
FieldLostFocus
フィールドが入力フォーカスを失ったときに発生します。
public void FieldLostFocus(FieldEvent event);
FieldProcessKey
フォーカスがメタデータ・フィールドにある状態でキー・イベントが発生したときに発生します。
public void FieldProcessKey(FieldEvent event);
PreBatchDelete
バッチを削除する直前に発生します。
public void PreBatchDelete(BatchDeleteEvent event);
PreCaptureImage
イメージがスキャン・ソースからキャプチャされる前に発生します。
public void PreCaptureImage(ImageCaptureEvent event);
PreDownloadItem
バッチ・アイテムをダウンロードする直前に発生します。
public void PreDownloadItem(DownloadItemEvent event);
PreUploadItem
バッチ・アイテムをアップロードする直前に発生します。
public void PreUploadItem(UploadItemEvent event);
PostCaptureImage
イメージがスキャン・ソースからキャプチャされた後に発生します。
public void PostCaptureImage(ImageCaptureEvent event);
PostDownloadItem
バッチ・アイテムがダウンロードされた後に発生します。
public void PostDownloadItem(DownloadItemEvent event);
PostUploadItem
バッチ・アイテムがアップロードされた後に発生します。
public void PostUploadItem(UploadItemEvent event);
RegionSelected
ドキュメント・ページでリージョンが選択されたときに発生します。
public void RegionSelected(RegionSelectedEvent event);
ScriptStart
スクリプト処理が最初に初期化されたときに発生します。
public void ScriptStart();
この項では、クライアント・イベントのクラスを定義します。
表4-1 クライアント・イベントのクラス
クラス | 説明 |
---|---|
oracle.oddc.clientextension.BatchDeleteEvent |
List<CaptureBatch> batches: 削除されるバッチのリスト。 boolean canceled: これがTrueに設定されている場合は、削除操作が取り消されます。 |
oracle.oddc.clientextension.BatchScanEvent |
CaptureBatch batch: スキャン/インポート時の新規アイテム追加先となるバッチ。 boolean canceled: これがTrueに設定されている場合は、スキャン/インポートが取り消されます。 List<File> sourceFiles: インポート・ソースを使用するときに、インポートされるファイルのリストがここに格納されます。 CaptureOperation operation: このイベントをトリガーした操作を示します。 |
oracle.oddc.clientextension.BatchSelectedEvent |
CaptureBatch batch: バッチ・ペインで選択されたバッチ。 |
oracle.oddc.clientextension.DBSearchEvent |
boolean displayHitlist: Trueに設定されている場合は、データベース参照結果が表示されます。 boolean exactMatch: Trueに設定されている場合は、検索値が完全に一致している必要があります。 String metadataID: 検索されるメタデータ・フィールドのID。 String metadataValue: 検索されるメタデータ・フィールドの値。 List<DbSearchResultRow> rowResults: 検索で返された行結果のリスト。 boolean canceled: Trueに設定されている場合は、検索が取り消されます。 |
oracle.oddc.clientextension.DocumentRemovedEvent |
CaptureDocument document: バッチから削除されるドキュメント。 |
oracle.oddc.clientextension.DocumentCreatedEvent |
CaptureDocument document: 作成されたドキュメント。 |
oracle.oddc.clientextension.DocumentSelectedEvent |
CaptureDocument document: バッチ・ペインで選択されたドキュメント。 |
oracle.oddc.clientextension.DownloadItemEvent |
CaptureItem captureItem: バッチが開かれた後は、サーバーから現在ダウンロードされているアイテムを示します。 |
oracle.fieldedit.FieldEvent |
トラバース定数
Boolean cancel: Trueに設定されている場合は、イベントが取り消されます。 DataField field: このイベントの作用対象のフィールド。 KeyEvent keyEvent: このイベントの生成に使用されたキーボード・イベント。 int traversalDirection: フィールド・フォーカスが移動する方向を示します(「トラバース定数」を参照)。 |
ice.core.ImageCaptureEvent |
boolean cancel: これがTrueに設定されている場合は、キャプチャ操作が取り消されます。 Integer imageCount: キャプチャ済のイメージの数を示します。 String imageFileName: ローカルで保存されたイメージのファイル名を示します。 Integer xdpi: イメージの場合に、水平方向のインチ当たりドット数を示します。 Integer ydpi: イメージの場合に、垂直方向のインチ当たりドット数を示します。 Integer brightness: イメージのキャプチャに使用される明度値。 Integer contrast: イメージのキャプチャに使用されるコントラスト値。 boolean logicalBreak: Trueに設定されている場合は、ドキュメントの開始を示します。 List<File> sourceFiles: インポート・ソースを使用するときに、インポートされるファイルのリストが格納されます。 String sourceFileName: インポート・ソースを使用するときに、インポートされるソース・ファイルの名前が格納されます。 BufferedImage image: イメージ・ファイルの場合に、BufferedImageオブジェクトが格納されます。 ImageCaptureEngine source: このイベントを作成したImageCaptureエンジン。 ImageCaptureEngine.ImageFormat imageFormat: イメージを保存する形式を示します。現在の値は、tiffG4、tiffJpegGray、tiffJpegColor、jpegGrayおよびjpegColorです。 |
oracle.oddc.clientextension.RegionSelectedEvent |
MouseEvent mouseEvent: イメージ内のリージョンの選択に使用されたMouseEvent。 Rectangle selectionRectangle: イメージ内で選択された四角形。 BufferedImage image: イメージの選択された部分が格納されているBufferedImage。 |
oracle.oddc.clientextension.UploadItemEvent |
CaptureItem captureItem: バッチがリリースされた後、サーバーに現在アップロードされているアイテムを示します。 |
この項では、クライアントのコア・クラスを定義します。
表4-2 クライアントのコア・クラス
クラス | 説明 |
---|---|
oracle.oddc.client.data.CaptureBatch |
String batchId: バッチの内部ID。 String batchName: バッチの名前。 String batchPath: このバッチの情報が格納されている場所のローカル・パス。 String createdBy: バッチを作成したユーザー。 Date createdDate: バッチが作成された日。 Int currentPriority: バッチに割り当てられた優先度。 CaptureBatchStatus currentStatus: バッチに割り当てられたステータス。 CaptureDocuments documents: バッチに含まれているドキュメント。 CaptureItems items: バッチに関連付けられたアイテム。 Date lastModifiedDate: バッチの最終更新日。 String note: バッチに割り当てられたノート。 CaptureWorkspace workspace: バッチの作成に使用されたワークスペース。 メソッド: void persist() throws BatchLockException, CaptureException: バッチ・レコードをサーバーに保存します。 |
oracle.oddc.client.data.CaptureBatchStatus |
バッチ・ステータスを定義します。 String value: ステータスの説明。 String id: ステータスの内部ID。 |
oracle.oddc.client.data.CaptureDataType |
メタデータ・フィールド定義のデータ型を定義する列挙。 値の例: NUMERIC、ALPHA、ALPHANUMERIC、DATE、FLOAT |
oracle.oddc.client.data.CaptureDocument |
このクラスには、ドキュメントのすべてのプロパティが格納されます。 DocumentType documentType: ドキュメントに割り当てられたドキュメント・プロファイル。 CaptureFields fields: ドキュメントに割り当てられたメタデータ。 String id: ドキュメントの内部ID。 CaptureDocumentPages pages: ドキュメントに含まれているページ。 CaptureBatch parentBatch: このドキュメントが含まれているバッチ。 String title: ドキュメントのタイトル。 メソッド: void persist() throws BatchLockException, CaptureException: ドキュメント、関連ドキュメント・ページおよびメタデータをサーバーに保存します。 |
oracle.oddc.client.data.CaptureDocumentPage |
ドキュメント・ページのプロパティが格納されるクラス。 String imageFilenameKey: このページのローカル・ファイル名。 String pageID: ページの内部ID。 int pageNumber: ドキュメント内でのページ番号。 CaptureDocument parentDocument: このページが含まれているドキュメント。 |
oracle.oddc.client.data.CaptureDocumentPages |
このクラスはドキュメント・ページのコレクションであり、タイプはVector<CaptureDocumentPage>です。このクラスのインスタンスからドキュメント・ページを取り出すには、Vectorのメソッドを使用します。 |
oracle.oddc.client.data.CaptureDocuments |
このクラスはドキュメントのコレクションであり、タイプはVector<CaptureDocument>です。このクラスのインスタンスからドキュメントを取り出すには、Vectorのメソッドを使用します。 |
oracle.oddc.client.CaptureErrorManager |
このクラスは、どのメッセージをログに記録するかを管理します。 Level logLevel: メッセージのログ記録に使用される最低レベル。 メソッド
|
oracle.oddc.client.data.CaptureField |
ドキュメント・メタデータ・フィールドのプロパティが格納されます。 String displayValue: このフィールドに対して表示される値。 String fieldname: フィールドの名前。 int length: フィールドの最大長。 boolean required: Trueの場合は、このフィールドが値を持つ必要があります。 String value: このフィールドの値。 |
oracle.oddc.client.data.CaptureFields |
このクラスは、メタデータ・フィールド定義のマップです。タイプはLinkedHashMap<String, CaptureField>で、マップ・キーはフィールド名です。このクラスのインスタンスからフィールドを取り出すには、LinkedHashMapのメソッドを使用します。 |
oracle.oddc.client.data.CaptureItem |
ドキュメント・ページに関連付けられているアイテム(単一のイメージまたはイメージ以外のファイル)のプロパティが格納されます。 String filename: このアイテムのファイルの名前。 CaptureBatch parentBatch: このアイテムが含まれているバッチ。 String sourceFilename: このアイテムがインポートされたものである場合に、インポート元のファイルの名前が格納されます。 |
oracle.oddc.client.data.CaptureItems |
このクラスは、キャプチャのアイテムのマップです。タイプはTreeMap<String, CaptureItem>で、マップ・キーはアイテムのファイル名です。このクラスのインスタンスからアイテムを取り出すには、TreeMapのメソッドを使用します。 |
oracle.oddc.client.CaptureStateManager |
このクラスには、クライアントの現在の状態に関連するプロパティが格納されます。このクラスのインスタンスは、キャプチャ・プロパティを介してすべてのスクリプト・イベントで使用できます。 CaptureBatch activeBatch: アクティブなバッチ。 CaptureDocument activeDocument: アクティブなドキュメント。 DocumentType activeDocumentType: アクティブなドキュメント・プロファイル。 CaptureDocumentPage activePage: アクティブなドキュメント・ページ。 ClientProfile activeProfile: アクティブなクライアント・プロファイル。 String applicationUserPath: クライアントがそのアプリケーション・データに使用するパス。 String batchesPath: クライアントがバッチ・データのキャッシュに使用するパス。 String captureSystemId: クライアントの接続先であるキャプチャ・システムのID。 String computerName: クライアントが実行されているコンピュータの名前。 String currentUser: 現在クライアントにログインしているユーザー。 CaptureErrorManager errorManager: 情報のログ記録に使用されるエラー・マネージャ・オブジェクト。 |
oracle.oddc.client.data.CaptureWorkspace |
1つのワークスペースのすべてのプロパティと操作が格納されます。 String id: ワークスペースに関連付けられている内部ID。 FieldDefinitions fieldDefinitions: このワークスペースに対して定義されているメタデータ。 String name: ワークスペースの名前。 List<CaptureBatchStatus> statuses: このワークスペースで使用可能なバッチ・ステータスのリスト。 メソッド: public DBLookupProfile getDBLookupProfile(String profileId) throws CaptureException: 指定されたデータベース参照プロファイルIDのデータベース参照プロファイルを取得します。 |
oracle.oddc.client.data.ClientProfile |
Captureワークスペース・コンソールで定義された、クライアント・プロファイルのプロパティが格納されます。 boolean alwaysDisplayHitList: Trueの場合は、データベース参照の実行後に、返された結果の数にかかわらず結果が表示されます。 boolean applyBrightness: Trueの場合は、選択されたキャプチャ・ソースに明度とコントラストの設定が適用されます。 int batchFilterDaysOldFrom: バッチの経過日数の最小値を指定するバッチ・フィルタ設定。 int batchFilterDaysOldTo: バッチの経過日数の最大値を指定するバッチ・フィルタ設定。 String batchFilterPrimarySortField: バッチ・ツリーのプライマリ・ソートに使用されるバッチ・プロパティ。 SortOrder batchFilterPrimarySortOrder: バッチ・ツリーのプライマリ・ソート順。 String batchFilterSecondarySortField: バッチ・ツリーのセカンダリ・ソートに使用されるバッチ・プロパティ。 SortOrder batchFilterSecondarySortOrder: バッチ・ツリーのセカンダリ・ソート順。 Integer batchFilterState: バッチ・フィルタに含めるバッチの状態。 String batchPrefix: このプロファイルを使用して作成されるバッチに使用されるバッチ接頭辞。 String batchProcessorID: 後処理時に使用されるバッチ・プロセッサのID。 String batchProcessorJobID: 後処理時に使用されるバッチ・プロセッサのジョブのID。 BatchVisibility batchVisibility: バッチがユーザーに対していつバッチ・ツリー内に表示されるかを指定するバッチ・フィルタ設定。 long blankByteThreshold: イメージのファイル・サイズのバイト数がblankByteThreshold未満の場合は、そのページは空白ページと見なされます。 int brightness: 選択されたキャプチャ・ソースに適用される明度。 CaptureType captureType: プロファイルがキャプチャのみか、キャプチャと索引か、索引のみかを指定します。 int contrast: 選択されたキャプチャ・ソースに適用されるコントラスト。 int dbLookupMaxRecords: 1回のデータベース参照で返されるレコードの最大数。 String dbLookupProfileId: このプロファイルで使用されるデータベース参照プロファイルのID。 ColorType defaultColor: キャプチャ時に使用されるデフォルトの色タイプ。 int defaultDpi: キャプチャ時に使用されるデフォルトのDPI。 int defaultPriority: このプロファイルから作成されたバッチにはこの優先度が割り当てられます。 String defaultStatusId: このプロファイルから作成されたバッチにはこのステータスが割り当てられます。 String description: プロファイルの説明。 |
oracle.oddc.client.data.ClientProfile (続き) |
DocumentCreationType documentCreationType: キャプチャ時に作成されるドキュメント当たりのページ数を指定します。 DocumentTypes documentTypes:このプロファイルによってバッチに割り当てることができるドキュメント・プロファイルが格納されているオブジェクト。 String id: このプロファイルに関連付けられているID。 int maxPages: イメージ以外のファイルのプレビュー・ページ制限。 String name: プロファイルの名前。 NonImageAction nonImageAction: イメージ以外のファイルに対して実行されるアクション。 String picklistRelationshipProfile: このプロファイルによって使用される依存選択リスト。 List<String> prefixes: バッチ・フィルタで使用されるバッチ接頭辞。 boolean preventDefaultColorOverride: Trueの場合、色のオーバーライドはできません。 boolean preventDefaultDpiOverride: Trueの場合、dpiのオーバーライドはできません。 List<Integer> priorities: バッチ・フィルタで使用されるバッチ優先度。 int sepByteThreshold: イメージのファイル・サイズのバイト数がsepByteThreshold未満の場合は、そのページはセパレータ・シートと見なされます。 List<String> statuses: バッチ・フィルタで使用されるバッチ・ステータス。 List<String> supportedDocumentTypes: このプロファイルがバッチに割り当てることができるドキュメント・プロファイルを表す、ドキュメント・プロファイルIDのリスト。 String workspaceId: このプロファイルが関連付けられるワークスペースのID。 String workspaceName: このプロファイルが関連付けられるワークスペースの名前。 列挙値
|
oracle.oddc.client.data.DBLookupProfile |
このクラスは、データベース参照用のプロファイルを表します。 ソート定数
メソッド
|
oracle.oddc.client.data.DBLookupResult |
このクラスは、データベース参照の結果を表します。 List<DbSearchFieldInfo> searchFieldInfoList: データベース参照で返された結果の説明である、検索フィールド情報のリスト。 List<DbSearchResultRow> searchResultRows: データベース参照で返された検索結果の行のリスト。 |
oracle.oddc.session.DbSearchResultRow |
このクラスは、データベース参照から返された結果の行の1つを表します。 List<String> results: 1つの検索結果に関連付けられている文字列値のリスト。このリスト内の値の順序は、戻りフィールドが定義されている順序と同じです。 |
oracle.oddc.session.DbSearchFieldInfo |
このクラスは、データベース参照の結果の説明であるフィールド情報を表します。 String captureIndexDefID: メタデータ・フィールドID。 String dbColumnName: データベース列の名前。 Integer dbColumnType: データベース列のタイプ。 Integer captureFieldType: メタデータ・フィールドのデータ型。 |
oracle.oddc.client.data.DocumentType |
このクラスは、ドキュメント・プロファイルを表します。ドキュメント・プロファイルでは、このタイプから作成されたドキュメントでどのメタデータ・フィールドを使用できるかを示します。 FieldDefinitions fieldDefinitions: ドキュメント・プロファイルに適用可能なメタデータ。 String id: ドキュメント・プロファイルに関連付けられている内部ID。 String name: ドキュメント・プロファイルの名前。 String description: ドキュメント・プロファイルの説明。 |
oracle.oddc.client.data.DocumentTypes |
このクラスは、ドキュメント・プロファイルのマップです。タイプはTreeMap<String, DocumentType>で、マップ・キーはドキュメント・プロファイルIDです。このクラスのインスタンスからドキュメント・プロファイルを取り出すには、TreeMapのメソッドを使用します。 |
oracle.oddc.client.data.FieldDefinition |
このクラスは、メタデータ・フィールドの定義を表します。 ClientProfile.AutoPopulateType autoPopulateType: フィールドに値を自動的に移入する方法を指定します。 CaptureDataType dataType: このフィールドのデータ型。 String defaultValue: このフィールドのデフォルト値。 boolean displayable: このフィールドをクライアントで表示するかどうかを示します。 int length: このフィールドの最大長。 String id: このフィールドの内部ID。 String name: このフィールドの名前。 String inputMask: 入力マスク。 boolean locked: フィールドがロックされている場合はTrue。 float maxValue: このフィールドの最大値。 float minValue: このフィールドの最小値。 boolean pickListCaseInsensitive: Trueの場合は、選択リストで大文字と小文字が区別されません。 String pickListID: このフィールドに関連付けられている選択リストのID。 String pickListParentFieldID: 選択リスト親フィールドのID。 String pickListSourceID: このフィールドの依存選択リストのソースID。 String profileDisplayFormat: フィールド表示時に使用される書式。 boolean required: このフィールドが値を持つことが必須かどうかを示します。 String validationExpression: このフィールドに入力された値の検証に使用される正規表現。 |
oracle.oddc.client.data.FieldDefinitions |
このクラスは、メタデータ・フィールド定義のマップです。タイプはLinkedHashMap<String, FieldDefinition>で、マップ・キーはメタデータ・フィールド定義IDです。このクラスのインスタンスからメタデータ・フィールド定義を取り出すには、LinkedHashMapのメソッドを使用します。 |
oracle.oddc.client.batchbuilder.CaptureOperation |
これは、バッチで実行されるキャプチャ操作を定義する列挙です。 値の例: Create、Append、InsertおよびReplace |
FieldEditクラスは、メタデータ値を入力するためのユーザー・インタフェース・コンポーネントです。
表4-3 クライアントのFieldEditクラス
クラス | 説明 |
---|---|
oracle.fieldedit.field.DataField |
このクラスは、FieldEditコンポーネントの単一フィールドのデータを表し、様々なフィールド・タイプのベース・クラスとなります。 String caption: フィールド・キャプション。 String fieldname: フィールド名。 Format displayFormat: フィールドの表示形式。 String inputMask: 入力マスク。 boolean lock: Trueの場合はフィールドがロックされます。 long maxLength: フィールドの最大長。 boolean required: Trueの場合、このフィールドは入力する必要があります。 String uncommittedText: フィールドの現在のテキスト。 |
oracle.fieldedit.field.DateField |
このクラスはDataFieldを拡張したものであり、日付フィールドを表します。 Date value: Dateオブジェクトで表した値。 |
oracle.fieldedit.field.FloatField |
このクラスはDataFieldを拡張したものであり、浮動小数フィールドを表します。 Float value: Floatオブジェクトで表した値。 |
oracle.fieldedit.field.IntegerField |
このクラスはDataFieldを拡張したものであり、整数フィールドを表します。 Integer value: Integerオブジェクトで表した値。 |
oracle.fieldedit.field.PicklistField |
このクラスはDataFieldを拡張したものであり、選択リスト・フィールドを表します。 boolean caseSensitive: trueの場合は、このリストの内容の大文字と小文字が区別されます。 List<PicklistEntry> pickListEntries: 選択リストのエントリのリスト。 PicklistEntry value: 選択リストの現在の値。 |
oracle.fieldedit.field.TextField |
このクラスはDataFieldを拡張したものであり、英数字フィールドを表します。 String value: フィールドの英数字値。 |
oracle.fieldedit.field.PicklistEntry |
public String getCommitValue(): 選択リスト・エントリのコミット値を返します。 public String getDisplayValue(): 選択リスト・エントリの表示値を返します。 |