J2X1-1152-02Z2(01)
まえがき 第1部 アプリケーション開発の基本 第1章 概要 1.1 Shunsakuのアプリケーション機能 1.2 提供するAPI種別 1.3 Shunsakuのアプリケーションでできること 1.4 アプリケーションの設計 第2章 環境設定 2.1 APIの構成 2.1.1 Java API 2.1.2 .NET API 2.1.3 C API 2.2 セットアップ 2.3 環境変数の設定 2.3.1 環境変数の設定(Java API) 2.3.2 環境変数の設定(C API) 2.4 動作環境ファイルの設定 2.4.1 APIがインストールされているマシン単位に指定する 2.4.2 起動するアプリケーション単位に指定する 2.4.3 実行パラメタの優先度 第3章 データを検索する方法 3.1 データ検索の概要 3.2 文字列で検索する 3.2.1 キーワードを含む文書を検索する 3.2.1.1 パス式、テキスト式または属性式の例 3.2.1.2 キーワードの指定形式と検索方法 3.2.2 キーワードと完全に一致する文書を検索する 3.2.3 キーワードと大小比較を行う 3.3 数値で検索する 3.4 複数の条件を論理演算子で結合して検索する 3.5 検索結果をソートする 3.5.1 文字列でソートする 3.5.2 数値でソートする 3.5.3 複数のキー指定でソートする 3.6 検索結果を取り出す 3.6.1 XML形式で取り出す 3.6.1.1 XML文書全体を取り出す 3.6.1.2 要素ノードを指定してXML形式で取り出す 3.6.2 テキスト形式でデータを取り出す 3.7 集計した結果を取り出す 3.7.1 検索結果をグループ化する 3.7.1.1 文字列でグループ化する 3.7.1.2 数値でグループ化する 3.7.1.3 複数のキー指定でグループ化する 3.7.2 検索結果を集計する 第4章 データを更新する方法 4.1 データ更新の概要 4.2 データを追加する 4.3 データを削除する 4.4 データを更新する 第5章 トランザクション機能 5.1 トランザクションの概要 5.1.1 トランザクションとは 5.1.2 トランザクションの開始と終了 5.1.3 自動コミットと手動コミット 5.1.4 更新されたデータの見え方 5.1.5 トランザクションの同時実行制御 5.1.6 トランザクションとリカバリの関係 5.2 Java APIでトランザクションを使う 5.2.1 エラー発生時の対処 5.3 .NET APIでトランザクションを使う 5.3.1 エラー発生時の対処 5.4 C APIでトランザクションを使う 5.4.1 エラー発生時の対処 第6章 ダイレクトアクセス機能 6.1 ダイレクトアクセス機能の概要 6.2 ダイレクトアクセスキー環境の構築 6.2.1 ダイレクトアクセスキー定義ファイルの作成 6.2.2 ダイレクトアクセスキー定義ファイルの設定 6.2.3 ダイレクトアクセスキー定義ファイルの確認 6.3 ダイレクトアクセスキーの形式 6.4 ダイレクトアクセスキーでデータを検索する 6.4.1 Java APIの場合 6.4.2 .NET APIの場合 6.4.3 C APIの場合 6.5 ダイレクトアクセスキーでデータを削除する 6.5.1 Java APIの場合 6.5.2 .NET APIの場合 6.5.3 C APIの場合 6.6 ダイレクトアクセスキーでデータを更新する 6.6.1 Java APIの場合 6.6.2 .NET APIの場合 6.6.3 C APIの場合 6.7 ダイレクトアクセス機能を使用したアプリケーション開発 6.7.1 ダイレクト検索を使用したデータ削除/更新の使い方 6.7.2 ダイレクト削除またはダイレクト更新の使い方 第7章 Shunsaku File 7.1 Shunsaku Fileの概要 7.2 Shunsaku Fileへのアクセス方法 7.2.1 コネクション単位に指定する方法 7.2.1.1 Java APIでの指定方法 7.2.1.2 .NET APIでの指定方法 7.2.1.3 C APIでの指定方法 7.2.2 API用動作環境ファイルに指定する方法 7.2.3 Shunsaku Fileが指定されていないアプリケーションのアクセス範囲の設定 7.3 Shunsaku Fileを切り替える方法 7.3.1 Java APIでの指定方法 7.3.2 .NET APIでの指定方法 7.3.3 C APIでの指定方法 7.4 複数のShunsaku Fileを1つのトランザクションで扱う方法 7.4.1 Java APIの記述例 7.4.2 .NET APIの記述例 7.4.3 C APIの記述例 7.5 Shunsaku Fileの使用上の注意 7.5.1 Shunsaku Fileを作成する場合の注意 7.5.2 APIによるデータ更新における注意 7.5.3 ダイレクトアクセスにおける注意 7.5.4 複数のShunsaku Fileを扱う場合の注意 第8章 アプリケーションのデバッグ 8.1 アプリケーションのデバッグ方法 8.1.1 デバッガを利用したデバッグ 8.1.2 アプリケーションのデバッグ情報を利用したデバッグ 8.1.3 APIスナップを利用したデバッグ 8.1.4 Java APIのメソッド情報 8.1.5 .NET APIのメソッド情報 8.1.6 C APIの関数情報 第2部 APIでのアプリケーション開発 第9章 Java APIのアプリケーション開発 9.1 Java APIの概要 9.2 Apworksを利用したアプリケーション開発方法 9.2.1 Apworksで開発するメリット 9.2.2 Apworksを利用した開発の流れ 9.3 Java APIの使用方法 9.3.1 コネクションの確立 9.3.1.1 API用動作環境ファイルの設定によりコネクションを確立する方法 9.3.1.2 JavaのPropertiesの設定によりコネクションを確立する方法 9.3.1.3 ホスト名とポート番号を直接指定する方法 9.3.2 データの検索 9.3.2.1 条件に一致するXML文書の件数を取得する 9.3.2.2 件数に応じて検索した結果を取得する 9.3.2.3 条件を追加しながら検索した結果を取得する 9.3.2.4 ヒット件数の上限値を設定する 9.3.2.5 レコードIDの取出し 9.3.2.6 レコードIDを利用してXML文書全体を取得する 9.3.2.7 データをソートして取得する 9.3.2.8 条件に一致するXML文書を連続して取得する 9.3.2.9 条件に一致するデータの内容を集計する 9.3.3 データの更新 9.3.3.1 データを追加する 9.3.3.2 レコードIDを指定してデータを削除する 9.3.3.3 レコードIDを指定してデータを更新する 9.3.4 コネクションの切断 9.3.5 エラー発生時の対処 9.3.5.1 エラー発生時の対処例 9.4 アプリケーションのデバッグ 9.5 Java APIで使用する文字コード 第10章 .NET APIのアプリケーション開発 10.1 .NET APIの概要 10.2 Microsoft(R) Visual Studio(R) .NETを利用したアプリケーション開発方法 10.2.1 Microsoft(R) Visual Studio(R) .NETで開発するメリット 10.2.2 Microsoft(R) Visual Studio(R) .NETを利用した開発 10.2.2.1 Shunsakuと連携するWebアプリケーションの構成 10.2.2.2 Shunsakuと連携するWebアプリケーションの開発の流れ 10.3 .NET APIの使用方法 10.3.1 コネクションの確立 10.3.1.1 API用動作環境ファイルの設定によりコネクションを確立する方法 10.3.1.2 ホスト名とポート番号をプロパティで指定する方法 10.3.1.3 ホスト名とポート番号をコンストラクタで指定する方法 10.3.2 データの検索 10.3.2.1 条件に一致するXML文書の件数を取得する 10.3.2.2 件数に応じて検索した結果を取得する 10.3.2.3 条件を追加しながら検索した結果を取得する 10.3.2.4 ヒット件数の上限値を設定する 10.3.2.5 レコードIDを利用してXML文書全体を取得する 10.3.2.6 データをソートして取得する 10.3.2.7 条件に一致するXML文書を連続して取得する 10.3.2.8 条件に一致するデータの内容を集計する 10.3.3 データの更新 10.3.3.1 データを追加する 10.3.3.2 レコードIDを指定してデータを削除する 10.3.3.3 レコードIDを指定してデータを更新する 10.3.4 コネクションの切断 10.3.5 エラー発生時の対処 10.4 アプリケーションのデバッグ 10.5 .NET APIで使用する文字コード 第11章 C APIのアプリケーション開発 11.1 C APIの概要 11.1.1 ハンドルの使用方法 11.1.2 コネクションハンドル 11.1.3 データ操作ハンドル 11.1.4 共通関数 11.2 C APIの使用方法 11.2.1 コネクションの確立 11.2.1.1 API用動作環境ファイルの設定によりコネクションを確立する方法 11.2.1.2 ホスト名とポート番号を直接指定する方法 11.2.2 データの検索 11.2.2.1 条件に一致するXML文書の件数を取得する 11.2.2.2 件数に応じて検索した結果を取得する 11.2.2.3 条件を追加しながら検索した結果を取得する 11.2.2.4 ヒット件数の上限値を設定する 11.2.2.5 レコードIDを利用してXML文書全体を取得する 11.2.2.6 データをソートして取得する 11.2.2.7 条件に一致するXML文書を連続して取得する 11.2.2.8 条件に一致するデータの内容を集計する 11.2.3 データの更新 11.2.3.1 データを追加する 11.2.3.2 レコードIDを指定してデータを削除する 11.2.3.3 レコードIDを指定してデータを更新する 11.2.4 コネクションの切断 11.2.5 エラー発生時の対処 11.2.5.1 エラー発生時の対処例 11.3 アプリケーションのデバッグ 11.4 C APIで使用する文字コード 第3部 その他のアプリケーション開発 第12章 XML変換機能 12.1 XML変換機能の概要 12.1.1 データベースからXML文書への変換 12.1.2 CSVファイルからXML文書への変換 12.2 XML変換機能の設計 12.2.1 入力データソースの決定 12.2.2 XML文書構造の決定 12.2.3 XML文書の出力形式を決定 12.3 XML変換機能のAPIのセットアップ 12.3.1 APIの構成 12.3.2 環境変数の設定 12.4 マッピングルールファイルの作成 12.5 アプリケーションの設計 12.5.1 API一覧 12.5.2 XML変換機能を用いたアプリケーションの処理手順 12.5.2.1 データベースからXML文書に変換する場合の処理手順 12.5.2.2 CSVファイルからXML文書に変換する場合の処理手順 12.6 APIの使用例 12.6.1 起動開始からResultSetの取得まで(データベースのレコード) 12.6.2 起動開始からResultSetの取得まで(CSVファイル) 12.6.3 XMLGeneratorの生成からXML文書の取得 12.6.4 XML変換機能のサンプルプログラム 12.7 XML変換機能の対応するデータ型 12.8 XML変換機能の対応するCSV形式 付録A API用動作環境ファイルの実行パラメタ A.1 API用動作環境ファイルの実行パラメタの種類 A.2 API用動作環境ファイルの実行パラメタの意味 A.3 API用動作環境ファイルの実行パラメタの記述例 付録B 検索式、リターン式およびソート式の書式 B.1 文法の表記方法 B.2 共通の書式 B.2.1 パス式 B.2.2 テキスト式 B.2.3 属性式 B.2.4 単一行関数指定 B.3 検索式 B.3.1 条件式 B.3.2 キーワード B.3.3 エスケープ文字 B.3.4 パターン B.3.5 文字列 B.3.6 数値 B.3.7 互換形式 B.3.8 フィルタ式 B.4 リターン式 B.4.1 集計を行わない場合の書式 B.4.2 集計を行わない場合のリターン式指定例 B.4.3 集計を行う場合の書式 B.4.4 集計を行う場合のリターン式指定例 B.5 ソート式 B.5.1 ソート式の書式 B.5.2 ソート式の指定例 付録C 定量値 C.1 検索式およびリターン式の定量値 C.2 ソート依頼における定量値 C.3 集計依頼における定量値 C.4 ダイレクトアクセスにおける定量値 付録D 資源の見積り D.1 Java APIを使用した場合のローカルメモリ量の見積り D.2 .NET APIを使用した場合のローカルメモリ量の見積り D.3 C APIを使用した場合のローカルメモリ量の見積り D.4 C APIを使用した場合のスタックサイズの見積り 付録E XML文書についての留意事項 E.1 XML文書の書式 E.2 データベース上のXML文書 E.3 テキストファイルのXML文書 E.4 XML形式に関する留意事項 E.4.1 DTD宣言に属性のデフォルト値を設定した場合 E.4.2 要素名の最初の文字に@を使用している場合 付録F Java サンプルプログラム F.1 データの検索 F.1.1 検索条件に一致するXML文書の件数を求める F.1.2 検索条件に一致するXML文書を指定した形式で取得する F.1.3 特定のXML文書をすべて取得する F.1.4 検索条件に一致するXML文書をソートして取得する F.1.5 検索条件に一致するXML文書の値を集計して取得する F.1.6 ヒット件数の上限値を設定する F.2 データの更新 F.2.1 データを追加する F.2.2 データを削除する F.2.3 データを更新する F.3 拡張的なアプリケーション F.3.1 トランザクションとShunsaku Fileを使ったサンプル F.3.2 ダイレクトアクセスキーを使用してデータを検索する F.3.3 ダイレクトアクセスキーを使用してデータを削除する F.3.4 ダイレクトアクセスキーを使用してデータを更新する 付録G C# .NET サンプルプログラム G.1 データの検索 G.1.1 検索条件に一致するXML文書の件数を求める G.1.2 検索条件に一致するXML文書を指定した形式で取得する G.1.3 特定のXML文書をすべて取得する G.1.4 検索条件に一致するXML文書をソートして取得する G.1.5 検索条件に一致するXML文書の値を集計して取得する G.1.6 ヒット件数の上限値を設定する G.2 データの更新 G.2.1 データを追加する G.2.2 データを削除する G.2.3 データを更新する G.3 拡張的なアプリケーション G.3.1 トランザクションとShunsaku Fileを使ったサンプル G.3.2 ダイレクトアクセスキーを使用してデータを検索する G.3.3 ダイレクトアクセスキーを使用してデータを削除する G.3.4 ダイレクトアクセスキーを使用してデータを更新する 付録H VB .NET サンプルプログラム H.1 データの検索 H.1.1 検索条件に一致するXML文書の件数を求める H.1.2 検索条件に一致するXML文書を指定した形式で取得する H.1.3 特定のXML文書をすべて取得する H.1.4 検索条件に一致するXML文書をソートして取得する H.1.5 検索条件に一致するXML文書の値を集計して取得する H.1.6 ヒット件数の上限値を設定する H.2 データの更新 H.2.1 データを追加する H.2.2 データを削除する H.2.3 データを更新する H.3 拡張的なアプリケーション H.3.1 トランザクションとShunsaku Fileを使ったサンプル H.3.2 ダイレクトアクセスキーを使用してデータを検索する H.3.3 ダイレクトアクセスキーを使用してデータを削除する H.3.4 ダイレクトアクセスキーを使用してデータを更新する 付録I C++ .NET サンプルプログラム I.1 データの検索 I.1.1 検索条件に一致するXML文書の件数を求める I.1.2 検索条件に一致するXML文書を指定した形式で取得する I.1.3 特定のXML文書をすべて取得する I.1.4 検索条件に一致するXML文書をソートして取得する I.1.5 検索条件に一致するXML文書の値を集計して取得する I.1.6 ヒット件数の上限値を設定する I.2 データの更新 I.2.1 データを追加する I.2.2 データを削除する I.2.3 データを更新する I.3 拡張的なアプリケーション I.3.1 トランザクションとShunsaku Fileを使ったサンプル I.3.2 ダイレクトアクセスキーを使用してデータを検索する I.3.3 ダイレクトアクセスキーを使用してデータを削除する I.3.4 ダイレクトアクセスキーを使用してデータを更新する 付録J C サンプルプログラム J.1 データの検索 J.1.1 検索条件に一致するXML文書の件数を求める J.1.2 検索条件に一致するXML文書を指定した形式で取得する J.1.3 特定のXML文書をすべて取得する J.1.4 検索条件に一致するXML文書をソートして取得する J.1.5 検索条件に一致するXML文書の値を集計して取得する J.1.6 ヒット件数の上限値を設定する J.2 データの更新 J.2.1 データを追加する J.2.2 データを削除する J.2.3 データを更新する J.3 拡張的なアプリケーション J.3.1 トランザクションとShunsaku Fileを使ったサンプル J.3.2 ダイレクトアクセスキーを使用してデータを検索する J.3.3 ダイレクトアクセスキーを使用してデータを削除する J.3.4 ダイレクトアクセスキーを使用してデータを更新する 付録K XML変換機能のAPI K.1 DocumentFountainインタフェース K.1.1 getXMLDocument K.1.2 hasXMLDocument K.1.3 setDestination K.1.4 setEncoding K.2 CSVSourceクラス K.2.1 CSVSource K.2.2 setEncoding K.2.3 setDelimiter K.2.4 setQuote K.2.5 setNullCharacter K.2.6 setFirstRecordToColumn K.2.7 setRandomMode K.2.8 getResultSet K.2.9 setEnableEscapeChar K.3 GeneratorMapクラス K.3.1 GeneratorMap K.4 XMLGeneratorクラス K.4.1 XMLGenerator K.4.2 createDocumentFountain K.5 XMLConverterExceptionクラス K.5.1 getCode K.5.2 getException K.5.3 getMessage K.6 CSVExceptionクラス K.6.1 CSVException K.7 XMLGenExceptionクラス K.7.1 XMLGenException K.8 XML変換機能のAPI使用時に出力されるエラーコード 付録L XML変換機能のマッピングルール L.1 マッピングルールファイルの定義書式 L.1.1 MappingRule L.1.2 parentRule L.1.3 columnRule L.1.4 attributeRule L.1.5 documentRule L.1.6 extensionRule L.2 マッピングルールの適用例 L.3 マッピングルールの変換例 L.3.1 タグ階層なしの抽出パターン L.3.2 タグ階層ありの抽出パターン L.3.3 固定値を抽出するパターン L.3.4 列のデータを属性として抽出するパターン L.3.5 列のデータを固定属性として抽出するパターン L.3.6 列名を属性として抽出するパターン L.3.7 集約によるタグ階層ありの抽出パターン L.3.8 バイナリデータを抽出するパターン 付録M V6.0L20以前のJava API M.1 ShunSearchクラス M.1.1 create M.1.2 executeSearch1 M.1.3 executeSearch2 M.1.4 executeSearch3 M.1.5 getHitCount M.1.6 getRetNum M.1.7 getRecNo M.1.8 getRecData M.2 ShunBatchクラス M.2.1 ShunBatch M.2.2 executeAdd M.2.3 executeDelete M.3 文字コード M.4 出力されるエラーコード 付録N V6.0L30以前のC API N.1 shunadd N.2 shundeletebyrecid N.3 shunsearch1 N.4 shunsearch2 N.5 shunsearch3 N.6 shunsort N.7 出力されるエラーコード