はじめに

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

• UNIXまたはWindowsに関する知識
• Java^TM言語に関する知識
• XMLに関する知識
• SQL言語に関する知識

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

第1章　Java クラスライブラリのクラス，インターフェース，およびメソッド

Java クラスライブラリのクラス，インターフェース，およびメソッドを一覧表形式で説明しています。また，Java クラスライブラリで提供するクラスライブラリのリファレンスマニュアルのクラス，インターフェース，およびメソッドの記述形式（ページレイアウト）について説明しています。

第2章　ファクトリクラス詳細

ファクトリクラスのクラス，インターフェース，およびメソッドについて説明しています。

第3章　パラメタクラス詳細

パラメタクラスのインターフェース，およびメソッドについて説明しています。

第4章　文書管理クラス詳細

文書管理クラスのインターフェース，およびメソッドについて説明しています。

第5章　メタクラス詳細

メタクラスのインターフェース，およびメソッドについて説明しています。

第6章　例外クラス詳細

例外クラスの詳細について説明しています。

第7章　定数定義クラス詳細

定数定義クラスの定義内容についてカテゴリごとに説明しています。

第8章　ライブラリ情報取得クラス詳細

ライブラリ情報取得クラスのクラスとそのメソッドについて説明しています。

第9章　トレースクラス詳細

トレースクラスのクラスとそのメソッドについて説明しています。

第10章　メッセージの一覧

Java クラスライブラリが出力するメッセージについて説明しています。

付録A　文書空間で使用する文字コード種別がUTF-8の場合の機能差異

文書空間で使用する文字コード種別がUTF-8の場合のクラス，インターフェースおよびメソッドの機能差異について説明しています。

付録B　用語解説

Java クラスライブラリで使用する用語について説明しています。

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

uCosminexus DocumentBroker Version 3　クラスライブラリ　Java　解説（3000-3-F16）

Java クラスライブラリの機能および環境設定のしかたについて知りたい場合に参照してください。

uCosminexus DocumentBroker Version 3　クラスライブラリ　Java　サンプルWebアプリケーション（3000-3-F18）

uCosminexus DocumentBroker Development KitおよびuCosminexus DocumentBroker Runtimeが提供しているJava クラスライブラリを使用したサンプルWebアプリケーションの機能と使用方法，およびサンプルWebアプリケーションを参考にしたWebアプリケーションの開発方法について知りたい場合に参照してください。

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　メッセージ（3000-3-F12）

uCosminexus DocumentBrokerが出力するメッセージについて知りたい場合に参照してください。

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

このマニュアルを読む目的	記述個所
どのようなJava クラスライブラリのクラス，インターフェースおよびメソッドがあるかを知りたい	1章
クラス，インターフェースおよびメソッドの説明形式について知りたい	1.9節
ファクトリクラスのインターフェースおよびメソッドについて知りたい	2章
パラメタクラスのインターフェースおよびメソッドについて知りたい	3章
文書管理クラスのインターフェースおよびメソッドについて知りたい	4章
メタクラスのインターフェースおよびメソッドについて知りたい	5章
例外クラスについて知りたい	6章
定数定義クラスの定義内容について知りたい	7章
ライブラリ情報取得クラスのクラスおよびメソッドについて知りたい	8章
トレースクラスのクラスおよびメソッドについて知りたい	9章
出力されるメッセージについて知りたい	10章
文書空間で使用する文字コード種別がUTF-8の場合のクラス，インターフェースおよびメソッドの機能差異について知りたい	付録A
uCosminexus DocumentBrokerの用語を知りたい	付録B

このマニュアルでは，製品名称を次に示す略称で表記しています。

製品名称	略称
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サーバ
Microsoft(R) Active Directory(R)	Active Directory
Microsoft(R) Office Word	Word
Microsoft(R) Word
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 x64 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ビット版）
Sun Java(TM) System Directory Server 5.1	Sun Java System Directory Server
Sun Java(TM) System Directory Server 5.2
Sun Java(TM) System Directory Server 6.3

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

• Java^TMをJavaと表記します。
• uCosminexus DocumentBroker Development KitおよびuCosminexus DocumentBroker Runtimeが提供するJava言語対応のクラスライブラリをJava クラスライブラリと表記します。
• AIXをUNIXと表記することがあります。
• Windows Server 2003，Windows Server 2003 R2，Windows Server 2003 R2 x64 Edition，Windows Server 2008 x86，Windows Server 2008 R2，Windows Server 2012，Windows XP，Windows Vista，Windows 7，およびWindows 8を合わせてWindowsと表記することがあります。

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
DTD	Document Type Definition
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
PDF	Portable Document Format
RDB	Relational Database
RDN	Relative Distinguished Name
RFC	Request for Comment
RTF	Rich Text Format
SQL	Structured Query Language
TCP/IP	Transmission Control Protocol/Internet Protocol
TIFF	Tag Image File Format
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が仮定されます。
｛　｝	この記号で囲まれている複数の項目のうちから一つを選択することを示します。項目が横に並べられ，記号｜で区切られている場合は，そのうちの一つを選択します。 （例）　｛A｜B｜C｝ A，BまたはCのどれかを指定することを示します。
〔　〕	この記号で囲まれている項目は省略してもよいことを意味します。複数の項目が横に並べて記述されている場合には，すべてを省略するか，記号｛ ｝と同じくどれか一つを選択します。 （例１）　〔A〕 「何も指定しない」か「Aを指定する」ことを示します。 （例２）　〔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
記号	!　"　#　$　%　&　'　(　)　+　,　_　―　・　.　/　:　;　<　=　>　@　[　]　^　−　｛　｝　￣　空白　\

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

このマニュアルでは，常用漢字を使用することを基本としていますが，次に示す用語については，常用漢字以外の漢字を使用しています。

個所（かしょ）

1KB（キロバイト），1MB（メガバイト），1GB（ギガバイト），1TB（テラバイト）はそれぞれ1,024バイト，1,024²バイト，1,024³バイト，1,024⁴バイトです。

uCosminexus DocumentBroker Version 3では次のように製品の統合を行いました。

• DocumentBroker RepositoryをuCosminexus DocumentBroker Serverに統合しました。
• DocumentBroker Web ComponentをuCosminexus DocumentBroker Development KitおよびuCosminexus DocumentBroker Runtimeに統合しました。

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