connectFile()
プロトタイプ
オブジェクト型クラスメソッド
(ConceptBase) connectFile((String) host, (number) port, (String) id, (String) pwd)
概要
ConceptBase への接続設定
入力値
(String) host : ConceptBase サーバのアドレス
(number) port : ConceptBase サーバのサービス提供ポート
(String) id : 検索ユーザ
(String) pwd: 検索ユーザで認証を受けるためのパスワード
返却値
ConceptBase 接続オブジェクト
詳細
ConceptBase サーバの動作しているサーバアドレスとポート番号を指定して検索をする ConceptBase サーバへの接続設定を行います。
検索ユーザは、ConceptBase に検索をさせる場合の権限チェックに利用されるもので、ConceptBase が動作しているコンピュータの参加している Windows NT/2000 のネットワークドメインのドメインユーザ権限(ロール Domain Users)をもっているユーザを指定して下さい(ドメインユーザの設定は、Windows のドメインユーザマネージャーで予め設定しておいて下さい)。
このメソッドで生成される ConceptBase 接続オブジェクトは、ファイルを検索するためのオブジェクトになります。
connectDatabase()
プロトタイプ
オブジェクト型クラスメソッド
(ConceptBase) connectDatabase((String) host, (number) port, (String) id, (String) pwd)
概要
ConceptBase への接続設定
入力値
(String) host : ConceptBase サーバのアドレス
(number) port : ConceptBase サーバのサービス提供ポート
(String) id : 検索ユーザ
(String) pwd: 検索ユーザで認証を受けるためのパスワード
返却値
ConceptBase 接続オブジェクト
詳細
ConceptBase サーバの動作しているサーバアドレスとポート番号を指定して検索をする ConceptBase サーバへの接続設定を行います。
検索ユーザは、ConceptBase に検索をさせる場合の権限チェックに利用されるもので、ConceptBase サーバ が動作しているコンピュータが参加している Windows NT/2000 のネットワークドメインのドメインユーザ権限(ロール Domain Users)をもっているユーザを指定して下さい(ドメインユーザの設定は、Windows のドメインユーザマネージャーで予め設定しておいて下さい)。
このメソッドで生成される ConceptBase 接続オブジェクトは、データベースを検索するためのオブジェクトになります。データベース内の情報を検索するには、別途 CB RDBゲートウェイが必要になります。
indexFiles()
プロトタイプ
オブジェクト型インスタンスメソッド
(Object) indexFiles()
概要
文書データベース一覧の取得
入力値
なし
返却値
文書データベース一覧
詳細
指定の検索ユーザに対して参照権限の与えられている文書データベースの一覧を取得します。
返却値はオブジェクト型で、文書データベースIDをプロパティとし、対応する文書データベース名をそのプロパティ値とします。
search()
プロトタイプ
配列型インスタンスメソッド
(Array) search((String) fields, (String) tables, (String) preConstraint, (String) query, (number) max)
概要
文書検索
入力値
(String) fields: 取得フィールド
(String) tables: 検索対象の文書データベース
(String) preConstraint: 絞込条件
(String) query: 検索文字列(キーワード)
(number) max: 検索結果の最大取得件数
返却値
検索結果配列
詳細
条件を元に文書検索した結果を取得します。
引数 fields には、取得する情報のキーワードを指定します。
引数 fields に指定可能なキーワードは、文書データベースを作成する際の属性情報のキーワード名になります(例:title, PubDate, auther など)。文書データベースを定義する際に独自のインデックスファイルを作成している場合には、任意の属性情報を取得できます(この場合、XML タグ名が fields に指定するキーワード名となります)。
引数 fields に対して CSV 形式(カンマ区切り)で指定することにより、複数の属性キーワードを同時に指定することができます。
引数 tables には、文書データベースのIDを指定します。
この文書データベースIDとは、indexFiles() で取得した文書データベースIDをいいます。
引数 fields に対して CSV 形式(カンマ区切り)で指定することにより、複数の属性キーワードを同時に指定することができます。
引数 preConstraint には、検索の前提条件(絞込条件)となるキーワードを指定することができます。この条件を満たす情報から検索を行うので、絞り込みを行った方が検索速度が速くなります。
絞込条件は、完全一致検索になります。また、絞込条件となるキーワードを複数指定する場合には、各キーワードを空白(0x20)で区切って指定して下さい。
引数 query には、検索文字列を指定します。検索キーワードは自然文を許容します。
引数 max には、検索結果の最大取得件数を指定します。この引数の値を大きくするとサーバおよびネットワークの負荷になります。
返却する配列の各要素は、引数 fields に指定した各属性値をプロパティとして持っている CBDocument 型のオブジェクトになります。
match()
プロトタイプ
配列型インスタンスメソッド
(Array) match((String) fields, (String) query, (number) max)
概要
文書検索
入力値
(String) fields: 取得フィールド
(String) query: 検索文字列(キーワード)
(number) max: 検索結果の最大取得件数
返却値
検索結果配列
詳細
条件を元に指定の検索ユーザで検索可能なすべての文書データベースに対して文書検索した結果を取得します。
引数 fields には、取得する情報のキーワードを指定します。
引数 fields に指定可能なキーワードは、文書データベースを作成する際の属性情報のキーワード名になります(例:title, PubDate, auther など)。文書データベースを定義する際に独自のインデックスファイルを作成している場合には、任意の属性情報を取得できます(この場合、XML タグ名が fields に指定するキーワード名となります)。
引数 fields に対して CSV 形式(カンマ区切り)で指定することにより、複数の属性キーワードを同時に指定することができます。
引数 query には、検索文字列を指定します。検索キーワードは自然文を許容します。
引数 max には、検索結果の最大取得件数を指定します。この引数の値を大きくするとサーバおよびネットワークの負荷になります。
返却する配列の各要素は、引数 fields に指定した各属性値をプロパティとして持っている CBDocument 型のオブジェクトになります。
get()
プロトタイプ
オブジェクト型インスタンスメソッド
(CBDocument) get((String) fields, (String) docid)
概要
ドキュメント情報取得
入力値
(String) fields: 取得フィールド
(String) docid: ドキュメントID
返却値
なし
詳細
特定の文書の情報を取得します。
引数 fields には、取得する情報のキーワードを指定します。
引数 fields に指定可能なキーワードは、文書データベースを作成する際の属性情報のキーワード名になります(例:title, PubDate, auther など)。文書データベースを定義する際に独自のインデックスファイルを作成している場合には、任意の属性情報を取得できます(この場合、XML タグ名が fields に指定するキーワード名となります)。
引数 fields に対して CSV 形式(カンマ区切り)で指定することにより、複数の属性キーワードを同時に指定することができます。
引数 docid には、取得する文書のIDを指定します。
lastErrorCode()
プロトタイプ
数値型インスタンスメソッド
(number) lastErrorCode()
概要
最終エラーコードの取得
入力値
なし
返却値
エラーコード
詳細
この ConceptBase 接続オブジェクトで最後に発生したエラーのエラーコードを返却します。
0 は正常処理を意味し、-1 は予期せぬエラーまたは致命的なエラーを意味します。その他のエラーコードは、ConceptBase のエラーコードの仕様に準じます。
このオブジェクトを利用して、ConceptBase へのアクセスをまだ行っていない場合には、NaN が返却されます。
lastErrorMessage()
プロトタイプ
文字列型インスタンスメソッド
(Stirng) lastErrorMessage()
概要
最終エラーメッセージの取得
入力値
なし
返却値
エラーメッセージ
詳細
この ConceptBase 接続オブジェクトで最後に発生したエラーのエラーメッセージを返却します。