はじめに

このマニュアルは,次に示すプログラムプロダクトで提供するクラスライブラリのクラスの詳細とメソッドの文法について説明したものです。

対象読者

このマニュアルは,クラスライブラリを利用してクライアントアプリケーションを開発する方を対象にしています。なお,次の内容を理解されていることを前提としています。

マニュアルの構成

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

第1章 クラスライブラリのクラス,メソッドおよび関数
クラスライブラリで提供するクラス,メソッドおよび関数を簡単な機能概略付きの一覧表形式で説明しています。
第2章 クラスライブラリで使用するデータ型とクラスおよびメソッドの記述形式
クラスライブラリのリファレンスマニュアルで使用するデータ型の定義,およびクラス,メソッドの記述形式(ページレイアウト)について説明しています。
第3章 CdbrCompoundクラス(複合データを扱うクラス)
CdbrCompoundクラスの詳細とメソッドの文法について説明しています。
第4章 CdbrConfiguratedReferentialContainerクラス(バージョン付き構成管理コンテナを扱うクラス)
CdbrConfiguratedReferentialContainerクラスの詳細とメソッドの文法について説明しています。
第5章 CdbrContainableクラス(包含要素を扱うクラス)
CdbrContainableクラスの詳細とメソッドの文法について説明しています。
第6章 CdbrCoreクラス(エラー情報を取得するクラス)
CdbrCoreクラスの詳細とメソッドの文法について説明しています。
第7章 CdbrDMAクラス(OIIDの設定やプロパティを扱うクラス)
CdbrDMAクラスの詳細とメソッドの文法について説明しています。
第8章 CdbrDocumentクラス(バージョンなし文書を扱うクラス)
CdbrDocumentクラスの詳細とメソッドの文法について説明しています。
第9章 CdbrEqlStatementクラス(edmSQL文を操作,実行するクラス)
CdbrEqlStatementクラスの詳細とメソッドの文法について説明しています。
第10章 CdbrIndependentPersistenceクラス(独立データを扱うクラス)
CdbrIndependentPersistenceクラスの詳細とメソッドの文法について説明しています。
第11章 CdbrPublicACLクラス(パブリックACLを扱うクラス)
CdbrPublicACLクラスの詳細とメソッドの文法について説明しています。
第12章 CdbrReferentialContainerクラス(バージョンなしコンテナを扱うクラス)
CdbrReferentialContainerクラスの詳細とメソッドの文法について説明しています。
第13章 CdbrSessionクラス(セッションを確立するクラス)
CdbrSessionクラスの詳細とメソッドの文法について説明しています。
第14章 CdbrVariableArrayクラス(可変長配列を扱うクラス)
CdbrVariableArrayクラスの詳細とメソッドの文法について説明しています。
第15章 CdbrVersionableクラス(バージョン管理機能を提供するクラス)
CdbrVersionableクラスの詳細とメソッドの文法について説明しています。
第16章 CdbrVersionableDocumentクラス(バージョン付き文書を扱うクラス)
CdbrVersionableDocumentクラスの詳細とメソッドの文法について説明しています。
第17章 CdbrVersionTraceableContainerクラス(バージョンなし構成管理コンテナを扱うクラス)
CdbrVersionTraceableContainerクラスの詳細とメソッドの文法について説明しています。
第18章 CdbrXmlTranslatorクラス(XML変換を扱うクラス)
CdbrXmlTranslatorクラスの詳細とメソッドの文法について説明しています。
第19章 CdbrXmlTranslatorFactoryクラス(XMLの操作環境を管理するクラス)
CdbrXmlTranslatorFactoryクラスの詳細とメソッドの文法について説明しています。
第20章 関数
クラスライブラリが提供する関数について説明しています。
付録A コーディング例
クラスライブラリの機能を使用してクライアントアプリケーションを作成する場合のコーディング例について説明しています。
付録B DMAオブジェクトのプロパティ
DMAオブジェクトが保持しているプロパティのうち,クラスライブラリによって操作できるプロパティについて説明しています。
付録C クラスライブラリのメソッドで使用する構造体
クラスライブラリのメソッドを使用するときに,オブジェクトに設定する情報を指定したり既存のオブジェクトの情報を取得したりするために使用する構造体について説明しています。
付録D メソッドの実行に必要なパーミッション(アクセス制御機能を使用する場合)
アクセス制御機能を使用する場合に,それぞれのメソッドをコールするときに必要なパーミッションについて説明しています。
付録E メソッド実行時の排他制御(ロック)
クラスライブラリのメソッドの実行時に明示的に設定できるロックと暗黙で設定されるロックについて説明しています。
付録F OIID指定時のURLの文法
OIIDの形式およびOIIDを指定するときのURLの文法について説明しています。
付録G 文書空間で使用する文字コード種別がUTF-8の場合に使用できるメソッドと関数
クラスライブラリのメソッドおよび関数で文字コード種別「UTF-8」をサポートしている範囲について説明しています。
付録H 戻り値一覧
クラスライブラリのメソッドを発行したときに返される戻り値について,一覧形式で説明しています。
付録I 障害が発生した時にDocumentBrokerが出力する情報
障害が発生した時にuCosminexus DocumentBrokerが出力する情報の出力先などについて説明しています。
付録J 用語解説
uCosminexus DocumentBroker Version 3で使用する用語について説明しています。

関連マニュアル

このマニュアルは次のマニュアルと関連がありますので,必要に応じてお読みください。なお,本文に記載のマニュアル名称は,「uCosminexus DocumentBroker」を「DocumentBroker」と表記しています。

uCosuminexus DocumentBrokerのマニュアル

DocumentBroker Version 3 システム導入・運用ガイド(3000-3-D01)

uCosminexus DocumentBroker Version 3 システム導入・運用ガイド(3020-3-U71)
uCosminexus DocumentBrokerを使用する環境を定義,管理および運用する場合に参照してください。
UNIXの場合は,資料番号が3000-3-D01のマニュアルを参照してください。
Windowsの場合は,資料番号が3020-3-U71のマニュアルを参照してください。
uCosminexus DocumentBroker Version 3 クラスライブラリ C++ 解説(3000-3-F13)
クラスライブラリの機能と,クラスライブラリを使用するために必要なオブジェクトモデルについて知りたい場合に参照してください。
uCosminexus DocumentBroker Version 3 メッセージ(3000-3-F12)
uCosminexus DocumentBrokerが出力するメッセージについて知りたい場合に参照してください。
DocumentBroker Rendering Option Version 3(3020-3-N47)
Adobe Acrobat Distillerと連携したDocumentBroker Rendering Optionの機能,環境設定,およびコマンドの文法について知りたい場合に参照してください。
DocumentBroker Rendering Option Version 3 (活文PDFstaff編)(3020-3-N49)
PDFstaff RuntimeおよびPDFstaff SDKと連携したDocumentBroker Rendering Optionの機能,環境設定,およびコマンドの文法について知りたい場合に参照してください。
uCosminexus DocumentBroker Text Search Index Loader Version 3(3020-3-U72)
uCosminexus DocumentBrokerに格納されている文書からテキスト情報を抽出して,全文検索用のインデクスファイルを作成し,これを全文検索インデクスに登録するユティリティについて知りたい場合に参照してください。

関連製品のマニュアル(HiRDB)

関連製品のマニュアル(その他)

注※1
このマニュアルでは,これらのマニュアルを「HiRDB SQLリファレンス」と表記しています。
注※2
このマニュアルでは,これらのマニュアルを「HiRDB File Link」と表記しています。
注※3
このマニュアルでは,これらのマニュアルを「VisiBroker for C++ プログラマーズガイド」と表記しています。

読書手順

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

このマニュアルを読む目的記述個所
どんなクラスやメソッド,関数があるのかを知りたい。クラスライブラリのクラス,メソッドおよび関数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.1AIX
AIX 5L V5.2
AIX 5L V5.3
uCosminexus DocumentBroker Development Kit Version 3DocumentBroker
uCosminexus DocumentBroker Runtime Version 3
uCosminexus DocumentBroker Server Version 3
uCosminexus DocumentBroker Development Kit Version 3DocumentBroker Development Kit
uCosminexus DocumentBroker Runtime Version 3DocumentBroker Runtime
uCosminexus DocumentBroker Server Version 3DocumentBrokerサーバ
HiRDB/Single Server Version 6HiRDB
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 EditionHiRDB 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 SystemWindows 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 WordWord
Microsoft(R) Word
活文 PDFstaff RuntimePDFstaff Runtime
活文 PDFstaff SDKPDFstaff SDK

このほか,このマニュアルでは,次に示す表記方法を使用しています。

uCosminexus DocumentBrokerのマニュアルで使用する略語

uCosminexus DocumentBrokerのマニュアルで使用する英略語を次に示します。

英略語英字での表記
ACEAccess Control Element
ACFlagAccess Control Flag
ACLAccess Control List
AIIMAssociation for Information and Image Management International
APIApplication Programming Interface
ASCIIAmerican Standard Code for Information Interchange
BESBack End Server
BLOBBinary Large Object
BMPBit Map
BNFBackus Normal Form
BOABasic Object Adapter
CD-ROMCompact Disc Read Only Memory
CGICommon Gateway Interface
CORBACommon Object Request Broker Architecture
CPUCentral Processing Unit
CRCarriage Return
CSVComma Separated Value
DAPDirectory Access Protocol
DATDigital Audio Tape
DBDatabase
DBMSDatabase Management System
DCDDocument Content Description
DDEDynamic Data Exchange
DITDirectory Information Tree
DLLDynamic Linking Library
DMADocument Management Alliance
DNDistinguished Name
EOFEnd of File
ESIS-BElement Structure Information Set-Binary Format
EUCExtended UNIX Code
FAMFile Access Module
GIFGraphics Interchange Format
GUIGraphical User Interface
GUIDGlobally Unique Identifier
HTMLHypertext Markup Language
HTTPHypertext Transfer Protocol
IANAInternet Assigned Numbers Authority
IDIdentifier
IPFItanium(R) Processor Family
ISOInternational Organization for Standardization
JISJapanese Industrial Standards
JPEGJoint Photographic Expert Group
LANLocal Area Network
LDAPLightweight Directory Access Protocol
LFLine Feed
MFCMicrosoft Foundation Class
MIMEMultipurpose Internet Mail Extensions
OCROptical Character Reader
OIIDObject Instance Identifier
OLEObject Linking and Embedding
OMGObject Management Group
ORBObject Request Broker
ORDBObject Relational Database
OSOperating System
OTSObject Transaction Service
PCPersonal Computer
PDFPortable Document Format
RDBRelational Database
RDNRelative Distinguished Name
RFCRequest for Comment
RTFRich Text Format
SGMLStandard Generalized Markup Language
SQLStructured Query Language
TCP/IPTransmission Control Protocol/Internet Protocol
TIFFTag Image File Format
UNCUniversal Naming Convention
UOCUser Own Coding
URLUniform Resource Locator
UTCUniversal Time Coordinated
UTF-88-bit UCS Transformation Format
W3CWorld Wide Web Consortium
WWWWorld Wide Web
XMLExtensible 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 2uCosminexus DocumentBroker Text Search Index Loader Version 3
DocumentBroker Rendering Option システム導入・運用ガイドuCosminexus DocumentBroker Rendering Option Version 3
DocumentBroker Object Loader Version 2uCosminexus DocumentBroker Object Loader Version 3