はじめに

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

対象読者

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

マニュアルの構成

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

第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.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サーバ
Microsoft(R) Active Directory(R)Active Directory
Microsoft(R) Office WordWord
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 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ビット版)
Sun Java(TM) System Directory Server 5.1Sun Java System Directory Server
Sun Java(TM) System Directory Server 5.2
Sun Java(TM) System Directory Server 6.3

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

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
DTDDocument Type Definition
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
SQLStructured Query Language
TCP/IPTransmission Control Protocol/Internet Protocol
TIFFTag Image File Format
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が仮定されます。
{ }この記号で囲まれている複数の項目のうちから一つを選択することを示します。項目が横に並べられ,記号|で区切られている場合は,そのうちの一つを選択します。
(例) {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
記号! " # $ % & ' ( ) + , _ ― ・ . / : ; < = > @ [ ] ^ - { }  ̄ 空白 ¥

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


常用漢字以外の漢字の使用について

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

個所(かしょ)

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