第 2 章 JSVR-Web サービスのインタフェース
2.3 JSVR-SOAP インタフェース
2.3.9 クラスのリファレンス
2.3.9.2 WSCharacterKeyword
構文
WSCharacter[ ] recognizeAsCharacter(WSStrokeData in0)
引数・復帰値・例外
入力パラメータ(検索キーワード)
型 WSStrokeData
解説 筆跡データオブジェクト。
復帰値
型 WSCharacter[ ]
解説 検索結果の文字オブジェクト配列。
例外
型 SOAPFaultException
解説 関数例外。
型 WSRawCharacter[ ]
解説 検索結果の簡易文字オブジェクト配列。何もヒットしなかった場合は、長さ0の配列を返す。
例外
型 SOAPFaultException
解説 関数例外。
2.3.3.2 getRawCharactersCount()
種別
候補数取得メソッド
解説
文字集合の中から、指定された検索キーワードの条件とマッチする文字候補を検索し、この数を返します。
注意
本メソッドでは、検索キーワードオブジェクトの検索結果ページング指定(limitRange)は無視されます。
構文
int getRawCharactersCount(WSCharacterKeyword in0)
引数・復帰値・例外
入力パラメータ(検索キーワード)
型 WSCharacterKeyword
解説 検索キーワードオブジェクト。limitRange、codeRanges、glyphCodeRanges、およびmaximizerのみ有効である。また、
maximizer(WSCharacterMaximizer)においては、glyphMaximizerプロパティのみ有効である。
各プロパティの詳細については、「2.3.9.2 WSCharacterKeyword」の説明を参照すること。
復帰値
型 xsd:int
解説 検索結果数。
例外
型 SOAPFaultException
解説 関数例外。
2.3.3.3 getRawCharactersWithCount()
種別
候補/候補数取得メソッド
解説
候補取得メソッドと候補数取得メソッドの両方の動作を同時に行います。
構文
WSRawCharacter[ ] getRawCharactersWithCount(WSCharacterKeyword in0, IntHolder in1)
引数・復帰値・例外
入力パラメータ(検索キーワード)
型 WSCharacterKeyword
解説 検索キーワードオブジェクト。limitRange、codeRanges、glyphCodeRanges、およびmaximizerのみ有効である。また、
maximizer(WSCharacterMaximizer)においては、glyphMaximizerプロパティのみ有効である。
各プロパティの詳細については、「2.3.9.2 WSCharacterKeyword」の説明を参照すること。
入力パラメータ(検索結果数)
型 IntHolder
解説 検索結果数。nullの場合は検索結果数取得を行わない。
復帰値
型 WSRawCharacter[ ]
解説 検索結果の簡易文字オブジェクト配列。何もヒットしなかった場合は、長さ0の配列を返す。
例外
型 SOAPFaultException
解説 関数例外。
2.3.3.4 recognizeAsRawCharacter()
種別
手書き認識メソッド
解説
指定の筆跡データを簡易文字として認識し、その結果を返します。
注意
・ 本メソッドは、外字申請モデルの場合にのみ有効です。それ以外の運用形態では使用しないでください。詳しくは「◆手書き認識 機能について」を参照してください。
・ 外字データライブラリの管理機能で作成し、Charset-Web入力へ反映したユーザ定義基盤外字を、本メソッドで検索することはで きません。
・ 本メソッドでは、筆跡データを漢字として認識します。
構文
WSRawCharacter[ ] recognizeAsRawCharacter(WSStrokeData in0)
引数・復帰値・例外
入力パラメータ(検索キーワード)
型 WSStrokeData
解説 筆跡データオブジェクト。
復帰値
型 WSRawCharacter[ ]
解説 検索結果の簡易文字オブジェクト配列。
例外
型 SOAPFaultException
解説 関数例外。
2.3.4 部首辞書のリファレンス
部首辞書が持つ、次のメソッドについて説明します。
名称 メソッドの種別
getRadicals() 候補取得メソッド
getRadicalsCount() 候補数取得メソッド
getRadicalsWithCount() 候補/候補数取得メソッド
2.3.4.1 getRadicals()
種別
候補取得メソッド
解説
部首集合の中から、指定された検索キーワードの条件とマッチする部首候補を検索し、これを返します。
構文
WSRadical[ ] getRadicals(WSRadicalKeyword in0)
引数・復帰値・例外
入力パラメータ(検索キーワード)
型 WSRadicalKeyword
解説 検索キーワードオブジェクト。
復帰値
型 WSRadical[ ]
解説 検索結果の部首オブジェクト配列。何もヒットしなかった場合は、長さ0の配列を返す。
例外
型 SOAPFaultException
解説 関数例外。
2.3.4.2 getRadicalsCount()
種別
候補数取得メソッド
解説
部首集合の中から、指定された検索キーワードの条件とマッチする部首候補を検索し、この数を返します。
注意
本メソッドでは、検索キーワードオブジェクトの検索結果ページング指定(limitRange)は無視されます。
構文
int getRadicalsCount(WSRadicalKeyword in0)
引数・復帰値・例外
入力パラメータ(検索キーワード)
型 WSRadicalKeyword
解説 検索キーワードオブジェクト。
復帰値
型 xsd:int
解説 検索結果数。
例外
型 SOAPFaultException
解説 関数例外。
2.3.4.3 getRadicalsWithCount()
種別
候補/候補数取得メソッド
解説
候補取得メソッドと候補数取得メソッドの両方の動作を同時に行います。
構文
WSRadical[ ] getRadicalsWithCount(WSRadicalKeyword in0, IntHolder in1)
引数・復帰値・例外
入力パラメータ(検索キーワード)
型 WSRadicalKeyword
解説 検索キーワードオブジェクト。
入力パラメータ(検索結果数)
型 IntHolder
解説 検索結果数。nullの場合は検索結果数取得を行わない。
復帰値
型 WSRadical[ ]
解説 検索結果の部首オブジェクト配列。何もヒットしなかった場合は、長さ0の配列を返す。
例外
型 SOAPFaultException
解説 関数例外。
2.3.5 文字部品辞書のリファレンス
文字部品辞書が持つ、次のメソッドについて説明します。
名称 メソッドの種別
getParts() 候補取得メソッド
getPartsCount() 候補数取得メソッド
getPartsWithCount() 候補/候補数取得メソッド
recognizeAsPart() 文字部品候補取得メソッド
2.3.5.1 getParts()
種別
候補取得メソッド
解説
文字部品集合の中から、指定された検索キーワードの条件とマッチする部首候補を検索し、これを返します。
構文
WSPart[ ] getParts(WSPartKeyword in0)
引数・復帰値・例外
入力パラメータ(検索キーワード)
型 WSPartKeyword
解説 検索キーワードオブジェクト。
復帰値
型 WSPart[ ]
解説 検索結果の文字部品オブジェクト配列。何もヒットしなかった場合は、長さ0の配列を返す。
例外
型 SOAPFaultException
解説 関数例外。
2.3.5.2 getPartsCount()
種別
候補数取得メソッド
解説
文字部品集合の中から、指定された検索キーワードの条件とマッチする文字部品候補を検索し、この数を返します。
注意
本メソッドでは、検索キーワードオブジェクトの検索結果ページング指定(limitRange)は無視されます。
構文
int getPartsCount(WSPartKeyword in0)
引数・復帰値・例外
入力パラメータ(検索キーワード)
型 WSPartKeyword
解説 検索キーワードオブジェクト。
復帰値
型 xsd:int
解説 検索結果数。
例外
型 SOAPFaultException
解説 関数例外。
2.3.5.3 getPartsWithCount()
種別
候補/候補数取得メソッド
解説
候補取得メソッドと候補数取得メソッドの両方の動作を同時に行います。
構文
WSPart[ ] getPartsWithCount(WSPartKeyword in0, IntHolder in1)
引数・復帰値・例外
入力パラメータ(検索キーワード)
型 WSPartKeyword
解説 検索キーワードオブジェクト。
入力パラメータ(検索結果数)
型 IntHolder
解説 検索結果数。nullの場合は検索結果数取得を行わない。
復帰値
型 WSPart[ ]
解説 検索結果の文字部品オブジェクト配列。何もヒットしなかった場合は、長さ0の配列を返す。
例外
型 SOAPFaultException
解説 関数例外。
2.3.5.4 recognizeAsPart()
種別
手書き認識メソッド
解説
指定の筆跡データを文字部品として認識し、これを返します。
構文
WSPart[ ] recognizeAsPart(WSStrokeData in0)
引数・復帰値・例外
入力パラメータ(検索キーワード)
型 WSStrokeData
解説 筆跡データオブジェクト。
復帰値
型 WSPart[ ]
解説 検索結果の文字部品オブジェクト配列。
例外
型 SOAPFaultException
解説 関数例外。
2.3.6 字形辞書のリファレンス
字形辞書が持つ、次のメソッドについて説明します。
名称 メソッドの種別
getGlyphs() 候補取得メソッド
2.3.6.1 getGlyphs()
種別
候補数取得メソッド
解説
字形集合の中から、指定された検索キーワードの条件とマッチする字形候補を検索し、これを返します。
構文
WSGlyph[ ] getGlyphs(WSGlyphKeyword in0)
引数・復帰値・例外
入力パラメータ(検索キーワード)
型 WSGlyphKeyword
解説 検索キーワードオブジェクト。
復帰値
型 WSGlyph[ ]
解説 検索結果の字形オブジェクト配列。何もヒットしなかった場合は、長さ0の配列を返す。
例外
型 SOAPFaultException
解説 関数例外。
注意
Charset-Web入力 V7.0/7.0で提供していたgetGlyphsCount()メソッドについては、本バージョンでは下位互換性を保つため以外の目
的での使用を非推奨とします。
この非推奨メソッドを使用する場合は、JSVR-SOAPサービスの設定/開発時に使用するWSDD/WSDLファイル内に、getGlyphsCount() の情報を定義する必要があります。Charset-Web入力 V7.0/7.0で使用していたWSDD/WSDLを参考に、WSDD/WSDLの以下の場 所に記述を追加してください。
WSDD
－ <service>の子要素にgetGlyphsCount用<operation>を追加
－ <service>の子要素<parameter name="allowedMethods">のvalue属性に、getGlyphsCountを追加 WSDL
－ <portType>の子要素にgetGlyphsCount用<operation>を追加
－ <binding>の子要素にgetGlyphsCount用<operation>を追加
2.3.7 単語辞書/KUIN 氏名辞書のリファレンス
単語辞書/KUIN氏名辞書が持つ、次のメソッドについて説明します。
名称 メソッドの種別
getWords()
getWordsByKuinName()
候補取得メソッド
getWordsCount()
getWordsCountByKuinName()
候補数取得メソッド
getWordsWithCount()
getWordsWithCountByKuinName()
候補/候補数取得メソッド
2.3.7.1 getWords() / getWordsByKuinName()
種別
候補取得メソッド
解説
単語集合の中から、指定された検索キーワードの条件とマッチする単語候補を検索し、これを返します。
構文
単語辞書WSWord[ ] getWords(WSWordKeyword in0) KUIN氏名辞書
WSWord[ ] getWordsByKuinName(WSWordKeyword in0)
引数・復帰値・例外
入力パラメータ(検索キーワード)
型 WSWordKeyword
解説 検索キーワードオブジェクト。
復帰値
型 WSWord[ ]
解説 検索結果の単語オブジェクト配列。何もヒットしなかった場合は、長さ0の配列を返す。
例外
型 SOAPFaultException
解説 関数例外。
2.3.7.2 getWordsCount() / getWordsCountByKuinName()
種別
候補数取得メソッド
解説
単語集合の中から、指定された検索キーワードの条件とマッチする単語候補を検索し、この数を返します。
注意
本メソッドでは、検索キーワードオブジェクトの検索結果ページング指定(limitRange)は無視されます。
構文
単語辞書int getWordsCount(WSWordKeyword in0) kUIN氏名辞書
int getWordsCountByKuinName(WSWordKeyword in0)
引数・復帰値・例外
入力パラメータ(検索キーワード)
型 WSWordKeyword
解説 検索キーワードオブジェクト。
復帰値
型 xsd:int
解説 検索結果数。
例外
型 SOAPFaultException
解説 関数例外。
2.3.7.3 getWordsWithCount() / getWordsWithCountByKuinName()
種別
候補/候補数取得メソッド
解説
候補取得メソッドと候補数取得メソッドの両方の動作を同時に行います。
構文
単語辞書WSWord[ ] getWordsWithCount(WSWordKeyword in0, IntHolder in1) KUIN氏名辞書
WSWord[ ] getWordsWithCountByKuinName(WSWordKeyword in0, IntHolder in1)
引数・復帰値・例外
入力パラメータ(検索キーワード)
型 WSWordKeyword
解説 検索キーワードオブジェクト。
入力パラメータ(検索結果数)
型 IntHolder
解説 検索結果数。nullの場合は検索結果数取得を行わない。
復帰値
型 WSWord[ ]
解説 検索結果の単語オブジェクト配列。何もヒットしなかった場合は、長さ0の配列を返す。
例外
型 SOAPFaultException
解説 関数例外。
2.3.8 住所辞書/KUIN 住所辞書のリファレンス
単語辞書/KUIN氏名辞書が持つ、次のメソッドについて説明します。
名称 機能
getAddresses() getAddressesByKuin()
候補取得メソッド