uCosminexus DocumentBroker Version 5 リファレンス API

[目次][用語][索引][前へ][次へ]

はじめに

このマニュアルは,次に示すプログラムプロダクトで提供するDocumentBrokerクラスライブラリの詳細,インターフェースの詳細,メソッドの文法,およびメッセージの詳細についてリファレンス形式で説明したものです。

<はじめにの構成>
対象読者
マニュアルの構成
読書手順
このマニュアルで使用する記号
このマニュアルで使用する構文要素記号

対象読者

このマニュアルは,uCosminexus DocumentBroker Developerが提供するDocumentBrokerクラスライブラリを使用して,ユーザアプリケーションプログラムを開発し,システムを構築,運用および管理する方を対象にしています。なお,次の内容を理解されていることを前提としています。

マニュアルの構成

このマニュアルは,次に示す章と付録から構成されています。

第1章 DocumentBrokerの機能
DocumentBrokerクラスライブラリで実現できる機能の概要,システム構成,処理の流れなどについて説明しています。
第2章 edmSQLの文法
edmSQLの文法について説明しています。
第3章 DocumentBrokerのクラス,インターフェース,およびメソッド
DocumentBrokerのクラス,インターフェース,およびメソッドを一覧表形式で説明しています。また,DocumentBrokerクラスライブラリで提供するクラスライブラリのリファレンスマニュアルのクラス,インターフェース,およびメソッドの記述形式(ページレイアウト)について説明しています。
第4章 ファクトリクラス詳細
ファクトリクラスのクラス,インターフェース,およびメソッドについて説明しています。
第5章 パラメタクラス詳細
パラメタクラスのインターフェース,およびメソッドについて説明しています。
第6章 文書管理クラス詳細
文書管理クラスのインターフェース,およびメソッドについて説明しています。
第7章 メタクラス詳細
メタクラスのインターフェース,およびメソッドについて説明しています。
第8章 例外クラス詳細
例外クラスの詳細について説明しています。
第9章 定数定義クラス詳細
定数定義クラスの定義内容についてカテゴリごとに説明しています。
第10章 ライブラリ情報取得クラス詳細
ライブラリ情報取得クラスのクラスとそのメソッドについて説明しています。
第11章 トレースクラス詳細
トレースクラスのクラスとそのメソッドについて説明しています。
付録A このマニュアルの参考情報
関連マニュアル,このマニュアルで使用している略語の意味などを説明しています。
付録B 用語解説
DocumentBrokerクラスライブラリで使用する用語について説明しています。

読書手順

このマニュアルは,利用目的に合わせて章を選択してお読みいただけます。次に示す表を参考にして,お読みになる章を選択してください。

このマニュアルを読む目的 記述個所
DocumentBrokerクラスライブラリで実現できる機能の概要,システム構成,処理の流れなどについて知りたい 1章
edmSQLの文法について知りたい 2章
どのようなDocumentBrokerクラスライブラリのクラス,インターフェースおよびメソッドがあるかを知りたい 3章
クラス,インターフェースおよびメソッドの説明形式について知りたい 3.9節
ファクトリクラスのインターフェースおよびメソッドについて知りたい 4章
パラメタクラスのインターフェースおよびメソッドについて知りたい 5章
文書管理クラスのインターフェースおよびメソッドについて知りたい 6章
メタクラスのインターフェースおよびメソッドについて知りたい 7章
例外クラスについて知りたい 8章
定数定義クラスの定義内容について知りたい 9章
ライブラリ情報取得クラスのクラスおよびメソッドについて知りたい 10章
トレースクラスのクラスおよびメソッドについて知りたい 11章
関連マニュアルや略語の意味など,このマニュアルの参考情報について知りたい 付録A
uCosminexus DocumentBrokerの用語を知りたい 付録B

このマニュアルで使用する記号

このマニュアルで使用する記号を次に示します。

記号 意味
 | 横に並べられた複数の項目に対する項目間の区切りを示し,「または」の意味を表します。
(例) A|B
AまたはBを指定することを示します。
 _ 括弧で囲まれた複数項目のうち1項目に対し使用され,括弧内のすべてを省略した場合にシステムが取る標準値を示します。
(例) 〔A|B〕
何も指定しない場合はAが仮定されます。
{ } この記号で囲まれている複数の項目のうちから一つを選択することを示します。項目が横に並べられ,記号|で区切られている場合は,そのうちの一つを選択します。
(例) {A|B|C}
A,BまたはCのどれかを指定することを示します。
〔 〕 この記号で囲まれている項目は省略してもよいことを意味します。複数の項目が横に並べて記述されている場合には,すべてを省略するか,記号{ }と同じくどれか一つを選択します。
(例1) 〔A〕
「何も指定しない」か「Aを指定する」ことを示します。
(例2) 〔B|C〕
「何も指定しない」か「BまたはCを指定する」ことを示します。
< > この記号で囲まれている項目は,該当する要素を指定することを示します。
(例) <プロパティ>
プロパティを記述します。
::= この記号の左にあるものを右にあるもので定義することを示します。
(例) A::=B
「AとはBである」と定義することを示します。
 … 記述が省略されていることを示します。
(例) ABC…
ABCの後ろに記述があり,その記述が省略されていることを示します。
... この記号の直前の項目を繰り返し,複数個指定できることを示します。
(例) A...
Aを複数個指定できることを示します。

このマニュアルで使用する構文要素記号

このマニュアルで使用する構文要素の種類を次に示します。

構文要素記号 意味
英字 A〜Z a〜z
英小文字 a〜z
英大文字 A〜Z
数字 0〜9
英数字 A〜Z a〜z 0〜9
16進数字 0〜9 A〜F a〜f
記号 ! " # $ % & ' ( ) + , _ ― ・ . / : ; < = > @ [ ] ^ − { }  ̄ 空白 \

注 すべて半角文字を使用してください。