このマニュアルは,次に示すプログラムプロダクトで提供するクラスライブラリのクラスの詳細とメソッドの文法について説明したものです。
対象読者
このマニュアルは,クラスライブラリを利用してクライアントアプリケーションを開発する方を対象にしています。なお,次の内容を理解されていることを前提としています。
マニュアルの構成
このマニュアルは,次に示す章と付録から構成されています。
関連マニュアル
このマニュアルは次のマニュアルと関連がありますので,必要に応じてお読みください。なお,本文に記載のマニュアル名称は,「uCosminexus DocumentBroker」を「DocumentBroker」と表記しています。
uCosuminexus DocumentBrokerのマニュアル
DocumentBroker Version 3 システム導入・運用ガイド(3000-3-D01)
関連製品のマニュアル(HiRDB)
関連製品のマニュアル(その他)
読書手順
このマニュアルは,利用目的に合わせて章を選択してお読みいただけます。次に示す表を参考にして,お読みになる章を選択してください。
このマニュアルを読む目的 | 記述個所 | |
---|---|---|
どんなクラスやメソッド,関数があるのかを知りたい。 | クラスライブラリのクラス,メソッドおよび関数 | 1章 |
クラス一覧 | 1.1節 | |
メソッド一覧 | 1.2節 | |
関数一覧 | 1.3節 | |
クラスライブラリで使用するデータ型やリファレンスマニュアルの記述形式を知りたい。 | クラスライブラリで使用するデータ型とクラスおよびメソッドの記述形式 | 2章 |
クラスライブラリで使用するデータ型 | 2.1節 | |
クラスおよびメソッドの記述形式 | 2.2節 | |
各クラスの詳細とメソッドの文法について知りたい。 | CdbrCompoundクラス(複合データを扱うクラス) | 3章 |
CdbrConfiguratedReferentialContainerクラス(バージョン付き構成管理コンテナを扱うクラス) | 4章 | |
CdbrContainableクラス(包含要素を扱うクラス) | 5章 | |
CdbrCoreクラス(エラー情報を取得するクラス) | 6章 | |
CdbrDMAクラス(OIIDの設定やプロパティを扱うクラス) | 7章 | |
CdbrDocumentクラス(バージョンなし文書を扱うクラス) | 8章 | |
CdbrEqlStatementクラス(edmSQL文を操作,実行するクラス) | 9章 | |
CdbrIndependentPersistenceクラス(独立データを扱うクラス) | 10章 | |
CdbrPublicACLクラス(パブリックACLを扱うクラス) | 11章 | |
CdbrReferentialContainerクラス(バージョンなしコンテナを扱うクラス) | 12章 | |
CdbrSessionクラス(セッションを確立するクラス) | 13章 | |
CdbrVariableArrayクラス(可変長配列を扱うクラス) | 14章 | |
CdbrVersionableクラス(バージョン管理機能を提供するクラス) | 15章 | |
CdbrVersionableDocumentクラス(バージョン付き文書を扱うクラス) | 16章 | |
CdbrVersionTraceableContainerクラス(バージョンなし構成管理コンテナを扱うクラス) | 17章 | |
CdbrXmlTranslatorクラス(XML変換を扱うクラス) | 18章 | |
CdbrXmlTranslatorFactoryクラス(XMLの操作環境を管理するクラス) | 19章 | |
関数の詳細を知りたい。 | 関数 | 20章 |
コーディング例を見たい。 | コーディング例 | 付録A |
作成するコーディング例 | A.1 | |
コーディング例 | A.2 | |
DMAオブジェクトのプロパティについて知りたい。 | DMAオブジェクトのプロパティ | 付録B |
DMAのクラスのプロパティ一覧 | B.1 | |
プロパティの説明 | B.2 | |
メソッドで使用する構造体について知りたい。 | クラスライブラリのメソッドで使用する構造体 | 付録C |
オブジェクトの情報を設定,参照する構造体 | C.1 | |
検索に使用する構造体 | C.2 | |
構造体で指定する定数 | C.3 | |
メソッドの実行に必要なパーミッションについて知りたい。 | メソッドの実行に必要なパーミッション(アクセス制御機能を使用する場合) | 付録D |
パーミッション一覧で使用する記号 | D.1 | |
メソッドの実行に必要なパーミッション一覧 | D.2 | |
メソッド実行時の排他制御(ロック)について知りたい。 | メソッド実行時の排他制御(ロック) | 付録E |
メソッド実行時の明示的なロックと暗黙のロック | E.1 | |
メソッド実行時のロック一覧 | E.2 | |
OIID指定時のURLの文法について知りたい。 | OIID指定時のURLの文法 | 付録F |
文書空間で使用する文字コード種別がUTF-8の場合に使用できるメソッドおよび関数について知りたい。 | 文書空間で使用する文字コード種別がUTF-8の場合に使用できるメソッドと関数 | 付録G |
クラスライブラリの戻り値について知りたい。 | 戻り値一覧 | 付録H |
クラスライブラリの戻り値 | H.1 | |
DMAの戻り値 | H.2 | |
クラスライブラリ独自の戻り値(ERR_DBRの場合) | H.3 | |
データベースエラーが発生した場合の戻り値(ERR_DBの場合) | H.4 | |
詳細メッセージの出力について | H.5 | |
障害が発生した時にuCosminexus DocumentBrokerが出力する情報について知りたい。 | 障害が発生した時にuCosminexus DocumentBrokerが出力する情報 | 付録I |
uCosminexus DocumentBrokerの用語を知りたい。 | 用語解説 | 付録J |
このマニュアルでの表記
このマニュアルでは,製品名称を次に示す略称で表記しています。
製品名称 | 略称 |
---|---|
AIX 5L V5.1 | AIX |
AIX 5L V5.2 | |
AIX 5L V5.3 | |
uCosminexus DocumentBroker Development Kit Version 3 | DocumentBroker |
uCosminexus DocumentBroker Runtime Version 3 | |
uCosminexus DocumentBroker Server Version 3 | |
uCosminexus DocumentBroker Development Kit Version 3 | DocumentBroker Development Kit |
uCosminexus DocumentBroker Runtime Version 3 | DocumentBroker Runtime |
uCosminexus DocumentBroker Server Version 3 | DocumentBrokerサーバ |
HiRDB/Single Server Version 6 | HiRDB |
HiRDB/Single Server Version 7 | |
HiRDB/Single Server Version 8 | |
HiRDB/Parallel Server Version 6 | |
HiRDB/Parallel Server Version 7 | |
HiRDB/Parallel Server Version 8 | |
HiRDB Adapter for XML - Enterprise Edition | HiRDB Adapter for XML |
HiRDB Adapter for XML - Standard Edition | |
TPBroker Developer for C++ | TPBroker |
TPBroker for C++ | |
TPBroker | |
Microsoft(R) Windows Server(R) 2003, Enterprise Edition 日本語版 | Windows Server 2003 |
Microsoft(R) Windows Server(R) 2003, Standard Edition 日本語版 | |
Microsoft(R) Windows Server(R) 2003 R2, Enterprise Edition 日本語版 | Windows Server 2003 R2 |
Microsoft(R) Windows Server(R) 2003 R2, Standard Edition 日本語版 | |
Microsoft(R) Windows Server(R) 2003 R2, Enterprise x64 Edition 日本語版 | Windows Server 2003 R2またはWindows Server 2003 R2 Edition |
Microsoft(R) Windows Server(R) 2003 R2, Standard x64 Edition 日本語版 | |
Microsoft(R) Windows Server(R) 2008 Enterprise 32-bit 日本語版 | Windows Server 2008 またはWindows Server 2008 x86 |
Microsoft(R) Windows Server(R) 2008 Standard 32-bit 日本語版 | |
Microsoft(R) Windows Server(R) 2008 R2 Enterprise 日本語版 | Windows Server 2008 R2 |
Microsoft(R) Windows Server(R) 2008 R2 Standard 日本語版 | |
Microsoft(R) Windows Server(R) 2012 Standard 日本語版 | Windows Server 2012 |
Microsoft(R) Windows Server(R) 2012 Datacenter 日本語版 | |
Microsoft(R) Windows(R) XP Professional Operating System | Windows XP |
Microsoft(R) Windows Vista(R) Ultimate 日本語版 | Windows Vista |
Microsoft(R) Windows Vista(R) Business 日本語版 | |
Microsoft(R) Windows Vista(R) Enterprise 日本語版 | |
Microsoft(R) Windows(R) 7 Professional 日本語版 (32ビット版) | Windows 7 |
Microsoft(R) Windows(R) 7 Enterprise 日本語版 (32ビット版) | |
Microsoft(R) Windows(R) 7 Ultimate 日本語版 (32ビット版) | |
Microsoft(R) Windows(R) 7 Professional 日本語版 (64ビット版) | |
Microsoft(R) Windows(R) 7 Enterprise 日本語版 (64ビット版) | |
Microsoft(R) Windows(R) 7 Ultimate 日本語版 (64ビット版) | |
Windows(R) 8 Pro 日本語版(32ビット版) | Windows 8 |
Windows(R) 8 Pro 日本語版(64ビット版) | |
Windows(R) 8 Enterprise 日本語版(32ビット版) | |
Windows(R) 8 Enterprise 日本語版(64ビット版) | |
Microsoft(R) Office Word | Word |
Microsoft(R) Word | |
活文 PDFstaff Runtime | PDFstaff Runtime |
活文 PDFstaff SDK | PDFstaff SDK |
このほか,このマニュアルでは,次に示す表記方法を使用しています。
uCosminexus DocumentBrokerのマニュアルで使用する略語
uCosminexus DocumentBrokerのマニュアルで使用する英略語を次に示します。
英略語 | 英字での表記 |
---|---|
ACE | Access Control Element |
ACFlag | Access Control Flag |
ACL | Access Control List |
AIIM | Association for Information and Image Management International |
API | Application Programming Interface |
ASCII | American Standard Code for Information Interchange |
BES | Back End Server |
BLOB | Binary Large Object |
BMP | Bit Map |
BNF | Backus Normal Form |
BOA | Basic Object Adapter |
CD-ROM | Compact Disc Read Only Memory |
CGI | Common Gateway Interface |
CORBA | Common Object Request Broker Architecture |
CPU | Central Processing Unit |
CR | Carriage Return |
CSV | Comma Separated Value |
DAP | Directory Access Protocol |
DAT | Digital Audio Tape |
DB | Database |
DBMS | Database Management System |
DCD | Document Content Description |
DDE | Dynamic Data Exchange |
DIT | Directory Information Tree |
DLL | Dynamic Linking Library |
DMA | Document Management Alliance |
DN | Distinguished Name |
EOF | End of File |
ESIS-B | Element Structure Information Set-Binary Format |
EUC | Extended UNIX Code |
FAM | File Access Module |
GIF | Graphics Interchange Format |
GUI | Graphical User Interface |
GUID | Globally Unique Identifier |
HTML | Hypertext Markup Language |
HTTP | Hypertext Transfer Protocol |
IANA | Internet Assigned Numbers Authority |
ID | Identifier |
IPF | Itanium(R) Processor Family |
ISO | International Organization for Standardization |
JIS | Japanese Industrial Standards |
JPEG | Joint Photographic Expert Group |
LAN | Local Area Network |
LDAP | Lightweight Directory Access Protocol |
LF | Line Feed |
MFC | Microsoft Foundation Class |
MIME | Multipurpose Internet Mail Extensions |
OCR | Optical Character Reader |
OIID | Object Instance Identifier |
OLE | Object Linking and Embedding |
OMG | Object Management Group |
ORB | Object Request Broker |
ORDB | Object Relational Database |
OS | Operating System |
OTS | Object Transaction Service |
PC | Personal Computer |
Portable Document Format | |
RDB | Relational Database |
RDN | Relative Distinguished Name |
RFC | Request for Comment |
RTF | Rich Text Format |
SGML | Standard Generalized Markup Language |
SQL | Structured Query Language |
TCP/IP | Transmission Control Protocol/Internet Protocol |
TIFF | Tag Image File Format |
UNC | Universal Naming Convention |
UOC | User Own Coding |
URL | Uniform Resource Locator |
UTC | Universal Time Coordinated |
UTF-8 | 8-bit UCS Transformation Format |
W3C | World Wide Web Consortium |
WWW | World Wide Web |
XML | Extensible Markup Language |
このマニュアルで使用する記号
このマニュアルで使用する記号を次に示します。
記号 | 意味 |
---|---|
| | 横に並べられた複数の項目に対する項目間の区切りを示し,「または」を意味します。 (例) A|B AまたはBを指定することを示します。 |
_ | 括弧で囲まれた複数項目のうち1項目に対し使用され,括弧内のすべてを省略したときシステムが取る標準値を示します。 (例) 〔A|B〕 「何も指定しない」か「AまたはBを指定する」ことを示します。何も指定しない場合はAが仮定されます。 |
{ } | この記号で囲まれている複数の項目のうちから一つを選択することを示します。項目が横に並べられ,記号|で区切られている場合は,そのうちの一つを選択します。 (例) {A|B|C} A,BまたはCのどれかを指定することを示します。 |
〔 〕 | この記号で囲まれている項目は省略してもよいことを示します。複数の項目が横に並べて記述されている場合には,すべてを省略するか,記号{ }と同じくどれか一つを選択します。 (例1) 〔A〕 「何も指定しない」か「Aを指定する」ことを示します。 (例2) 〔B|C〕 「何も指定しない」か「BまたはCを指定する」ことを示します。 |
::= | この記号の左にあるものを右にあるもので定義することを示します。 (例) A::=B 「AとはBである」と定義することを示します。 |
… | 記述が省略されていることを示します。 (例)ABC… ABCの後ろに記述があり,その記述が省略されていることを示します。 |
< > | この記号で囲まれている項目は,該当する要素を指定することを示します。 (例) <プロパティ> プロパティを記述します。 |
( ) | この記号で囲まれている項目を省略しないで記述することを示します。 (例) (<プロパティ>) 項目<プロパティ>は省略しないで記述します。 |
... | この記号の直前に示す記号を繰り返し,複数個指定できることを示します。 (例) (<プロパティ>)... プロパティは一つ以上で複数個,繰り返して指定できます。 |
このマニュアルで使用する構文要素
このマニュアルで使用する構文要素の種類を次に示します。
種類 | 定義 |
---|---|
英字 | A~Z a~z |
英小文字 | a~z |
英大文字 | A~Z |
数字 | 0~9 |
英数字 | A~Z a~z 0~9 |
記号 | ! " # $ % & ' ( ) + , _ ・ . / : ; < = > @ [ ] ^ - { }  ̄ タブ 空白 |
注 すべて半角文字を使用してください。
このマニュアルの図中で使用する記号
このマニュアルの図中で使用する記号を,次のように定義します。
常用漢字以外の漢字の使用について
このマニュアルでは,常用漢字を使用することを基本としていますが,次に示す用語については,常用漢字以外の漢字を使用しています。
個所(かしょ),必須(ひっす)
KB(キロバイト)などの単位表記について
1KB(キロバイト),1MB(メガバイト),1GB(ギガバイト),1TB(テラバイト)はそれぞれ1,024バイト,1,0242バイト,1,0243バイト,1,0244バイトです。
DocumentBroker Version 2とuCosminexus DocumentBroker Version 3の製品体系の違い
uCosminexus DocumentBroker Version 3では次のように製品の統合を行いました。
DocumentBroker Version 2とuCosminexus DocumentBroker Version 3の製品体系の違いを次に示します。
DocumentBroker Version 2とuCosminexus DocumentBroker Version 3のマニュアルの対応
バージョンアップおよび製品体系の変更に伴い,uCosminexus DocumentBroker Version 3では次に示すようにマニュアル名称を変更しました。
Version 2のマニュアル名称 | Version 3のマニュアル名称 |
---|---|
DocumentBroker Version 2 システム導入・運用ガイド | uCosminexus DocumentBroker Version 3 システム導入・運用ガイド |
DocumentBroker Version 2 クラスライブラリ 解説 | uCosminexus DocumentBroker Version 3 クラスライブラリ C++ 解説 |
DocumentBroker Version 2 クラスライブラリ リファレンス 基本機能編 | uCosminexus DocumentBroker Version 3 クラスライブラリ C++ リファレンス 基本機能編 |
DocumentBroker Version 2 クラスライブラリ リファレンス 概念SGML文書管理機能編 | 廃版 |
DocumentBroker Version 2 オブジェクト操作ツール | uCosminexus DocumentBroker Version 3 オブジェクト操作ツール |
DocumentBroker Version 2 統計解析ツール | uCosminexus DocumentBroker Version 3 統計解析ツール |
DocumentBroker Version 2 メッセージ | uCosminexus DocumentBroker Version 3 メッセージ |
DocumentBroker Web Component Version 2 解説 | uCosminexus DocumentBroker Version 3 クラスライブラリ Java 解説 |
DocumentBroker Web Component Version 2 リファレンス | uCosminexus DocumentBroker Version 3 クラスライブラリ Java リファレンス |
DocumentBroker Web Component Version 2 サンプルWebアプリケーション | uCosminexus DocumentBroker Version 3 クラスライブラリ Java サンプルWebアプリケーション |
DocumentBroker Text Search Index Loader Version 2 | uCosminexus DocumentBroker Text Search Index Loader Version 3 |
DocumentBroker Rendering Option システム導入・運用ガイド | uCosminexus DocumentBroker Rendering Option Version 3 |
DocumentBroker Object Loader Version 2 | uCosminexus DocumentBroker Object Loader Version 3 |