uCosminexus DocumentBroker Version 3 Standard GUI Development Kit

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

はじめに

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

対象読者

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

マニュアルの構成

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

第1章 DocumentBroker Standard GUI Development Kitの概要
uCosminexus DocumentBroker Standard GUI Development Kitで実現できる機能の概要,および前提プログラムについて説明しています。

第2章 DocumentBroker Standard GUI Development Kit提供のクラス一覧
uCosminexus DocumentBroker Standard GUI Development Kitで提供するクラスの一覧について説明しています。

第3章 共通操作パッケージ提供クラスの詳細
共通操作パッケージ(jp.co.hitachi_system.sContents.API.Common)提供のクラス,およびメソッドについて説明しています。

第4章 文書操作パッケージ提供クラスの詳細
文書操作パッケージ(jp.co.hitachi_system.sContents.API.Document)提供のクラス,およびメソッドについて説明しています。

第5章 フォルダ操作パッケージ提供クラスの詳細
フォルダ操作パッケージ(jp.co.hitachi_system.sContents.API.Folder)提供のクラス,およびメソッドについて説明しています。

第6章 検索操作パッケージ提供クラスの詳細
検索操作パッケージ(jp.co.hitachi_system.sContents.API.Select)提供のクラス,およびメソッドについて説明しています。

第7章 文書種別マスタパッケージ提供クラスの詳細
文書種別マスタパッケージ(jp.co.hitachi_system.sContents.API.DocMaster)提供のクラス,およびメソッドについて説明しています。

第8章 DocumentBrokerで提供されるクラスライブラリの詳細
Javaクラスライブラリのクラス,およびメソッドについて説明しています。

第9章 コーディング例
クラスライブラリを使用したコーディング例について説明しています。

第10章 DocumentBroker Standard GUI Development Kitの環境構築
uCosminexus DocumentBroker Standard GUI Development Kitのインストール,および環境構築手順について説明しています。

付録A DocumentBroker Standard GUI Development Kitで使用するプロパティ一覧
uCosminexus DocumentBroker Standard GUI Development Kitで扱うことができるプロパティについて説明しています。

付録B 用語解説
uCosminexus DocumentBroker Standard GUI Development Kitの用語について説明しています。

関連マニュアル

このマニュアルは次のマニュアルと関連がありますので,必要に応じてお読みください。

uCosminexus DocumentBroker Standard GUIのマニュアル

uCosminexus DocumentBroker Version 3 Standard GUI システム導入・運用ガイド(3020-3-U73)
uCosminexus DocumentBroker Standard GUIの環境設定,および運用方法について知りたい場合に参照してください。

uCosminexus DocumentBroker Version 3 Standard GUI 操作ガイド(3020-3-U74)
uCosminexus DocumentBroker Standard GUIのGUIの操作方法などについて知りたい場合に参照してください。

関連するプログラムのマニュアル

uCosminexus DocumentBroker Version 3 クラスライブラリ Java 解説(3000-3-F16)
Java クラスライブラリの機能および環境設定のしかたについて知りたい場合に参照してください。

uCosminexus DocumentBroker Version 3 システム導入・運用ガイド (3020-3-U71)
uCosminexus DocumentBrokerを使用する環境を定義,管理および運用する場合に参照してください。

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

Cosminexus システム構築ガイド(3020-3-M06)
Cosminexusを使用して構築するアプリケーションサーバの構築方法について知りたい場合に参照してください。

読書手順

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

このマニュアルを読む目的 記述個所
DocumentBroker Standard GUI Development Kit概要,および前提条件について知りたい 1章
どのようなJavaクラスライブラリのクラス,インターフェースおよびメソッドがあるかを知りたい,また,クラス,インターフェースおよびメソッドの説明形式について知りたい 2章
共通パッケージクラスのインターフェースおよびメソッドについて知りたい 3章
文書操作クラスのインターフェースおよびメソッドについて知りたい 4章
フォルダ操作クラスのインターフェースおよびメソッドについて知りたい 5章
検索操作クラスのインターフェースおよびメソッドについて知りたい 6章
文書種別マスタ操作クラスについて知りたい 7章
DocumentBroker Standard GUI Development Kitで使用するDocumentBrokerのクラス,およびメソッドについて知りたい 8章
コーディング例について知りたい 9章
DocumentBroker Standard GUI Development Kitのインストール,および環境構築について知りたい 10章
DocumentBroker Standard GUI Development Kitで使用するプロパティについて知りたい 付録A
DocumentBroker Standard GUI Development Kitの用語について知りたい 付録B

このマニュアルでの表記

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

正式名称 略称
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
Java(TM) Java
Microsoft(R) Windows Server(R) 2003, Enterprise Edition 日本語版 Windows Server 2003 Enterprise Edition Windows Server 2003
Microsoft(R) Windows Server(R) 2003, Standard Edition 日本語版 Windows Server 2003 Standard Edition
Microsoft(R) Windows Server(R) 2003 R2, Enterprise Edition 日本語版 Windows Server 2003 R2, Enterprise Edition Windows Server 2003 R2
Microsoft(R) Windows Server(R) 2003 R2, Standard Edition日本語版 Windows Server 2003 R2, Standard Edition
Microsoft(R) Windows Server(R) 2003 R2, Enterprise x64 Edition 日本語版 Windows Server 2003 R2, Enterprise Edition (x64) Windows Server 2003 R2 (x64)
Microsoft(R) Windows Server(R) 2003 R2, Standard x64 Edition 日本語版 Windows Server 2003 R2, Standard x64 Edition (x64)
Microsoft(R) Windows Server(R) 2008 Enterprise 32-bit 日本語版 Windows Server 2008 Enterprise Edition x86 Windows Server 2008,またはWindows Server 2008 x86
Microsoft(R) Windows Server(R) 2008 Standard 32-bit 日本語版 Windows Server 2008 Standard Edition x86
Microsoft(R) Windows(R) XP Professional Operating System Windows XP Professional Windows XP
uCosminexus Application Server Enterprise Version 7 uCosminexus Application ServerまたはCosminexus
uCosminexus Application Server Enterprise Version 8
uCosminexus Application Server Standard Version 7
uCosminexus Application Server Standard Version 8
uCosminexus Developer Professional Version 7
uCosminexus Developer Professional Version 8
uCosminexus Developer Standard Version 7
uCosminexus Developer Standard Version 8
uCosminexus DocumentBroker Development Kit Version 3 DocumentBroker Development Kit DocumentBroker
uCosminexus DocumentBroker Runtime Version 3 DocumentBroker Runtime
uCosminexus DocumentBroker Server Version 3 DocumentBroker Server,DocumentBrokerサーバまたは,文書管理サーバ
uCosminexus DocumentBroker Text Search Index Loader Version 2 DocumentBroker Text Search Index Loader
uCosminexus DocumentBroker Version 3 Standard GUI DocumentBroker Standard GUI
uCosminexus DocumentBroker Version 3 Standard GUI Development Kit DocumentBroker Standard GUI Development Kit
uCosminexus DocumentBroker Version 3 オブジェクト操作ツール オブジェクト操作ツール
DocumentBroker Rendering Option Version 3 DocumentBroker Rendering Option
DocumentBroker イメージ登録 for DocuCentre(R) DocumentBroker イメージ登録 for DocuCentre

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

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

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

英略語 英字での表記
ACL Access Control List
API Application Programming Interface
CORBA Common Object Request Broker Architecture
DB Database
GUI Graphical User Interface
GUID Globally Unique Identifier
ID Identifier
J2EE Java 2 Enterprise Edition
OIID Object Instance Identifier
OS Operating System
PC Personal Computer
PDF Portable Document Format
SQL Structured Query Language
UCS-2 Universal multi-octet Character Set 2
UCS-4 Universal multi-octet Character Set 4
UTF-8 8-bit UCS Transformation Format
XML Extensible 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バイトです。