第 2 章 JSVR-Web サービスのインタフェース
2.3 JSVR-SOAP インタフェース
2.3.2 文字辞書のリファレンス
内容 参照先 簡易文字辞書 「2.3.3 簡易文字辞書のリファレンス」
部首辞書 「2.3.4 部首辞書のリファレンス」
文字部品辞書 「2.3.5 文字部品辞書のリファレンス」
字形辞書 「2.3.6 字形辞書のリファレンス」
単語辞書/KUIN氏名辞書 「2.3.7 単語辞書/KUIN氏名辞書のリファレンス」
住所辞書/KUIN住所辞書 「2.3.8 住所辞書/KUIN住所辞書のリファレンス」
クラス 「2.3.9 クラスのリファレンス」
なお、本章で説明されていないJSVR-SOAPサービスのサービス名、ポート名、型インタフェース等は、SOAPクライアント構築用WSDL の記述を参照してください。
2.3.1 開発のための資源
Charset-Web入力は、JSVR-SOAPサービスおよびサービスを利用したクライアントを構築するために次の資源を提供します。なお、
Charset-Web入力のインストール先を"%JapanistSVR%"と記述します。
資源 部門サーバ上のインストール先
SOAPクライアント構築用WSDL %JapanistSVR%¥webservice¥soap¥command¥JSVRWS.wsdl
Interstage SOAPサーバ構築用WSDD %JapanistSVR%¥webservice¥soap¥command¥JSVRWS_IS.wsdd
Interstage SOAPクライアント用サンプルプログラム %JapanistSVR%¥webservice¥soap¥sample¥ISSoap 以下
.NET Framework SOAPクライアント用サンプルプログラム %JapanistSVR%¥webservice¥soap¥sample¥MS.NET 以下
Axis SOAPサーバ構築用WSDD %JapanistSVR%¥webservice¥soap¥command¥JSVRWS_AX13.wsdd
Axis SOAPクライアント用サンプルプログラム %JapanistSVR%¥webservice¥soap¥sample¥Axis 以下
参考
・ 各サンプルプログラムおよびWSDLファイルの使い方については、「運用ガイド」の4.2節を参照してください。
・ 各WSDDファイルの使い方については、「導入ガイド」の5.6節を参照してください。
2.3.2 文字辞書のリファレンス
文字辞書が持つ、次のメソッドについて説明します。
名称 メソッドの種別
getCharacters() 候補取得メソッド
getCharactersCount() 候補数取得メソッド
getCharactersWithCount() 候補/候補数取得メソッド
recognizeAsCharacter() 手書き認識メソッド
2.3.2.1 getCharacters()
種別
候補取得メソッド
解説
文字集合の中から、指定された検索キーワードの条件とマッチする文字候補を検索し、これを返します。
構文
WSCharacter[ ] getCharacters(WSCharacterKeyword in0)
引数・復帰値・例外
入力パラメータ(検索キーワード)
型 WSCharacterKeyword
解説 検索キーワードオブジェクト。
復帰値
型 WSCharacter[ ]
解説 検索結果の文字オブジェクト配列。何もヒットしなかった場合は、長さ0の配列を返す。
例外
型 SOAPFaultException
解説 関数例外。
2.3.2.2 getCharactersCount()
種別
候補数取得メソッド
解説
文字集合の中から、指定された検索キーワードの条件とマッチする文字候補を検索し、この数を返します。
注意
本メソッドでは、検索キーワードオブジェクトの検索結果ページング指定(limitRange)は無視されます。
構文
int getCharactersCount(WSCharacterKeyword in0)
引数・復帰値・例外
入力パラメータ(検索キーワード)
型 WSCharacterKeyword
解説 検索キーワードオブジェクト。
復帰値
型 xsd:int
解説 検索結果数。
例外
型 SOAPFaultException
解説 関数例外。
2.3.2.3 getCharactersWithCount()
種別
候補/候補数取得メソッド
解説
候補取得メソッドと候補数取得メソッドの両方の動作を同時に行います。
構文
WSCharacter[ ] getCharactersWithCount(WSCharacterKeyword in0, IntHolder in1)
引数・復帰値・例外
入力パラメータ(検索キーワード)
型 WSCharacterKeyword
解説 検索キーワードオブジェクト。
入力パラメータ(検索結果数)
型 IntHolder
解説 検索結果数。nullの場合は検索結果数取得を行わない。
復帰値
型 WSCharacter[ ]
解説 検索結果の文字オブジェクト配列。何もヒットしなかった場合は、長さ0の配列を返す。
例外
型 SOAPFaultException
解説 関数例外。
2.3.2.4 recognizeAsCharacter()
種別
手書き認識メソッド
解説
指定の筆跡データを文字として認識し、その結果を返します。
注意
・ 本メソッドは、外字申請モデルの場合にのみ有効です。それ以外の運用形態では使用しないでください。詳しくは「◆手書き認識 機能について」を参照してください。
・ 外字データライブラリの管理機能で作成し、Charset-Web入力へ反映したユーザ定義基盤外字を、本メソッドで検索することはで きません。
・ 本メソッドでは、筆跡データを漢字として認識します。
構文
WSCharacter[ ] recognizeAsCharacter(WSStrokeData in0)
引数・復帰値・例外
入力パラメータ(検索キーワード)
型 WSStrokeData
解説 筆跡データオブジェクト。
復帰値
型 WSCharacter[ ]
解説 検索結果の文字オブジェクト配列。
例外
型 SOAPFaultException
解説 関数例外。