uCosminexus Enterprise Search プログラマーズガイド　Javaインターフェース編

解説・文法書

3020-3-H94

目　　次

前書き

はじめに

1.　uCosminexus Enterprise Search Javaインターフェースの概要

1.1　提供する機能

2.　開発環境

2.1　開発環境

2.2　コンパイルおよび実行方法

3.　クラスメソッドの発行順序の例

3.1　クラスメソッドの発行順序の例

3.2　コーディング例

4.　IwsAttributeクラス

4.1　クラスの概要

4.2　コンストラクタの詳細

4.2.1　IwsAttribute

4.3　メソッドの詳細

4.3.1　getName

4.3.2　getValue

5.　IwsResultPageHelperクラス

5.1　クラスの概要

5.2　コンストラクタの詳細

5.2.1　IwsResultPageHelper

5.3　メソッドの詳細

5.3.1　getCurrentPage

5.3.2　isStartPage

5.3.3　isLastPage

5.3.4　getLastPageNum

5.3.5　getPageList

5.3.6　getPageIndex

5.3.7　getPrevPageIndex

5.3.8　getNextPageIndex

5.3.9　getLastPageIndex

6.　IwsSearchCondクラス

6.1　クラスの概要

6.1.1　フィールドの詳細

6.2　コンストラクタの詳細

6.2.1　IwsSearchCond

6.3　メソッドの詳細

6.3.1　addAddress

6.3.2　addAttribute

6.3.3　addAttributeOr

6.3.4　addAuthor

6.3.5　addCrawlType

6.3.6　addExtension

6.3.7　addFileName

6.3.8　clearAddressList

6.3.9　clearAttribute

6.3.10　clearAttributeOr

6.3.11　clearAuthorList

6.3.12　clearCrawlType

6.3.13　clearExtension

6.3.14　clearFileNameList

6.3.15　getAddressList

6.3.16　getAttribute

6.3.17　getAttributeOr

6.3.18　getAuthorList

6.3.19　getCount

6.3.20　getCountOnly

6.3.21　getCrawlTypeList

6.3.22　getDate

6.3.23　getDateFilterType

6.3.24　getEndDate

6.3.25　getExtensionList

6.3.26　getFileNameList

6.3.27　getHighLightClassName

6.3.28　getKeyword

6.3.29　getMaxSize

6.3.30　getMinSize

6.3.31　getOrder

6.3.32　getSearchLoginID

6.3.33　getSentence

6.3.34　getSimilarID

6.3.35　getSnippetSize

6.3.36　getSort

6.3.37　getStartIndex

6.3.38　getUseHighLight

6.3.39　getUseHtmlEscape

6.3.40　setCount

6.3.41　setCountOnly

6.3.42　setDate

6.3.43　setDateFilterType

6.3.44　setEndDate

6.3.45　setHighLightClassName

6.3.46　setKeyword

6.3.47　setMaxSize

6.3.48　setMinSize

6.3.49　setOrder

6.3.50　setSearchLoginID

6.3.51　setSentence

6.3.52　setSimilarID

6.3.53　setSnippetSize

6.3.54　setSort

6.3.55　setStartIndex

6.3.56　setUseHighLight

6.3.57　setUseHtmlEscape

7.　IwsSearcherクラス

7.1　クラスの概要

7.2　コンストラクタの詳細

7.2.1　IwsSearcher

7.3　メソッドの詳細

7.3.1　getTimeout

7.3.2　search

7.3.3　setLog

7.3.4　setLoginID

7.3.5　setPassword

7.3.6　setTimeout

8.　IwsSearchExceptionクラス

8.1　クラスの概要

8.2　コンストラクタの詳細

8.3　メソッドの詳細

8.3.1　getMessage

8.3.2　getMessageID

8.3.3　getPartialMessage

9.　IwsSearchLoggerインターフェース

9.1　インターフェースの概要

9.2　メソッドの詳細

9.2.1　debug

9.2.2　error

9.2.3　info

9.2.4　isDebugEnabled

9.2.5　isErrorEnabled

9.2.6　isInfoEnabled

9.2.7　isTraceEnabled

9.2.8　isWarnEnabled

9.2.9　trace

9.2.10　warn

10.　IwsSearchResultクラス

10.1　クラスの概要

10.2　メソッドの詳細

10.2.1　getEntryCount

10.2.2　getHitCount

10.2.3　getPageShowCount

10.2.4　getResultList

10.2.5　getSearchID

10.2.6　getSimilarID

10.2.7　getSimilarTitle

10.2.8　getStartIndex

10.2.9　getWarnMessageList

10.2.10　isOverHit

11.　IwsSearchResultEntryクラス

11.1　クラスの概要

11.1.1　フィールドの詳細

11.2　メソッドの詳細

11.2.1　getAttributes

11.2.2　getAuthor

11.2.3　getCrawlerName

11.2.4　getDataType

11.2.5　getDate

11.2.6　getEntryID

11.2.7　getPath

11.2.8　getSize

11.2.9　getSnippet

11.2.10　getTitle

11.2.11　getUrl

11.2.12　isExist

12.　IwsSearchUtilクラス

12.1　クラスの概要

12.2　メソッドの詳細

12.2.1　convertAndOrNotKeyword

13.　検索サーバーとの認証とアクセス権検索

13.1　検索サーバーとの認証とアクセス権検索の対応

14.　Enterprise Search Javaインターフェースのログ

14.1　ログ内容

14.2　アプリケーションプログラム上でのログ出力先の指定方法

15.　注意事項

15.1　Enterprise Search Javaインターフェースを使用する際の注意事項

16.　エラーメッセージ

16.1　出力形式

16.1.1　メッセージの説明形式

16.2　メッセージ一覧

KMES15000-E

KMES15001-E

KMES15002-E

KMES15003-E

KMES15005-E

KMES15006-E

KMES15007-E

KMES15008-E

KMES15009-E

付録

付録A　このマニュアルの参考情報

付録A.1　関連マニュアル

付録A.2　英略語

索引

[他社商品名称に関する表示]

All Rights Reserved. Copyright (C) 2013, Hitachi, Ltd.
All Rights Reserved. Copyright (C) 2013, Hitachi Solutions, Ltd.

前書き

■ 対象商品

R-1595S-13　 uCosminexus Enterprise Search 08-72　 （適用OS：Windows Server 2003 R2，Windows Server 2008，Windows Server 2008 R2）

■ 輸出時の注意

本製品を輸出される場合には、外国為替及び外国貿易法の規制並びに米国輸出管理規則など外国の輸出関連法規をご確認の上、必要な手続きをお取りください。
なお、不明な場合は、弊社担当営業にお問い合わせください。

■ 商標類

Active Directoryは，米国Microsoft Corporationの，米国およびその他の国における登録商標または商標です。
Lotus Notesは，IBM Corporationの登録商標です。
MicrosoftおよびWindowsは，米国Microsoft Corporationの米国およびその他の国における登録商標または商標です。
OracleとJavaは，Oracle Corporation 及びその子会社，関連会社の米国及びその他の国における登録商標です。
SiteMinderは，CA, Inc.の米国およびその他の国における登録商標または商標です。

■ マイクロソフト製品の表記について

このマニュアルでは，マイクロソフト製品の名称を次のように表記しています。

製品名称
略称

Microsoft(R) Windows Server(R) 2003 R2 Standard Edition
Microsoft(R) Windows Server(R) 2003 R2 Enterprise Edition
Windows Server 2003 R2

Microsoft(R) Windows Server(R) 2003 R2, Standard x64 Edition
Microsoft(R) Windows Server(R) 2003 R2, Enterprise x64 Edition

Microsoft(R) Windows Server(R) 2008 Standard
Microsoft(R) Windows Server(R) 2008 Enterprise
Windows Server 2008

Microsoft(R) Windows Server(R) 2008 Standard（x64）
Microsoft(R) Windows Server(R) 2008 Enterprise（x64）

Microsoft(R) Windows Server(R) 2008 R2 Standard（x64）
Microsoft(R) Windows Server(R) 2008 R2 Enterprise（x64）
Windows Server 2008 R2

■ 発行

2013年4月 3020-3-H94

■ 著作権

All Rights Reserved. Copyright (C) 2013, Hitachi, Ltd.
All Rights Reserved. Copyright (C) 2013, Hitachi Solutions, Ltd.

はじめに

このマニュアルはuCosminexus Enterprise SearchのJavaインターフェースを使用して検索結果を取得するアプリケーションプログラムを開発する方法について説明します。

なお，以降このマニュアルではuCosminexus Enterprise SearchをEnterprise Searchと表記します。

対象読者

このマニュアルはEnterprise Searchを使用してアプリケーションプログラムの開発を行うユーザーを対象にしています。次の内容を理解されていることを前提としています。

Windowsの操作に関する知識

Java言語に関する知識

1.　uCosminexus Enterprise Search Javaインターフェースの概要

この章では，Enterprise SearchのJavaインターフェースの概要を説明します。

＜この章の構成＞

1.1　提供する機能

1.1　提供する機能

Enterprise SearchのJavaインターフェースは，アプリケーションプログラムからEnterprise Searchの検索結果を取得する機能を提供しています。これにより，様々な検索結果の取得をアプリケーションプログラムから実行できるようになります。

Enterprise SearchのJavaインターフェースから利用可能な機能の一覧は次のとおりです。各機能の詳細な使用方法は４章から12章のクラスおよびメソッドを参照してください。

表1-1　Enterprise SearchのJavaインターフェースから利用可能な機能の一覧

機能名 | 内容/備考
キーワード検索 | 単純キーワードやAND OR NOTおよびフレーズ検索など検索画面の1行検索と同じキーワードが指定できます。
ユーザー名検索 | コンテンツのユーザー名を指定して検索結果を絞り込みます。
ファイル名検索 | コンテンツのファイル名で検索結果を絞り込みます。
日時範囲検索 | 前後1ヶ月以内/以前/以降/特定の範囲を指定可能です。
文章検索 | 文章を指定した自然文検索ができます。
クロールタイプ検索 | WWWやNTFSなどのクロールタイプを指定して検索結果を絞り込むことができます。
アドレス検索 | コンテンツのアドレス情報を指定して検索結果を絞り込むことができます。
類似コンテンツ検索 | 検索結果のIDを利用して類似コンテンツを検索します。
拡張子検索 | 拡張子を指定して検索結果を絞り込むことができます。
ファイルサイズ検索 | ファイルサイズを指定して検索結果を絞り込むことができます。
検索結果のソート順指定 | 検索結果のソート順を指定することができます。
検索結果開始インデクスの指定 | 指定した検索条件の検索結果の任意のインデクス（N件目の位置）の検索結果を取得できます。
スニペットサイズの指定 | スニペット（検索結果エントリの本文の抜き書き）の取得サイズを指定できます。
ハイライトタグの埋め込み指定 | 検索結果のタイトルとスニペット内の，検索キーワード部分を<span>タグで囲むかどうかを指定することができます。
ハイライトタグのクラス属性名指定 | 検索結果のタイトルとスニペット内の，検索キーワード部分に指定される<span>タグのクラス属性名が指定できます。
HTMLエスケープの指定 | タイトルとスニペット内に含まれるHTML特殊文字のエスケープ有無を指定することができます。
ヒット件数返却指定 | 検索時にヒット件数だけを高速に返却することができます。
属性検索 | コンテンツの属性を指定して検索結果を絞り込みできます。

2.　開発環境

この章では，Enterprise SearchのJavaインターフェースを利用する上で必要となる開発環境について説明します。

＜この章の構成＞

2.1　開発環境

2.2　コンパイルおよび実行方法

2.1　開発環境

Enterprise SearchのJavaインターフェースを使用したアプリケーションプログラムを作成および実行する同一装置内に，次のソフトウェアが必要です。

P-2443-7D84　uCosminexus Application Server Standard　08-50　以降
または

P-2443-7K84　uCosminexus Application Server Enterprise　08-50　以降

これらのソフトウェアは次のOSに対応しています。

Windows Server 2003 R2

Windows Server 2008

Windows Server 2008 R2

2.2　コンパイルおよび実行方法

Enterprise SearchのJavaインターフェースを利用したアプリケーションプログラムをコンパイルおよび実行する場合は，アプリケーションプログラムのクラスパスに次のファイルを追加してください。

Enterprise Searchインストールディレクトリ¥lib¥iwsSearch.jar

3.　クラスメソッドの発行順序の例

この章では，クラスメソッドの発行順序の例を説明します。

＜この章の構成＞

3.1　クラスメソッドの発行順序の例

3.2　コーディング例

3.1　クラスメソッドの発行順序の例

Enterprise Search のJavaインターフェースで提供するクラスメソッドを使用してアプリケーションプログラムを作成する場合の，メソッドの発行順序の例を次に示します。使用するクラスメソッドに関する説明は，図の右に記載している章を参照してください。

3.2　コーディング例

3.1の図のコーディング例を次に示します。コーディング例は次のパスにあります。

Enterprise Searchインストールディレクトリ¥lib¥sample¥ApiSample.java

コーディング例（1/3）

import java.text.ParseException;
import java.text.SimpleDateFormat;
import java.util.Date;

import jp.co.hitachi_system.iwsearch.lib.client.IwsSearchCond;
import jp.co.hitachi_system.iwsearch.lib.client.IwsSearchResult;
import jp.co.hitachi_system.iwsearch.lib.client.IwsSearchResultEntry;
import jp.co.hitachi_system.iwsearch.lib.client.IwsSearcher;
import jp.co.hitachi_system.iwsearch.lib.client.exception.IwsSearchException;

/*
* All Rights Reserved. Copyright (C) 2013, Hitachi Solutions, Ltd.
*/

/**
* APIサンプルコード
*/
public class ApiSample {

   public static void main(String[] args) {

       if( args.length != 1){
           System.err.println("検索するキーワードが指定されていません。 ");
           System.err.println("usage :ApiSample keyword ");
       }

       /* 検索条件を格納するIwsSearchCondクラスのインスタンスを生成します */
       IwsSearchCond cond = new IwsSearchCond();

       /* 引数で指定した検索するキーワードをIwsSearchCondクラスにセットします */
       cond.setKeyword(args[0]);

       /* 検索するコンテンツの拡張子を指定する */
       cond.addExtension("doc");
       cond.addExtension("docx");

       /* NTFSクローラが集めたコンテンツを検索対象にする */
       cond.addCrawlType(IwsSearchCond.CRAWL_TYPE_NTFS);
       Date searchDate = null;

コーディング例（2/3）

       try {
           /* 更新日付が2013年1月1日以降のコンテンツを検索対象にする */
           searchDate = SimpleDateFormat.getDateInstance().parse("2013/01/01");
           cond.setDate(searchDate);
           cond.setDateFilterType(IwsSearchCond.DATE_TYPE_AFTER);

       }catch (ParseException e) {
           System.err.println("日付のフォーマットが不正です。");
           return;
       }

       /* 受け取る検索結果の件数を指定します */
       cond.setCount(100);

       /* 検索結果のソート順を更新日時の降順に設定します */
       cond.setSort(IwsSearchCond.SORT_KEY_DATE);
       cond.setOrder(IwsSearchCond.SORT_ORDER_DESC);

       /* 検索結果のタイトルと本文は、標準でHTML特殊文字がエスケープされ
        * ハイライトタグが埋め込まれてます。
        * このサンプルはコンソールアプリケーションなのでHTML特殊文字の
        * エスケープをOFFにします。ハイライトタグの埋め込みはHTML特殊文字の
        * エスケープがOFFの時は自動的にOFFになります。
        */
       cond.setUseHtmlEscape(false);

       /* 検索を行うIwsSearcherクラスのインスタンスを生成します
        * 引数には接続するuCosminexus Enterprise SearchのURLを指定します
        */
       IwsSearcher searcher = new IwsSearcher("http://localhost/iwsearch");

       /*
        * 検索する時に必要な認証IDとパスワードを設定します
        */
       searcher.setLoginID("loginid");
       searcher.setPassword("password");

       /* 検索結果を受け取るインスタンスを宣言します */
       IwsSearchResult result = null;
       try {
           /* 検索を行い、検索結果を受け取ります */
           result = searcher.search(cond);
       }catch (IwsSearchException e) {
           /* 検索中にエラーが発生した場合は、エラー情報を出力して終了します */
           System.err.println("検索中にエラーが発生しました。");
           System.err.println(e.getMessage());
           return;
       }

コーディング例（3/3）

       /* ヒット件数を画面に表示する */
       System.out.println("ヒット件数:"+result.getHitCount());

       /* ヒットしたコンテンツのタイトルを画面に表示する */
       for(IwsSearchResultEntry lEntry : result.getResultList()){
           System.out.println("title:"+lEntry.getTitle());
       }

       /* 検索終了 */
       return;
   }
}

4.　IwsAttributeクラス

この章では，検索結果エントリの属性を表すIwsAttributeクラスのインターフェースおよびメソッドについて説明します。

＜この章の構成＞

4.1　クラスの概要

4.2　コンストラクタの詳細

4.3　メソッドの詳細

4.1　クラスの概要

IwsAttributeクラスは，検索結果エントリの属性を表すクラスです。

クラス定義

public class IwsAttribute

extends java.lang.Object

パッケージ名

jp.co.hitachi_system.iwsearch.lib.client

IwsAttributeクラスのメソッドを次の表に示します。

表4-1　IwsAttributeクラスのメソッド

メソッド | 機能概要
IwsAttribute | コンストラクタです。
getName | 属性名を取得します。
getValue | 属性値を取得します。

4.2　コンストラクタの詳細

＜この節の構成＞

4.2.1　IwsAttribute

4.2.1　IwsAttribute

＜この項の構成＞

(1)　機能

(2)　定義

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

コンストラクタです。

(2)　定義

public IwsAttribute(java.lang.String attrName,java.lang.String attrValue)

(3)　引数

attrName

属性名を指定します。

attrValue

属性値を指定します。

(4)　戻り値

なし

(5)　例外

なし

4.3　メソッドの詳細

＜この節の構成＞

4.3.1　getName

4.3.2　getValue

4.3.1　getName

＜この項の構成＞

(1)　機能

(2)　定義

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

属性名を取得します。

(2)　定義

public java.lang.String getName()

(3)　引数

なし

(4)　戻り値

属性名

(5)　例外

なし

4.3.2　getValue

＜この項の構成＞

(1)　機能

(2)　定義

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

属性値を取得します。

(2)　定義

public java.lang.String getValue()

(3)　引数

なし

(4)　戻り値

属性値

(5)　例外

なし

5.　IwsResultPageHelperクラス

この章では，ページ遷移する検索結果画面を作成できるページ遷移ヘルパークラスのインターフェース，およびメソッドについて説明します。

＜この章の構成＞

5.1　クラスの概要

5.2　コンストラクタの詳細

5.3　メソッドの詳細

5.1　クラスの概要

IwsResultPageHelperクラスは，ページ遷移する検索結果画面を作成できるページ遷移ヘルパーのクラスです。

クラス定義

public class IwsResultPageHelper

extends java.lang.Object

パッケージ名

jp.co.hitachi_system.iwsearch.lib.client

IwsResultPageHelperクラスのメソッドを次の表に示します。

表5-1　IwsResultPageHelperクラスのメソッド

メソッド | 機能概要
IwsResultPageHelper | 引数で指定した検索結果情報のページ遷移ヘルパーのインスタンスを生成します。
getCurrentPage | この検索結果のページ番号を返します。
getLastPageIndex | 最終ページの検索結果先頭インデクスを返します。
getLastPageNum | この検索結果の最終ページ番号を返します。
getNextPageIndex | 1つ後ろのページの検索結果先頭インデクスを返します。
getPageIndex | pageで指定したページ番号の先頭が1番目となる検索結果開始インデクスを返します。
getPageList | ページ遷移用の連続するページ番号のリストを返します。
getPrevPageIndex | 1つ前のページの検索結果先頭インデクスを返します。
isLastPage | この検索結果が検索結果の最終ページを指しているかどうかを判定します。
isStartPage | この検索結果が検索結果の先頭ページを指しているかどうかを判定します。

5.2　コンストラクタの詳細

＜この節の構成＞

5.2.1　IwsResultPageHelper

5.2.1　IwsResultPageHelper

＜この項の構成＞

(1)　機能

(2)　定義

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

引数で指定した検索結果情報のページ遷移ヘルパーのインスタンスを生成します。

(2)　定義

(a)　形式1

public IwsResultPageHelper(IwsSearchResult searchResult)

(b)　形式2

public IwsResultPageHelper(IwsSearchResult searchResult,int showCount)

(3)　引数

searchResult

対象の検索結果であるIwsSearchResultクラスのオブジェクトを指定します。

showCount

表示する検索結果をアプリケーションで制限する場合に指定します。

showCountを指定した場合，ヒット件数がshowCountより多いときに，各メソッドはshowCount件目が検索結果の最後となるように動作します。

(4)　戻り値

なし

(5)　例外

java.lang.NullPointerException seachResultがnullの場合

5.3　メソッドの詳細

＜この節の構成＞

5.3.1　getCurrentPage

5.3.2　isStartPage

5.3.3　isLastPage

5.3.4　getLastPageNum

5.3.5　getPageList

5.3.6　getPageIndex

5.3.7　getPrevPageIndex

5.3.8　getNextPageIndex

5.3.9　getLastPageIndex

5.3.1　getCurrentPage

＜この項の構成＞

(1)　機能

(2)　定義

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

この検索結果のページ番号を返します。

(2)　定義

public int getCurrentPage()

(3)　引数

なし

(4)　戻り値

この検索結果のページ番号を返します。

(5)　例外

なし

5.3.2　isStartPage

＜この項の構成＞

(1)　機能

(2)　定義

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

この検索結果が検索結果の先頭ページを指しているかどうかを判定します。

(2)　定義

public boolean isStartPage()

(3)　引数

なし

(4)　戻り値

true

この検索結果は先頭ページです。

false

この検索結果は2ページ目以降です。

(5)　例外

なし

5.3.3　isLastPage

＜この項の構成＞

(1)　機能

(2)　定義

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

この検索結果が検索結果の最終ページを指しているかどうかを判定します。

(2)　定義

public boolean isLastPage()

(3)　引数

なし

(4)　戻り値

true

この検索結果は最終ページです。

false

この検索結果は最終ページではありません。

(5)　例外

なし

5.3.4　getLastPageNum

＜この項の構成＞

(1)　機能

(2)　定義

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

この検索結果の最終ページ番号を返します。

(2)　定義

public int getLastPageNum()

(3)　引数

なし

(4)　戻り値

この検索結果の最終ページ番号を返します。

(5)　例外

なし

5.3.5　getPageList

＜この項の構成＞

(1)　機能

(2)　定義

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

ページ遷移用の連続するページ番号のリストを返します。引数pageに指定した数が奇数の場合は，現在のページがリストの中央となるページ番号のリストを返します。引数pageに指定した数が偶数の場合は，現在のページがリストの中央の前のページとなるページ番号のリストを返します。現在のページが中央となるだけのページが前後にない場合は，その分リスト内の現在のページ位置が前後にずれます。

(2)　定義

(a)　形式1

public java.util.List<java.lang.Integer> getPageList(int page)

(b)　形式2

publi java.util.List<java.lang.Integer> getPageList()

(3)　引数

page

検索結果開始インデクスを取得するページリストの個数を設定します。

2以下，および101以上は指定できません。2以下，および101以上を指定した場合は10を仮定して動作します。

ページ番号の設定を省略した場合も10を仮定して動作します。

(4)　戻り値

ページ遷移用の番号リストを返します。

(5)　例外

なし

5.3.6　getPageIndex

＜この項の構成＞

(1)　機能

(2)　定義

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

引数pageで指定したページ番号が先頭となる検索結果開始インデクスを返します。検索結果開始インデクスを指定して再度検索メソッドを発行することで，検索結果のページ遷移ができます。getLastPageNumで取得できる最終ページ番号より大きな値を指定しても，最終ページの開始インデクスを返します。

(2)　定義

public long getPageIndex(long page)

(3)　引数

page

検索結果開始インデクスを取得するページ番号を設定します。

0以下を指定すると1を仮定して動作します。

検索結果の最終ページよりも大きな値を指定した場合は，最終ページが指定されたと仮定して動作します。

(4)　戻り値

指定ページの検索結果開始インデクスを返します。

(5)　例外

なし

5.3.7　getPrevPageIndex

＜この項の構成＞

(1)　機能

(2)　定義

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

1つ前のページの検索結果先頭インデクスを返します。

(2)　定義

public long getPrevPageIndex()

(3)　引数

なし

(4)　戻り値

1つ前のページの検索結果先頭インデクスを返します。

(5)　例外

なし

5.3.8　getNextPageIndex

＜この項の構成＞

(1)　機能

(2)　定義

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

1つ後ろのページの検索結果先頭インデクスを返します。

(2)　定義

public long getNextPageIndex()

(3)　引数

なし

(4)　戻り値

1つ後ろのページの検索結果先頭インデクスを返します。

(5)　例外

なし

5.3.9　getLastPageIndex

＜この項の構成＞

(1)　機能

(2)　定義

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

最終ページの検索結果先頭インデクスを返します。

(2)　定義

public long getLastPageIndex()

(3)　引数

なし

(4)　戻り値

最終ページの検索結果先頭インデクスを返します。

(5)　例外

なし

6.　IwsSearchCondクラス

この章では，検索条件の格納クラスであるIwsSearchCondクラスのインターフェース，およびメソッドについて説明します。

＜この章の構成＞

6.1　クラスの概要

6.2　コンストラクタの詳細

6.3　メソッドの詳細

6.1　クラスの概要

IwsSearchCondクラスは，検索条件を格納するクラスです。

このクラスはマルチスレッドには対応していません。マルチスレッド環境で利用する場合は，それぞれのスレッド内でこのクラスのインスタンスを生成してください。

クラス定義

public class IwsSearchCond

extends java.lang.Object

パッケージ名

jp.co.hitachi_system.iwsearch.lib.client

一度の検索で同時に指定できる検索条件の文字列の上限は，次の表のとおりです。これより大きい検索条件を指定して検索すると，IwsSearcher.searchで検索エラーとなります。

ただし，文章検索は30,001文字目以降を無視します。また，UCS-2の範囲を超える文字は1文字を2文字として数えます。

表6-1　一度の検索で同時に指定できる検索条件の文字列の上限

検索条件 | 上限
文章検索以外の文字列で指定する検索条件 | 各検索条件の文字列の合計で2,000文字
文章検索 | 30,000文字

検索結果のソート順や取得件数など，指定可能な各パラメータの初期値は次のとおりです。

表6-2　指定可能な各パラメータの初期値

メソッド | 機能概要 | 初期値
setCount | 一度に取得する検索結果の件数を指定します。 | 10
setCountOnly | ヒット件数返却機能の使用有無を設定します。 | Fales
setDate | 日時検索条件を指定します。 | －
setDateFilterType | 日時検索の範囲タイプを数値で指定します。 | 0（DATE_TYPE_NONE）
setEndDate | 終了日時検索条件を指定します。 | －
setHighLightClassName | 検索結果のハイライト箇所に埋め込まれる<span>タグに指定するクラス属性名を指定します。 | Highlight
setKeyword | 検索キーワードを指定します。 | －
setMaxSize | 絞り込み条件としてコンテンツの最大サイズをbyte数で指定します。 | 0
setMinSize | 絞り込み条件としてコンテンツの最小サイズをbyte数で指定します。 | 0
setOrder | 検索結果の昇順降順を指定します。 | desc（降順）
setSearchLoginID | 検索ユーザーログインIDを指定します。 | －
setSentence | 文章検索条件を指定します。 | －
setSimilarID | 類似コンテンツ検索をするエントリIDを指定します。 | －
setSnippetSize | 検索結果のスニペットのサイズをUTF-8のbyte数で指定します。 | －
setSort | 検索結果のソートキーを指定します。 | SORT_KEY_SCORE
setStartIndex | 取得する検索結果の開始インデクスを指定します。 | 1
setUseHighLight | 検索結果のタイトルとスニペットにハイライトタグを埋め込むかどうかを指定します。 | true
setUseHtmlEscape | 検索結果のタイトルとスニペット文字列に含まれるHTML特殊文字をエスケープするかどうかを指定します。 | true

IwsSearchCondクラスのメソッドを次の表に示します。

表6-3　IwsSearchCondクラスのメソッド

メソッド | 機能概要
IwsSearchCond | 検索条件オブジェクトを生成します。
addAddress | アドレスによる絞り込みを追加します。
addAttribute | 属性による絞り込みを追加します。
addAttributeOr | 組み合わせた属性条件のどれかに一致した検索条件を追加します。
addAuthor | ユーザー名による絞り込みを追加します。
addCrawlType | 検索対象のクロールタイプを追加します。
addExtension | 拡張子による絞り込みを追加します。
addFileName | ファイル名による絞り込みを追加します。
clearAddressList | これまでに追加したアドレスをすべて削除します。
clearAttribute | これまでに追加した属性をすべて削除します。
clearAttributeOr | これまでに追加した組み合わせた属性条件のどれかに一致した検索条件をすべて削除します。
clearAuthorList | これまでに追加したユーザー名をすべて削除します。
clearCrawlType | これまでに追加したクロールタイプをすべて削除します。
clearExtension | これまでに追加した拡張子をすべて削除します。
clearFileNameList | これまでに追加したファイル名をすべて削除します。
getAddressList | 追加したアドレスをリスト形式で返します。
getAttribute | 追加した属性をハッシュマップ形式で返します。
getAttributeOr | 追加した組み合わせた属性条件のどれかに一致した検索条件を，ハッシュマップのリスト形式で返します。
getAuthorList | 追加したユーザー名をリスト形式で返します。
getCount | 現在指定されている検索結果取得件数を返します。
getCountOnly | 現在指定されているヒット件数返却機能の有無を返します。
getCrawlTypeList | 現在指定されている検索対象のクロールタイプをリスト形式で返します。
getDate | 現在指定されている日時検索条件を返します。
getDateFilterType | 現在指定されている日時検索の範囲タイプをコードで返します。
getEndDate | 現在指定されている終了日時検索条件を返します。
getExtensionList | 現在指定されている拡張子をリスト形式で返します。
getFileNameList | 現在指定されているファイル名をリスト形式で返します。
getHighLightClassName | 現在指定されているハイライトタグ用のクラス属性名を返します。
getKeyword | 現在指定されている検索キーワードを返します。
getMaxSize | 現在指定されている検索対象コンテンツ最大サイズを返します。
getMinSize | 現在指定されている検索対象コンテンツ最小サイズを返します。
getOrder | 現在指定されているソート順を返します。
getSearchLoginID | 現在指定されている検索ユーザーアカウント名を返します。
getSentence | 現在指定されている文章検索条件を返します。
getSimilarID | 現在指定されている類似コンテンツ検索するエントリIDを返します。
getSnippetSize | 現在指定されているスニペットサイズを返します。
getSort | 現在指定されている検索結果のソートキーを返します。
getStartIndex | 現在指定されている検索結果開始インデクスを返します。
getUseHighLight | 現在指定されているハイライトタグの埋め込みの有無を返します。
getUseHtmlEscape | 現在指定されているHTMLエスケープの有無を返します。
setCount | 一度に取得する検索結果の件数を指定します。
setCountOnly | ヒット件数返却機能の使用有無を設定します。
setDate | 日時検索条件を指定します。
setDateFilterType | 日時検索の範囲タイプを数値で指定します。
setEndDate | 終了日時検索条件を指定します。
setHighLightClassName | 検索結果のハイライト箇所に埋め込まれる<span>タグに指定するクラス属性名を指定します。
setKeyword | 検索キーワードを指定します。
setMaxSize | 絞り込み条件としてコンテンツの最大サイズをbyte数で指定します。
setMinSize | 絞り込み条件としてコンテンツの最小サイズをbyte数で指定します。
setOrder | 検索結果の昇順降順を指定します。
setSearchLoginID | 検索ユーザーログインIDを指定します。
setSentence | 文章検索条件を指定します。
setSimilarID | 類似コンテンツ検索をするエントリIDを指定します。
setSnippetSize | 検索結果のスニペットのサイズをUTF-8のbyte数で指定します。
setSort | 検索結果のソートキーを指定します。
setStartIndex | 取得する検索結果の開始インデクスを指定します。
setUseHighLight | 検索結果のタイトルとスニペットにハイライトタグを埋め込むかどうかを指定します。
setUseHtmlEscape | 検索結果のタイトルとスニペット文字列に含まれるHTML特殊文字をエスケープするかどうかを指定します。

＜この節の構成＞

6.1.1　フィールドの詳細

6.1.1　フィールドの詳細

フィールドとは，メソッドの引数として指定できる定数です。

フィールドの詳細を次の表に示します。

表6-4　フィールドの詳細（日時範囲タイプ）

フィールド名 | 日時範囲タイプ | 定義
DATE_TYPE_NONE | 日時範囲指定無し | public static final int DATE_TYPE_NONE
DATE_TYPE_MONTH | 前後1ヶ月 | public static final int DATE_TYPE_MONTH
DATE_TYPE_BEFORE | 以前 | public static final int DATE_TYPE_BEFORE
DATE_TYPE_AFTER | 以降 | public static final int DATE_TYPE_AFTER
DATE_TYPE_BETWEEN | 任意の日時範囲 | public static final int DATE_TYPE_BETWEEN

表6-5　フィールドの詳細（ソートタイプ）

フィールド名 | ソートタイプ | 定義
SORT_KEY_SCORE | キーワードとの一致順 | public static final java.lang.String SORT_KEY_SCORE
SORT_KEY_DATE | 日時順 | public static final java.lang.String SORT_KEY_DATE
SORT_ORDER_ASC | 昇順 | public static final java.lang.String SORT_ORDER_ASC
SORT_ORDER_DES | 降順 | public static final java.lang.String SORT_ORDER_DESC

表6-6　フィールドの詳細（クロールタイプ）

フィールド名
クロールタイプ
定義

CRAWL_TYPE_WWW
WWW
public static final int CRAWL_TYPE_WWW

CRAWL_TYPE_NTFS
NTFS
public static final int CRAWL_TYPE_NTFS

CRAWL_TYPE_NOTES
Notes
public static final int CRAWL_TYPE_NOTES

CRAWL_TYPE_RDB
RDB
public static final int CRAWL_TYPE_RDB

CRAWL_TYPE_RSS
RSS
public static final int CRAWL_TYPE_RSS

CRAWL_TYPE_GROUPMAX
Groupmax Collaboration
public static final int CRAWL_TYPE_GROUPMAX

CRAWL_TYPE_GROUPMAX_BBS
Groupmax Collaboration 電子掲示板
public static final int CRAWL_TYPE_GROUPMAX_BBS

CRAWL_TYPE_GROUPMAX_FORUM
Groupmax Collaboration
電子会議室
public static final int CRAWL_TYPE_GROUPMAX_FORUM

CRAWL_TYPE_GROUPMAX_FILE_SHARING
Groupmax Collaboration
ファイル共有
public static final int CRAWL_TYPE_GROUPMAX_FILE_SHARING

表6-7　フィールドの詳細（属性タイプ）

フィールド名 | 属性 | 定義
ATTRIBUTE_ID_MLF_TITLE | MLFファイル主題 | public static final int ATTRIBUTE_ID_MLF_TITLE
ATTRIBUTE_ID_MLF_TO | MLFファイル TO | public static final int ATTRIBUTE_ID_MLF_TO
ATTRIBUTE_ID_MLF_CC | MLFファイル CC | public static final int ATTRIBUTE_ID_MLF_CC
ATTRIBUTE_ID_MLF_BCC | MLFファイル BCC | public static final int ATTRIBUTE_ID_MLF_BCC
ATTRIBUTE_ID_MLF_FROM | MLFファイル 送信者 | public static final int ATTRIBUTE_ID_MLF_FROM
ATTRIBUTE_ID_MLF_ATTACHED_NAME | MLFファイル 添付ファイル名 | public static final int ATTRIBUTE_ID_MLF_ATTACHED_NAME

6.2　コンストラクタの詳細

＜この節の構成＞

6.2.1　IwsSearchCond

6.2.1　IwsSearchCond

＜この項の構成＞

(1)　機能

(2)　定義

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

検索条件オブジェクトを生成します。

(2)　定義

public IwsSearchCond()

(3)　引数

なし

(4)　戻り値

なし

(5)　例外

なし

6.3　メソッドの詳細

＜この節の構成＞

6.3.1　addAddress

6.3.2　addAttribute

6.3.3　addAttributeOr

6.3.4　addAuthor

6.3.5　addCrawlType

6.3.6　addExtension

6.3.7　addFileName

6.3.8　clearAddressList

6.3.9　clearAttribute

6.3.10　clearAttributeOr

6.3.11　clearAuthorList

6.3.12　clearCrawlType

6.3.13　clearExtension

6.3.14　clearFileNameList

6.3.15　getAddressList

6.3.16　getAttribute

6.3.17　getAttributeOr

6.3.18　getAuthorList

6.3.19　getCount

6.3.20　getCountOnly

6.3.21　getCrawlTypeList

6.3.22　getDate

6.3.23　getDateFilterType

6.3.24　getEndDate

6.3.25　getExtensionList

6.3.26　getFileNameList

6.3.27　getHighLightClassName

6.3.28　getKeyword

6.3.29　getMaxSize

6.3.30　getMinSize

6.3.31　getOrder

6.3.32　getSearchLoginID

6.3.33　getSentence

6.3.34　getSimilarID

6.3.35　getSnippetSize

6.3.36　getSort

6.3.37　getStartIndex

6.3.38　getUseHighLight

6.3.39　getUseHtmlEscape

6.3.40　setCount

6.3.41　setCountOnly

6.3.42　setDate

6.3.43　setDateFilterType

6.3.44　setEndDate

6.3.45　setHighLightClassName

6.3.46　setKeyword

6.3.47　setMaxSize

6.3.48　setMinSize

6.3.49　setOrder

6.3.50　setSearchLoginID

6.3.51　setSentence

6.3.52　setSimilarID

6.3.53　setSnippetSize

6.3.54　setSort

6.3.55　setStartIndex

6.3.56　setUseHighLight

6.3.57　setUseHtmlEscape

6.3.1　addAddress

＜この項の構成＞

(1)　機能

(2)　定義

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

アドレス（URL）による絞り込みを追加します。複数追加した場合は，指定したアドレスのどれかが一致するコンテンツがヒットします。

(2)　定義

public void addAddress(java.lang.String address)

(3)　引数

address

追加するアドレスを指定します。

空文字，またはnullを指定した場合は無視します。

(4)　戻り値

なし

(5)　例外

なし

6.3.2　addAttribute

＜この項の構成＞

(1)　機能

(2)　定義

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

属性による絞り込みを追加します。追加できる属性の一覧を次の表に示します。なお，MLFファイルとは，Groupmaxのメールをファイルとしてダウンロードしたものです。

表6-8　追加できる属性と属性ID

属性 | 属性ID | フィールド定義
MLFファイル主題 | 13 | ATTRIBUTE_ID_MLF_TITLE
MLFファイルTO | 14 | ATTRIBUTE_ID_MLF_TO
MLFファイルCC | 15 | ATTRIBUTE_ID_MLF_CC
MLFファイルBCC | 16 | ATTRIBUTE_ID_MLF_BCC
MLFファイル送信者 | 17 | ATTRIBUTE_ID_MLF_FROM
MLFファイル添付ファイル名 | 18 | ATTRIBUTE_ID_MLF_ATTACHED_NAME

存在しない属性IDを指定して検索すると，IwsSearcher.searchで検索エラーとなります。属性値に空文字，またはnullを指定した場合は無視します。

異なる属性IDを指定して複数追加した場合は，指定した属性IDごとの属性値が一致するコンテンツがヒットします。同じ属性IDを指定して複数追加した場合は，指定した属性IDの属性のどれかが一致するコンテンツがヒットします。

(2)　定義

public void addAttribute(int attributeID,java.lang.String searchValue)

(3)　引数

attributeID

属性IDを指定します。

searchValue

属性値を設定します。

(4)　戻り値

なし

(5)　例外

なし

6.3.3　addAttributeOr

＜この項の構成＞

(1)　機能

(2)　定義

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

組み合わせた属性条件のどれかに一致した検索条件を追加します。

表6-9　組み合わせできる属性

属性 | 属性ID | フィールド定義
MLFファイル主題 | 13 | ATTRIBUTE_ID_MLF_TITLE
MLFファイルTO | 14 | ATTRIBUTE_ID_MLF_TO
MLFファイルCC | 15 | ATTRIBUTE_ID_MLF_CC
MLFファイルBCC | 16 | ATTRIBUTE_ID_MLF_BCC
MLFファイル送信者 | 17 | ATTRIBUTE_ID_MLF_FROM
MLFファイル添付ファイル名 | 18 | ATTRIBUTE_ID_MLF_ATTACHED_NAME

注意

存在しない属性IDを指定して検索すると，IwsSearcher.searchで検索エラーとなります。

属性値，およびマップに空文字，またはnullを指定した場合は無視します。

属性条件を複数追加した場合は，指定した属性が1つでも一致するコンテンツがヒットします。

(2)　定義

public void addAttributeOr(java.util.HashMap<java.lang.Integer,java.util.List
<java.lang.String>> attributeOrMap)

(3)　引数

addAttributeOrMap

組み合わせた属性条件のマップを指定します。

(4)　戻り値

なし

(5)　例外

なし

6.3.4　addAuthor

＜この項の構成＞

(1)　機能

(2)　定義

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

ユーザー名による絞り込みを追加します。複数追加した場合は，指定したユーザー名のどれかが関連付けられているコンテンツがヒットします。

(2)　定義

public void addAuthor(java.lang.String author)

(3)　引数

author

追加するユーザー名を指定します。空文字，またはnullを指定した場合は無視します。

(4)　戻り値

なし

(5)　例外

なし

6.3.5　addCrawlType

＜この項の構成＞

(1)　機能

(2)　定義

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

検索対象のクロールタイプを追加します。

表6-10　クロールタイプごとの指定値

クロールタイプ | addCrawlTypeに指定する値 | フィールド定義
WWW | 1 | CRAWL_TYPE_WWW
NTFS | 2 | CRAWL_TYPE_NTFS
Notes | 3 | CRAWL_TYPE_NOTES
RDB | 4 | CRAWL_TYPE_RDB
RSS | 5 | CRAWL_TYPE_RSS
Groupmax | 9 | CRAWL_TYPE_GROUPMAX
Groupmax電子掲示板 | 1000 | CRAWL_TYPE_GROUPMAX_BBS
Groupmax電子会議室 | 1001 | CRAWL_TYPE_GROUPMAX_FORUM
Groupmaxファイル共有 | 1002 | CRAWL_TYPE_GROUPMAX_FILE_SHARING

複数追加した場合は，指定したクロールタイプのどれかのコンテンツがヒットします。

同じクロールタイプを複数追加した場合は，後から追加したクロールタイプを無視します。

(2)　定義

public void addCrawlType(int crawlType)

(3)　引数

crawlType

追加するクロールタイプを指定します。

(4)　戻り値

なし

(5)　例外

なし

6.3.6　addExtension

＜この項の構成＞

(1)　機能

(2)　定義

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

拡張子による絞り込みを追加します。複数追加した場合は，指定した拡張子のどれかが拡張子であるコンテンツがヒットします。

なお，拡張子には"."（ドット）を含めないでください。

(2)　定義

public void addExtension(java.lang.String extension)

(3)　引数

extension

追加する拡張子です。

空文字，またはnullを指定した場合は無視します。

(4)　戻り値

なし

(5)　例外

なし

6.3.7　addFileName

＜この項の構成＞

(1)　機能

(2)　定義

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

ファイル名による絞り込みを追加します。

複数追加した場合は，指定したファイル名のどれかが合致するコンテンツがヒットします。

(2)　定義

public void addFileName(java.lang.String name)

(3)　引数

name

追加するファイル名を指定します。

空文字，またはnullを指定した場合は無視します。

(4)　戻り値

なし

(5)　例外

なし

6.3.8　clearAddressList

＜この項の構成＞

(1)　機能

(2)　定義

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

これまでに追加したアドレス（URL）をすべて削除します。

(2)　定義

public void clearAddressList()

(3)　引数

なし

(4)　戻り値

なし

(5)　例外

なし

6.3.9　clearAttribute

＜この項の構成＞

(1)　機能

(2)　定義

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

これまでに追加した属性をすべて削除します。

(2)　定義

public void clearAttribute()

(3)　引数

なし

(4)　戻り値

なし

(5)　例外

なし

6.3.10　clearAttributeOr

＜この項の構成＞

(1)　機能

(2)　定義

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

これまでに追加した組み合わせた属性条件のどれかに一致した検索条件をすべて削除します。

(2)　定義

public void clearAttributeOr()

(3)　引数

なし

(4)　戻り値

なし

(5)　例外

なし

6.3.11　clearAuthorList

＜この項の構成＞

(1)　機能

(2)　定義

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

これまでに追加したユーザー名をすべて削除します。

(2)　定義

public void clearAuthorList()

(3)　引数

なし

(4)　戻り値

なし

(5)　例外

なし

6.3.12　clearCrawlType

＜この項の構成＞

(1)　機能

(2)　定義

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

これまでに追加したクロールタイプをすべて削除します。

(2)　定義

public void clearCrawlType()

(3)　引数

なし

(4)　戻り値

なし

(5)　例外

なし

6.3.13　clearExtension

＜この項の構成＞

(1)　機能

(2)　定義

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

これまでに追加した拡張子をすべて削除します。

(2)　定義

public void clearExtension()

(3)　引数

なし

(4)　戻り値

なし

(5)　例外

なし

6.3.14　clearFileNameList

＜この項の構成＞

(1)　機能

(2)　定義

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

これまでに追加したファイル名をすべて削除します。

(2)　定義

public void clearFileNameList()

(3)　引数

なし

(4)　戻り値

なし

(5)　例外

なし

6.3.15　getAddressList

＜この項の構成＞

(1)　機能

(2)　定義

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

追加したアドレス（URL）をリスト形式で返します。

(2)　定義

public java.util.List<java.lang.String> getAddressList()

(3)　引数

なし

(4)　戻り値

アドレスの絞り込み条件のリストを返します。

アドレスをセットしていない場合は，空のリストを返します。

(5)　例外

なし

6.3.16　getAttribute

＜この項の構成＞

(1)　機能

(2)　定義

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

追加した属性をハッシュマップ形式で返します。

(2)　定義

public java.util.HashMap<java.lang.Integer,java.util.List<java.lang.String>>  getAttribute()

(3)　引数

なし

(4)　戻り値

追加した属性のハッシュマップを返します。第1引数が属性ID，第2引数が属性値のハッシュマップです。

属性をセットしていない場合は，空のハッシュマップを返します。

(5)　例外

なし

6.3.17　getAttributeOr

＜この項の構成＞

(1)　機能

(2)　定義

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

追加した組み合わせた属性条件のどれかに一致した検索条件を，ハッシュマップのリスト形式で返します。第1引数が属性ID，第2引数が属性値のハッシュマップです。

(2)　定義

public java.util.HashMap<java.lang.Integer,java.util.List<java.lang.String>> getAttributeOr()

(3)　引数

なし

(4)　戻り値

追加した組み合わせた属性条件のハッシュマップのリストを返します。組み合わせた属性条件をセットしていない場合は，空のハッシュマップのリストを返します。

(5)　例外

なし

6.3.18　getAuthorList

＜この項の構成＞

(1)　機能

(2)　定義

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

追加したユーザー名をリスト形式で返します。

(2)　定義

public java.util.List<java.lang.String> getAuthorList()

(3)　引数

なし

(4)　戻り値

ユーザー名の絞り込み条件のリストを返します。

ユーザー名をセットしていない場合は，空のリストを返します。

(5)　例外

なし

6.3.19　getCount

＜この項の構成＞

(1)　機能

(2)　定義

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

現在指定されている検索結果取得件数を返します。未指定の場合はデフォルトの10を返します。

(2)　定義

public int getCount()

(3)　引数

なし

(4)　戻り値

検索結果取得件数を返します。

(5)　例外

なし

6.3.20　getCountOnly

＜この項の構成＞

(1)　機能

(2)　定義

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

現在設定されているヒット件数返却機能の有無を返します。

(2)　定義

public boolean getCountOnly()

(3)　引数

なし

(4)　戻り値

ヒット件数返却機能が有効の場合はtrueを返します。デフォルトではfalse（無効）を返します。

(5)　例外

なし

6.3.21　getCrawlTypeList

＜この項の構成＞

(1)　機能

(2)　定義

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

現在指定されている検索対象のクロールタイプをリスト形式で返します。

(2)　定義

public java.util.List<java.lang.Integer> getCrawlTypeList()

(3)　引数

なし

(4)　戻り値

検索対象のクロールタイプリストを返します。

検索対象のクロールタイプリストを追加していない場合は，空のリストを返します。

(5)　例外

なし

6.3.22　getDate

＜この項の構成＞

(1)　機能

(2)　定義

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

現在指定されている日時検索条件を返します。未指定の場合はnullを返します。

(2)　定義

public java.util.Date getDate()

(3)　引数

なし

(4)　戻り値

日時検索条件を返します。

(5)　例外

なし

6.3.23　getDateFilterType

＜この項の構成＞

(1)　機能

(2)　定義

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

現在指定されている日時検索の範囲タイプをコードで返します。未指定の場合はDATE_TYPE_NONEを返します。

(2)　定義

public int getDateFilterType()

(3)　引数

なし

(4)　戻り値

日時検索の範囲タイプを返します。

(5)　例外

なし

6.3.24　getEndDate

＜この項の構成＞

(1)　機能

(2)　定義

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

現在指定されている終了日時検索条件をコードで返します。未指定の場合はnullを返します。

(2)　定義

public java.util.Date getEndDate()

(3)　引数

なし

(4)　戻り値

終了日時検索条件を返します。

(5)　例外

なし

6.3.25　getExtensionList

＜この項の構成＞

(1)　機能

(2)　定義

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

現在指定されている拡張子をリスト形式で返します。

(2)　定義

public java.util.List<java.lang.String> getExtensionList()

(3)　引数

なし

(4)　戻り値

拡張子のリストを返します。拡張子を指定していない場合は，空のリストを返します。

(5)　例外

なし

6.3.26　getFileNameList

＜この項の構成＞

(1)　機能

(2)　定義

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

現在指定されているファイル名をリスト形式で返します。

(2)　定義

public java.util.List<java.lang.String> getFileNameList()

(3)　引数

なし

(4)　戻り値

ファイル名のリストを返します。ファイル名をセットしていない場合は，空のリストを返します。

(5)　例外

なし

6.3.27　getHighLightClassName

＜この項の構成＞

(1)　機能

(2)　定義

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

現在指定されているハイライトタグ用のクラス属性名を返します。

(2)　定義

public java.lang.String getHighLightClassName()

(3)　引数

なし

(4)　戻り値

ハイライトタグ用のクラス属性名を返します。

(5)　例外

なし

6.3.28　getKeyword

＜この項の構成＞

(1)　機能

(2)　定義

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

現在指定されている検索キーワードを返します。

(2)　定義

public java.lang.String getKeyword()

(3)　引数

なし

(4)　戻り値

検索キーワードを返します。

(5)　例外

なし

6.3.29　getMaxSize

＜この項の構成＞

(1)　機能

(2)　定義

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

現在指定されている検索対象コンテンツ最大サイズを返します。

(2)　定義

public int getMaxSize()

(3)　引数

なし

(4)　戻り値

検索対象コンテンツ最大サイズを返します。

(5)　例外

なし

6.3.30　getMinSize

＜この項の構成＞

(1)　機能

(2)　定義

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

現在指定されている検索対象コンテンツ最小サイズを返します。

(2)　定義

public int getMinSize()

(3)　引数

なし

(4)　戻り値

検索対象コンテンツ最小サイズを返します。

(5)　例外

なし

6.3.31　getOrder

＜この項の構成＞

(1)　機能

(2)　定義

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

現在指定されているソート順を返します。

(2)　定義

public java.lang.String getOrder()

(3)　引数

なし

(4)　戻り値

ソート順を返します。ソート順の値については，6.3.49 setOrderの表6-13 ソート指定による値を参照してください。

(5)　例外

なし

6.3.32　getSearchLoginID

＜この項の構成＞

(1)　機能

(2)　定義

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

現在指定されている検索ユーザーアカウント名を返します。

(2)　定義

public java.lang.String getSearchLoginID()

(3)　引数

なし

(4)　戻り値

ユーザーアカウント名を返します。

(5)　例外

なし

6.3.33　getSentence

＜この項の構成＞

(1)　機能

(2)　定義

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

現在指定されている文章検索条件を返します。

(2)　定義

public java.lang.String getSentence()

(3)　引数

なし

(4)　戻り値

文章検索条件を返します。

(5)　例外

なし

6.3.34　getSimilarID

＜この項の構成＞

(1)　機能

(2)　定義

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

現在指定されている類似コンテンツ検索するエントリIDを返します。未指定の場合は0を返します。

(2)　定義

public long getSimilarID()

(3)　引数

なし

(4)　戻り値

類似コンテンツ検索するエントリIDを返します。

(5)　例外

なし

6.3.35　getSnippetSize

＜この項の構成＞

(1)　機能

(2)　定義

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

現在指定されているスニペットサイズを返します。

(2)　定義

public int getSnippetSize()

(3)　引数

なし

(4)　戻り値

検索結果のスニペットサイズを返します。

(5)　例外

なし

6.3.36　getSort

＜この項の構成＞

(1)　機能

(2)　定義

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

現在指定されている検索結果のソートキーを返します。

(2)　定義

public java.lang.String getSort()

(3)　引数

なし

(4)　戻り値

ソートキーを返します。

(5)　例外

なし

6.3.37　getStartIndex

＜この項の構成＞

(1)　機能

(2)　定義

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

現在指定されている検索結果開始インデクスを返します。

(2)　定義

public long getStartIndex()

(3)　引数

なし

(4)　戻り値

検索結果開始インデクスを返します。

(5)　例外

なし

6.3.38　getUseHighLight

＜この項の構成＞

(1)　機能

(2)　定義

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

現在指定されているハイライトタグの埋め込みの有無を返します。

(2)　定義

public boolean getUseHighLight()

(3)　引数

なし

(4)　戻り値

ハイライトタグを埋め込む場合はtrueを返します。

(5)　例外

なし

6.3.39　getUseHtmlEscape

＜この項の構成＞

(1)　機能

(2)　定義

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

現在指定されているHTMLエスケープの有無を返します。

(2)　定義

public boolean getUseHtmlEscape()

(3)　引数

なし

(4)　戻り値

HTML特殊文字をエスケープする場合はtrueを返します。

(5)　例外

なし

6.3.40　setCount

＜この項の構成＞

(1)　機能

(2)　定義

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

一度に取得する検索結果の件数を指定します。

指定可能な値の範囲は10～1,000です。範囲外の値を指定して検索すると，IwsSearcher.searchで検索エラーとなります。

デフォルト値は10です。

(2)　定義

public void setCount(int count)

(3)　引数

count

検索結果取得件数を指定します。

(4)　戻り値

なし

(5)　例外

なし

6.3.41　setCountOnly

＜この項の構成＞

(1)　機能

(2)　定義

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

ヒット件数返却機能の使用有無を設定します。デフォルトではヒット件数返却機能を使用しません。

(2)　定義

public void setCountOnly(boolean countOnly)

(3)　引数

countOnly

ヒット件数返却機能を使用する場合はtrueを指定してください。

(4)　戻り値

なし

(5)　例外

なし

6.3.42　setDate

＜この項の構成＞

(1)　機能

(2)　定義

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

日時検索条件を指定します。日時検索条件の範囲はsetDateFilterTypeで指定します。

(2)　定義

public void setDate(java.util.Date date)

(3)　引数

date

日時検索条件を指定します。

ミリ秒以下の数値は無視します。

setDateに指定可能な日時の範囲は次のとおりです。

0001/01/01 00:00:00 ～ 9999/12/31 23:59:59

(4)　戻り値

なし

(5)　例外

なし

6.3.43　setDateFilterType

＜この項の構成＞

(1)　機能

(2)　定義

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

日時検索の範囲タイプを数値で指定します。

表6-11　検索対象ごとの指定値

検索対象 | 範囲タイプの値 | フィールド定義
日時範囲指定無し | 0 | DATE_TYPE_NONE
前後一ヶ月 | 1 | DATE_TYPE_MONTH
以前 | 2 | DATE_TYPE_BEFORE
以降 | 3 | DATE_TYPE_AFTER
任意の日時範囲 | 4 | DATE_TYPE_BETWEEN

デフォルト値は0（DATE_TYPE_NONE）です。

次の指定で検索すると，IwsSearcher.searchで検索エラーとなります。

表に示した以外の数値を指定した場合

0（DATE_TYPE_NONE）を指定してsetDateかsetEndDateに日時を指定している場合

0（DATE_TYPE_NONE）以外を指定してsetDateで対象の日時を指定しない場合

1（DATE_TYPE_MONTH）か2（DATE_TYPE_BEFORE）か 3（DATE_TYPE_AFTER）を指定してsetEndDateで終了日時を指定している場合

4（DATE_TYPE_BETWEEN）を指定してsetDateとsetEndDateのどちらかが未指定の場合

(2)　定義

public void setDateFilterType(int dateCondType)

(3)　引数

dateCondType

日時検索の範囲タイプ

(4)　戻り値

なし

(5)　例外

なし

6.3.44　setEndDate

＜この項の構成＞

(1)　機能

(2)　定義

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

終了日時検索条件を指定します。日時検索条件の範囲はsetDateFilterTypeで指定します。

(2)　定義

public void setEndDate(java.util.Date endDate)

(3)　引数

endDate

日時検索条件を指定します。

ミリ秒以下の数値は無視します。

setEndDateに指定可能な日時の範囲は次のとおりです。

0001/01/01 00:00:00 ～ 9999/12/31 23:59:59

(4)　戻り値

なし

(5)　例外

なし

6.3.45　setHighLightClassName

＜この項の構成＞

(1)　機能

(2)　定義

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

検索結果のハイライト箇所に埋め込まれる<span>タグに指定するクラス属性名を指定します。

(2)　定義

public void setHighLightClassName(java.lang.String highLightClassName)

(3)　引数

highLightClassName

ハイライト箇所に埋め込まれる<span>タグのクラス属性名を指定します。

デフォルトのクラス属性名はHighlightです。

クラス属性名に指定可能な文字列は，半角英数字，"-"および"_"だけです。これ以外を指定すると検索すると，IwsSearcher.searchで検索エラーとなります。

(4)　戻り値

なし

(5)　例外

なし

6.3.46　setKeyword

＜この項の構成＞

(1)　機能

(2)　定義

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

検索キーワードを指定します。

検索キーワードには単純なキーワードだけではなく，AND検索，OR検索，フレーズ検索およびこれらの組み合わせを指定することができます。詳細についてはマニュアル「uCosminexus Enterprise Search ユーザーズガイド」を参照してください。

キーワード検索，文章検索および類似コンテンツ検索のすべてを指定しないで検索すると，IwsSearcher.searchで検索エラーとなります。

(2)　定義

public void setKeyword(java.lang.String keyword)

(3)　引数

keyword

検索キーワードを指定します。

(4)　戻り値

なし

(5)　例外

なし

6.3.47　setMaxSize

＜この項の構成＞

(1)　機能

(2)　定義

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

絞り込み条件としてコンテンツの最大サイズをbyte数で指定します。絞り込みの対象となるサイズを次の表に示します。

表6-12　クロールタイプによる絞り込みの対象となるサイズ

クロールタイプ | 絞り込みの対象となるサイズ
NTFS | ファイルサイズ
WWW | ファイルサイズ
Notes | Notes文書テキストサイズ
RDB | 本文テキストサイズ
RSS | 0byte（サイズが無いため）
Groupmax | テキストサイズと添付ファイルサイズの合計

デフォルトは0です。負の値を指定して検索すると，IwsSearcher.searchで検索エラーとなります。

(2)　定義

public void setMaxSize(int maxSize)

(3)　引数

maxSize

検索対象コンテンツの最大サイズを指定します。

0を指定した場合は最大サイズの絞り込みはされません。

(4)　戻り値

なし

(5)　例外

なし

6.3.48　setMinSize

＜この項の構成＞

(1)　機能

(2)　定義

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

絞り込み条件としてコンテンツの最小サイズをbyte数で指定します。

絞り込みの対象となるサイズについては「6.3.47　setMaxSize」を参照してください。

デフォルトは0です。負の値を指定して検索すると，IwsSearcher.searchで検索エラーとなります。

(2)　定義

public void setMinSize(int minSize)

(3)　引数

minSize

検索対象コンテンツの最小サイズを指定します。

0を指定した場合は最小サイズの絞り込みはされません。

(4)　戻り値

なし

(5)　例外

なし

6.3.49　setOrder

＜この項の構成＞

(1)　機能

(2)　定義

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

検索結果のソート順を指定します。

setSortとこのメソッドで検索結果のソート順を指定します。デフォルトはdesc（降順）です。

表6-13　ソートの指定による値

ソート順 | 範囲タイプの値 | フィールド定義
昇順 | "asc" | SORT_ORDER_ASC
降順 | "desc" | SORT_ORDER_DESC

表に示した以外の文字列を指定して検索すると，IwsSearcher.searchで検索エラーとなります。また，setKeywordで設定したキーワードの一致順を昇順で並べることはできません。

setSortがデフォルトか，SORT_KEY_SCOREを指定している状態でこのメソッドにSORT_ORDER_ASCを指定して検索すると，エラーとなります。

(2)　定義

public void setOrder(java.lang.String order)

(3)　引数

order

検索結果のソート順を指定します。

(4)　戻り値

なし

(5)　例外

なし

6.3.50　setSearchLoginID

＜この項の構成＞

(1)　機能

(2)　定義

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

検索ユーザーログインIDを指定します。

特定のユーザーのアクセス権で検索する場合に指定します。このメソッドで指定したログインIDのアクセス権で検索します。検索サーバーに存在しないユーザーを指定すると，アクセス権制限の無いコンテンツだけがヒットします。

(2)　定義

public void setSearchLoginID(java.lang.String loginID)

(3)　引数

loginID

検索するユーザーのログインIDを指定します。

(4)　戻り値

なし

(5)　例外

なし

6.3.51　setSentence

＜この項の構成＞

(1)　機能

(2)　定義

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

文章検索条件を指定します。

文章検索条件は30,000文字まで指定できます。30,000文字を超える文章を指定した場合は，先頭から30,000文字の文章を検索条件として使用します。また，UCS-2の範囲を超える文字は1文字を2文字として数えます。キーワード検索，文章検索および類似コンテンツ検索のすべてを指定しないで検索すると，IwsSearcher.searchで検索エラーとなります。また，文章検索と類似コンテンツ検索は同時に指定することができません。同時に指定して検索すると，IwsSearcher.searchで検索エラーとなります。

(2)　定義

public void setSentence(java.lang.String searchSentence)

(3)　引数

searchSentence

文章検索条件を指定します。

(4)　戻り値

なし

(5)　例外

なし

6.3.52　setSimilarID

＜この項の構成＞

(1)　機能

(2)　定義

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

類似コンテンツ検索をするエントリIDを指定します。

検索サーバーに存在しないエントリIDを指定して検索すると，IwsSearcher.searchで検索エラーとなります。

(2)　定義

public void setSimilarID(long entryID)

(3)　引数

entryID

類似コンテンツ検索するエントリIDを指定します。

(4)　戻り値

なし

(5)　例外

なし

6.3.53　setSnippetSize

＜この項の構成＞

(1)　機能

(2)　定義

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

検索結果のスニペットのサイズをUTF-8のbyte数で指定します。

指定可能な値の範囲は20～2147483647です。範囲外の値を指定して検索すると，IwsSearcher.searchで検索エラーとなります。

(2)　定義

public void setSnippetSize(int snippetByteSize)

(3)　引数

snippetByteSize

スニペットサイズ（byte数）を指定します。

(4)　戻り値

なし

(5)　例外

なし

6.3.54　setSort

＜この項の構成＞

(1)　機能

(2)　定義

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

検索結果のソートキーを指定します。デフォルトはSORT_KEY_SCOREです。

表6-14　昇順降順の指定による値

ソートキー | 範囲タイプの値 | フィールド定義
キーワードの一致順 | "score" | SORT_KEY_SCORE
日付順(降順) | "date" | SORT_KEY_DATE

表に示した以外の文字列を指定して検索すると，IwsSearcher.searchで検索エラーとなります。

(2)　定義

public void setSort(java.lang.String sortKey)

(3)　引数

sortKey

検索結果のソートキーを指定します。

(4)　戻り値

なし

(5)　例外

なし

6.3.55　setStartIndex

＜この項の構成＞

(1)　機能

(2)　定義

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

取得する検索結果の開始インデクスを指定します。デフォルト値は1（検索結果の1件目から取得）です。マイナスの値を指定して検索すると，IwsSearcher.searchで検索エラーとなります。

ヒット件数よりも大きな値を指定すると，検索条件に該当するコンテンツがあってもヒット件数が0件となります。

(2)　定義

public void setStartIndex(long startIndex)

(3)　引数

startIndex

検索結果開始インデクスを指定します。

(4)　戻り値

なし

(5)　例外

なし

6.3.56　setUseHighLight

＜この項の構成＞

(1)　機能

(2)　定義

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

検索結果のタイトルとスニペットに，ハイライトタグを埋め込むかどうかを指定します。指定が無い場合はハイライトタグを埋め込みます。

setUseHtmlEscapeにfalseを指定した場合，このメソッドにtrueを指定してもハイライトタグは埋め込みません。

(2)　定義

public void setUseHighLight(boolean useHighLight)

(3)　引数

useHighLight

ハイライトタグを埋め込む場合はtrueを指定します。

(4)　戻り値

なし

(5)　例外

なし

6.3.57　setUseHtmlEscape

＜この項の構成＞

(1)　機能

(2)　定義

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

検索結果のタイトルとスニペット文字列に含まれるHTML特殊文字をエスケープするかどうかを指定します。エスケープする文字とエスケープ結果を次に示します。

表6-15　エスケープする文字とエスケープ結果

変換前 | 変換後
& | &amp;
" | &quot;
' | &#039;
< | &lt;
> | &gt;

(2)　定義

public void setUseHtmlEscape(boolean useHtmlEscape)

(3)　引数

useHtmlEscape

HTML特殊文字をエスケープする場合はtrueを指定します。

デフォルトはtrueです。

(4)　戻り値

なし

(5)　例外

なし

7.　IwsSearcherクラス

この章では，指定された検索条件に従って検索サーバーと通信し検索結果を返す検索クラスのインタフェース，およびメソッドについて説明します。

＜この章の構成＞

7.1　クラスの概要

7.2　コンストラクタの詳細

7.3　メソッドの詳細

7.1　クラスの概要

IwsSearcherクラスは，指定された検索条件に従って検索サーバーと通信し検索結果を返します。

このクラスはマルチスレッドには対応していません。マルチスレッド環境で利用する場合は，それぞれのスレッド内でこのクラスのインスタンスを生成してください。

クラスの定義

public class IwsSearcher

extends java.lang.Object

パッケージ名

jp.co.hitachi_system.iwsearch.lib.client

IwsSearcherクラスのメソッドを次の表に示します。

表7-1　IwsSearcherクラスのメソッド

メソッド | 機能概要
IwsSearcher | URLで指定したサーバーと接続する検索インスタンスを生成します。
getTimeout | 検索リクエストの接続タイムアウト時間を返します。
search | コンストラクタで指定したURLに接続し，setLoginIDとsetPasswordで指定した認証情報で認証してから，searchCondに指定した条件で検索して検索結果を返します。
setLog | クライアントライブラリのログ出力をカスタマイズするために， IwsSearchLoggerを実装したログ出力クラスを指定します。
setLoginID | 検索サーバーと認証するためのログインIDを設定します。
setPassword | 検索サーバーと認証するためのパスワードを設定します。
setTimeout | 検索リクエストの接続タイムアウト時間を秒で設定します。

7.2　コンストラクタの詳細

＜この節の構成＞

7.2.1　IwsSearcher

7.2.1　IwsSearcher

＜この項の構成＞

(1)　機能

(2)　定義

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

URLで指定したサーバーと接続する検索インスタンスを生成します。

(2)　定義

public IwsSearcher(java.lang.String url)

(3)　引数

url

Enterprise SearchのURLを指定します。

(4)　戻り値

なし

(5)　例外

なし

7.3　メソッドの詳細

＜この節の構成＞

7.3.1　getTimeout

7.3.2　search

7.3.3　setLog

7.3.4　setLoginID

7.3.5　setPassword

7.3.6　setTimeout

7.3.1　getTimeout

＜この項の構成＞

(1)　機能

(2)　定義

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

検索リクエストの接続タイムアウト時間を返します。

(2)　定義

public int getTimeout()

(3)　引数

なし

(4)　戻り値

タイムアウト時間（秒）を返します。

(5)　例外

なし

7.3.2　search

＜この項の構成＞

(1)　機能

(2)　定義

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

コンストラクタで指定したURLに接続し，setLoginIDとsetPasswordで指定した認証情報で認証してから，searchCondに指定した条件で検索して検索結果を返します。

(2)　定義

public IwsSearchResult search(IwsSearchCond searchCond) throws  IwsSearchException

(3)　引数

searchCond

検索条件を指定します。

(4)　戻り値

検索結果を返します。

(5)　例外

IwsSearchException

検索時にJavaインターフェースかサーバーでエラーが発生しました。

7.3.3　setLog

＜この項の構成＞

(1)　機能

(2)　定義

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

クライアントライブラリのログ出力をカスタマイズするために，IwsSearchLoggerを実装したログ出力クラスを指定します。nullを指定すると無視します。

(2)　定義

public void setLog(IwsSearchLogger logger)

(3)　引数

logger

IwsSearchLogger実装クラスを指定します。

(4)　戻り値

なし

(5)　例外

なし

7.3.4　setLoginID

＜この項の構成＞

(1)　機能

(2)　定義

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

検索サーバーと認証するためのログインIDを設定します。

(2)　定義

public void setLoginID(java.lang.String loginID)

(3)　引数

loginID

認証用のログインIDを指定します。

(4)　戻り値

なし

(5)　例外

なし

7.3.5　setPassword

＜この項の構成＞

(1)　機能

(2)　定義

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

検索サーバーと認証するためのパスワードを設定します。

(2)　定義

public void setPassword(java.lang.String password)

(3)　引数

password

認証用のパスワードを指定します。

(4)　戻り値

なし

(5)　例外

なし

7.3.6　setTimeout

＜この項の構成＞

(1)　機能

(2)　定義

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

検索リクエストの接続タイムアウト時間を秒で設定します。デフォルト値は60秒です。

指定可能な値の範囲は1～3600です。範囲外の値を指定するとデフォルト値（60秒）で動作します。

(2)　定義

public void setTimeout(int timeout)

(3)　引数

timeout

タイムアウト時間（秒）を指定します。

(4)　戻り値

なし

(5)　例外

なし

8.　IwsSearchExceptionクラス

この章では，例外クラスであるIwsSearchExceptionクラスのインタフェース，およびメソッドについて説明します。

＜この章の構成＞

8.1　クラスの概要

8.2　コンストラクタの詳細

8.3　メソッドの詳細

8.1　クラスの概要

IwsSearchExceptionクラスは，Enterprise SearchのJavaインターフェースでエラーが発生したときにスローされる例外クラスです。

クラス定義

public class IwsSearchException

extends java.lang.Exception

パッケージ名

jp.co.hitachi_system.iwsearch.lib.client.exception

IwsSearchExceptionクラスのメソッドを次の表に示します。

表8-1　IwsSearchExceptionクラスのメソッド

メソッド | 機能概要
getMessage | メッセージ識別子付きメッセージを返します。
getMessageID | メッセージ識別子(KMESXXXX-X)を返します。
getPartialMessage | メッセージ識別子無しのメッセージを返します。

8.2　コンストラクタの詳細

IwsSearchExceptionクラスは，アプリケーションプログラムでコンストラクタを生成しません。

8.3　メソッドの詳細

＜この節の構成＞

8.3.1　getMessage

8.3.2　getMessageID

8.3.3　getPartialMessage

8.3.1　getMessage

＜この項の構成＞

(1)　機能

(2)　定義

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

メッセージ識別子付きメッセージを返します。

(2)　定義

public java.lang.String getMessage()

(3)　引数

なし

(4)　戻り値

メッセージを返します。

(5)　例外

なし

8.3.2　getMessageID

＜この項の構成＞

(1)　機能

(2)　定義

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

メッセージ識別子（KMESXXXX-X）を返します。

(2)　定義

public java.lang.String getMessageID()

(3)　引数

なし

(4)　戻り値

メッセージ識別子を返します。

(5)　例外

なし

8.3.3　getPartialMessage

＜この項の構成＞

(1)　機能

(2)　定義

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

メッセージ識別子無しのメッセージを返します。

(2)　定義

public java.lang.String getPartialMessage()

(3)　引数

なし

(4)　戻り値

メッセージを返します。

(5)　例外

なし

9.　IwsSearchLoggerインターフェース

この章では，Enterprise SearchのJavaインターフェースのロギングインターフェースであるIwsSearchLoggerインターフェースおよびメソッドについて説明します。

＜この章の構成＞

9.1　インターフェースの概要

9.2　メソッドの詳細

9.1　インターフェースの概要

IwsSearchLoggerインターフェースは，Enterprise SearchのJavaインターフェースのロギングインターフェースです。このインターフェースを実装したクラスをIwsSearcherに組み込むことで，Enterprise SearchのJavaインターフェースのログ情報の出力先をカスタマイズすることができます。

インターフェース定義

public interface IwsSearchLogger

パッケージ名

jp.co.hitachi_system.iwsearch.lib.client

IwsSearchLoggerインターフェースのメソッドを次の表に示します。

表9-1　IwsSearchLoggerインターフェースのメソッド

メソッド | 機能概要
debug | デバッグメッセージを出力します。
error | エラーログを出力します。
info | インフォメーションメッセージを出力します。
isDebugEnabled | デバッグログの出力が可能かどうかを返します。
isErrorEnabled | エラーログの出力が可能かどうかを返します。
isInfoEnabled | インフォメーションログの出力が可能かどうかを返します。
isTraceEnabled | トレースログの出力が可能かどうかを返します。
isWarnEnabled | ワーニングログの出力が可能かどうかを返します。
trace | トレースメッセージを出力します。
warn | ワーニングメッセージを出力します。

9.2　メソッドの詳細

＜この節の構成＞

9.2.1　debug

9.2.2　error

9.2.3　info

9.2.4　isDebugEnabled

9.2.5　isErrorEnabled

9.2.6　isInfoEnabled

9.2.7　isTraceEnabled

9.2.8　isWarnEnabled

9.2.9　trace

9.2.10　warn

9.2.1　debug

＜この項の構成＞

(1)　機能

(2)　定義

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

デバッグメッセージを出力します。

Enterprise SearchのJavaインターフェース内のデバッグ情報を出力する際に，デバッグメッセージを引数としてコールバックされます。検索サーバーから取得した検索結果の情報を，デバッグメッセージとして出力します。

(2)　定義

void debug(java.lang.String debugMessage)

(3)　引数

debugMessage

デバッグメッセージが出力されます。

(4)　戻り値

なし

(5)　例外

なし

9.2.2　error

＜この項の構成＞

(1)　機能

(2)　定義

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

エラーログを出力します。

Enterprise SearchのJavaインターフェースや検索サーバーで検索続行不可能なエラーが発生した際に，エラーメッセージを引数としてコールバックされます。

(2)　定義

void error(java.lang.String errorMessage,java.lang.Throwable t)

(3)　引数

errorMessage

エラーメッセージが出力されます。

t

発生した例外です。例外が発生していない場合はnullが出力されます。

(4)　戻り値

なし

(5)　例外

なし

9.2.3　info

＜この項の構成＞

(1)　機能

(2)　定義

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

インフォメーションメッセージを出力します。

Enterprise SearchのJavaインターフェースのインフォメーション情報を出力する際に，インフォメーションメッセージを引数としてコールバックされます。

(2)　定義

void info(java.lang.String infoMessage)

(3)　引数

infoMessage

インフォメーションメッセージが出力されます。

(4)　戻り値

なし

(5)　例外

なし

9.2.4　isDebugEnabled

＜この項の構成＞

(1)　機能

(2)　定義

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

デバッグログの出力が必要かどうかを返します。

debugではログ出力を行うためにメッセージを生成するのに対し，事前にこのメソッドの戻り値でfalse(ログ出力しない)を指定するとメッセージを生成しない分だけ性能が良くなります。

IwsSearchLogger実装クラスで出力要否を判定できない場合は，必ず戻り値にtrueを返すようにしてください。

(2)　定義

boolean isDebugEnabled()

(3)　引数

なし

(4)　戻り値

true

デバッグログを出力します。

false

デバッグログを出力しません。

(5)　例外

なし

9.2.5　isErrorEnabled

＜この項の構成＞

(1)　機能

(2)　定義

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

エラーログの出力が必要かどうかを返します。

errorではログ出力を行うためにメッセージを生成するのに対し，事前にこのメソッドの戻り値でfalse(ログ出力しない)を指定するとメッセージを生成しない分だけ性能が良くなります。

IwsSearchLogger実装クラスで出力要否を判定できない場合は，必ず戻り値にtrueを返すようにしてください。

(2)　定義

boolean isErrorEnabled()

(3)　引数

なし

(4)　戻り値

true

エラーログを出力します。

false

エラーログを出力しません。

(5)　例外

なし

9.2.6　isInfoEnabled

＜この項の構成＞

(1)　機能

(2)　定義

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

インフォメーションログの出力が必要かどうかを返します。

infoではログ出力を行うためにメッセージを生成するのに対し，事前にこのメソッドの戻り値でfalse(ログ出力しない)を指定するとメッセージを生成しない分だけ性能が良くなります。

IwsSearchLogger実装クラスで出力要否を判定できない場合は，必ずtrueを返すようにしてください。

(2)　定義

boolean isInfoEnabled()

(3)　引数

なし

(4)　戻り値

true

インフォメーションログを出力します。

false

インフォメーションログを出力しません。

(5)　例外

なし

9.2.7　isTraceEnabled

＜この項の構成＞

(1)　機能

(2)　定義

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

トレースログの出力が必要かどうかを返します。

traceではログ出力を行うためにメッセージを生成するのに対し，事前にこのメソッドの戻り値でfalse(ログ出力しない)を指定するとメッセージを生成しない分だけ性能が良くなります。

IwsSearchLogger実装クラスで出力要否を判定できない場合は，必ず戻り値にtrueを返すようにしてください。

(2)　定義

boolean isTraceEnabled()

(3)　引数

なし

(4)　戻り値

true

トレースログを出力します。

false

トレースログを出力しません。

(5)　例外

なし

9.2.8　isWarnEnabled

＜この項の構成＞

(1)　機能

(2)　定義

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

ワーニングログの出力が必要かどうかを返します。

warnではログ出力を行うためにメッセージを生成するのに対し，事前にこのメソッドの戻り値でfalse(ログ出力しない)を指定するとメッセージを生成しない分だけ性能が良くなります。

IwsSearchLogger実装クラスで出力要否を判定できない場合は，必ず戻り値にtrueを返すようにしてください。

(2)　定義

boolean isWarnEnabled()

(3)　引数

なし

(4)　戻り値

true

ワーニングログを出力します。

false

ワーニングログを出力しません。

(5)　例外

なし

9.2.9　trace

＜この項の構成＞

(1)　機能

(2)　定義

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

トレースメッセージを出力します。

Enterprise SearchのJavaインターフェースのトレース情報を出力する際に，トレースメッセージを引数としてコールバックされます。

(2)　定義

void trace(java.lang.String traceMessage)

(3)　引数

traceMessage

トレースメッセージが出力されます。

(4)　戻り値

なし

(5)　例外

なし

9.2.10　warn

＜この項の構成＞

(1)　機能

(2)　定義

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

ワーニングメッセージを出力します。

Enterprise SearchのJavaインターフェースか検索サーバーで発生したワーニング情報を出力する際に，ワーニングメッセージを引数としてコールバックされます。

(2)　定義

void warn(java.lang.String warnMessage,java.lang.Throwable t)

(3)　引数

warnMessage

デバッグメッセージが出力されます。

t

発生した例外を設定します。

例外が発生していない場合はnullが出力されます。

(4)　戻り値

なし

(5)　例外

なし

10.　IwsSearchResultクラス

この章では，検索結果を表すIwsSearchResultクラスのインターフェース，およびメソッドについて説明します。

＜この章の構成＞

10.1　クラスの概要

10.2　メソッドの詳細

10.1　クラスの概要

IwsSearchResultクラスは，検索結果を表すクラスです。

このクラスはマルチスレッドには対応していません。複数のスレッドからこのクラスのオブジェクトを操作しないでください。

クラス定義

public class IwsSearchResult

extends java.lang.Object

パッケージ名

jp.co.hitachi_system.iwsearch.lib.client

IwsSearchResultクラスのメソッドを次の表に示します。

表10-1　IwsSearchResultクラスのメソッド

メソッド | 機能概要
getEntryCount | この検索結果が保持している検索結果エントリの件数を返します。
getHitCount | この検索結果のヒット件数を返します。
getPageShowCount | 1ページの検索結果エントリ件数を返します。
getResultList | 検索結果エントリをリスト形式で返します。
getSearchID | 検索ごとに採番される検索結果IDを返します。
getSimilarID | 類似コンテンツ検索時に検索元のコンテンツのエントリIDを返します。
getSimilarTitle | 類似コンテンツ検索時に検索元コンテンツのタイトルを返します。
getStartIndex | この検索結果の開始インデクスを返します。
getWarnMessageList | 検索時に発生したワーニングメッセージをリスト形式で返します。
isOverHit | ヒット件数表示制限が有効であるかどうかを返します。

10.2　メソッドの詳細

＜この節の構成＞

10.2.1　getEntryCount

10.2.2　getHitCount

10.2.3　getPageShowCount

10.2.4　getResultList

10.2.5　getSearchID

10.2.6　getSimilarID

10.2.7　getSimilarTitle

10.2.8　getStartIndex

10.2.9　getWarnMessageList

10.2.10　isOverHit

10.2.1　getEntryCount

＜この項の構成＞

(1)　機能

(2)　定義

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

この検索結果が保持している検索結果エントリの件数を返します。

(2)　定義

public int getEntryCount()

(3)　引数

なし

(4)　戻り値

検索結果エントリ件数を返します。

(5)　例外

なし

10.2.2　getHitCount

＜この項の構成＞

(1)　機能

(2)　定義

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

この検索結果のヒット件数を返します。

isOverHitがtrueを返す場合は，ヒット件数はこのメソッドで取得できるヒット件数以上です。

(2)　定義

public long getHitCount()

(3)　引数

なし

(4)　戻り値

この検索結果のヒット件数を返します。

(5)　例外

なし

10.2.3　getPageShowCount

＜この項の構成＞

(1)　機能

(2)　定義

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

1ページの検索結果エントリ件数を返します。

検索結果エントリの件数を返すgetEntryCountに対し，この検索結果内の検索結果エントリ件数に関係なくIwsSearchCond.setCountで指定した件数か，指定がなければデフォルトの1ページ内の検索結果エントリ件数(10)を返します。

(2)　定義

public int getPageShowCount()

(3)　引数

なし

(4)　戻り値

1ページの検索結果エントリ件数を返します。

(5)　例外

なし

10.2.4　getResultList

＜この項の構成＞

(1)　機能

(2)　定義

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

検索結果エントリをリスト形式で返します。

(2)　定義

public java.util.List<IwsSearchResultEntry> getResultList()

(3)　引数

なし

(4)　戻り値

検索結果エントリのリストを返します。

検索結果が無い場合は空のリストを返します。

(5)　例外

なし

10.2.5　getSearchID

＜この項の構成＞

(1)　機能

(2)　定義

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

検索ごとに採番される検索結果IDを返します。アクセスログの登録に使用します。

(2)　定義

public long getSearchID()

(3)　引数

なし

(4)　戻り値

検索結果IDを返します。

(5)　例外

なし

10.2.6　getSimilarID

＜この項の構成＞

(1)　機能

(2)　定義

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

類似コンテンツ検索時に検索元のコンテンツのエントリIDを返します。

(2)　定義

public long getSimilarID()

(3)　引数

なし

(4)　戻り値

類似コンテンツ検索元のエントリIDを返します。

類似コンテンツ検索未実施の場合は-1を返します。

(5)　例外

なし

10.2.7　getSimilarTitle

＜この項の構成＞

(1)　機能

(2)　定義

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

類似コンテンツ検索時に検索元のコンテンツのタイトルを返します。

(2)　定義

public java.lang.String getSimilarTitle()

(3)　引数

なし

(4)　戻り値

類似コンテンツ検索元のタイトルを返します。

類似コンテンツ検索未実施の場合はnullを返します。

(5)　例外

なし

10.2.8　getStartIndex

＜この項の構成＞

(1)　機能

(2)　定義

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

この検索結果の開始インデクスを返します。

(2)　定義

public long getStartIndex()

(3)　引数

なし

(4)　戻り値

この検索結果の開始インデクスを返します。

(5)　例外

なし

10.2.9　getWarnMessageList

＜この項の構成＞

(1)　機能

(2)　定義

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

検索時に発生したワーニングメッセージをリスト形式で返します。

(2)　定義

public java.util.List<java.lang.String> getWarnMessageList()

(3)　引数

なし

(4)　戻り値

ワーニングメッセージのリストを返します。

ワーニングメッセージが無い場合は空のリストを返します。

(5)　例外

なし

10.2.10　isOverHit

＜この項の構成＞

(1)　機能

(2)　定義

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

ヒット件数表示制限が有効であるかどうかを返します。

(2)　定義

public boolean isOverHit()

(3)　引数

なし

(4)　戻り値

true

検索サーバーでヒット件数表示機能が有効でヒット件数が制限されています。実際のヒット件数はgetHitCount以上となります。

false

ヒット件数表示制限が無効です。

(5)　例外

なし

11.　IwsSearchResultEntryクラス

この章では，検索結果エントリクラスであるIwsSearchResultEntryクラスのインターフェース，およびメソッドについて説明します。

＜この章の構成＞

11.1　クラスの概要

11.2　メソッドの詳細

11.1　クラスの概要

IwsSearchResultEntryクラスは，検索結果エントリクラスです。

クラス定義

public class IwsSearchResultEntry

extends java.lang.Object

パッケージ名

jp.co.hitachi_system.iwsearch.lib.client

IwsSearchResultEntryクラスのメソッドを次の表に示します。

表11-1　IwsSearchResultEntryクラスのメソッド

メソッド | 機能概要
getAttributes | この検索結果エントリの属性情報を返します。
getAuthor | この検索結果エントリに関連付けられているユーザー名を返します。
getCrawlerName | この検索結果エントリをクローリングしたクローラー名を返します。
getDataType | この検索結果エントリのデータ種別を返します。
getDate | この検索結果エントリの更新日時をjava.util.Date型で返します。
getEntryID | この検索結果エントリのエントリIDを返します。
getPath | この検索結果エントリの表示用パス情報を返します。
getSize | この検索結果エントリのデータサイズをbyte数で返します。
getSnippet | 検索キーワードがヒットした周辺文字列から作成したスニペットを返します。
getTitle | この検索結果エントリのタイトルを返します。
getUrl | この検索結果エントリにアクセスするためのURLを返します。
isExist | この検索結果エントリが有効であるかどうかについて返します。

＜この節の構成＞

11.1.1　フィールドの詳細

11.1.1　フィールドの詳細

フィールドの詳細を次の表に示します。

表11-2　フィールドの詳細

フィールド名 | データ種別 | 定義
DATA_TYPE_RSS | RSS | public static final int DATA_TYPE_RSS
DATA_TYPE_NTFS | NTFS | public static final int DATA_TYPE_NTFS
DATA_TYPE_WWW | WWW | public static final int DATA_TYPE_WWW
DATA_TYPE_NOTES | Notes | public static final int DATA_TYPE_NOTES
DATA_TYPE_RDB | RDB | public static final int DATA_TYPE_RDB
DATA_TYPE_GROUPMAX_BBS | Groupmax Collaboration 電子掲示板 | public static final int DATA_TYPE_GROUPMAX_BBS
DATA_TYPE_GROUPMAX_FORUM | Groupmax Collaboration 電子会議室 | public static final int DATA_TYPE_GROUPMAX_FORUM
DATA_TYPE_GROUPMAX_FILE_SHARING | Groupmax Collaboration ファイル共有 | public static final int DATA_TYPE_GROUPMAX_FILE_SHARING

11.2　メソッドの詳細

＜この節の構成＞

11.2.1　getAttributes

11.2.2　getAuthor

11.2.3　getCrawlerName

11.2.4　getDataType

11.2.5　getDate

11.2.6　getEntryID

11.2.7　getPath

11.2.8　getSize

11.2.9　getSnippet

11.2.10　getTitle

11.2.11　getUrl

11.2.12　isExist

11.2.1　getAttributes

＜この項の構成＞

(1)　機能

(2)　定義

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

この検索結果エントリの属性情報を返します。属性情報はGroupmaxコンテンツにだけ存在します。

(2)　定義

public java.util.List<jp.co.hitachi_system.iwsearch.lib.client.IwsAttribute> getAttributes()

(3)　引数

なし

(4)　戻り値

属性情報のリストを返します。

属性が無い場合は空の文字列を返します。

(5)　例外

なし

11.2.2　getAuthor

＜この項の構成＞

(1)　機能

(2)　定義

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

この検索結果エントリに関連付けられているユーザー名を返します。

(2)　定義

public java.lang.String getAuthor()

(3)　引数

なし

(4)　戻り値

関連付けられているユーザー名を返します。

ユーザー名が無い場合は空のリストを返します。

(5)　例外

なし

11.2.3　getCrawlerName

＜この項の構成＞

(1)　機能

(2)　定義

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

この検索結果エントリをクローリングしたクローラー名を返します。

(2)　定義

public java.lang.String getCrawlerName()

(3)　引数

なし

(4)　戻り値

crawlerName

クローラー名が不明の場合は空の文字列を返します。

(5)　例外

なし

11.2.4　getDataType

＜この項の構成＞

(1)　機能

(2)　定義

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

この検索結果エントリのデータ種別を返します。データ種別の種別値は次のとおりです。

表11-3　データ種別ごとの種別値

データ種別 | 種別値 | フィールド定義
RSS | 1 | CRAWL_TYPE_RSS
NTFS | 2 | CRAWL_TYPE_NTFS
WWW | 3 | CRAWL_TYPE_WWW
Notes | 4 | CRAWL_TYPE_NOTES
RDB | 5 | CRAWL_TYPE_RDB
Groupmax Collaboration電子掲示板 | 7 | CRAWL_TYPE_GROUPMAX_BBS
Groupmax Collaboration電子会議室 | 8 | CRAWL_TYPE_GROUPMAX_FORUM
Groupmax Collaborationファイル共有 | 9 | CRAWL_TYPE_GROUPMAX_FILE_SHARING

(2)　定義

public int getDataType()

(3)　引数

なし

(4)　戻り値

データ種別を返します。

データ種別が不明の場合は0を返します。

(5)　例外

なし

11.2.5　getDate

＜この項の構成＞

(1)　機能

(2)　定義

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

この検索結果エントリの更新日時をjava.util.Date型で返します。精度は秒です。

(2)　定義

public java.util.Date getDate()

(3)　引数

なし

(4)　戻り値

検索結果の更新日時を返します。

更新日時が無い場合はjava.util.Date型の1970/0/01 09:00:00を返します。

(5)　例外

なし

11.2.6　getEntryID

＜この項の構成＞

(1)　機能

(2)　定義

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

この検索結果エントリのエントリIDを返します。類似コンテンツ検索にはこのIDを指定してください。

(2)　定義

public long getEntryID()

(3)　引数

なし

(4)　戻り値

このコンテンツのエントリIDを返します。

エントリIDが不明の場合は0を返します。

(5)　例外

なし

11.2.7　getPath

＜この項の構成＞

(1)　機能

(2)　定義

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

この検索結果エントリの表示用パス情報を返します。

(2)　定義

public java.lang.String getPath()

(3)　引数

なし

(4)　戻り値

表示用パス情報を返します。

表示用パス情報が不明の場合は空の文字列を返します。

(5)　例外

なし

11.2.8　getSize

＜この項の構成＞

(1)　機能

(2)　定義

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

この検索結果エントリのデータサイズをbyte数で返します。

(2)　定義

public long getSize()

(3)　引数

なし

(4)　戻り値

データサイズのbyte数を返します。

データサイズが不明の場合は空の文字列を返します。

(5)　例外

なし

11.2.9　getSnippet

＜この項の構成＞

(1)　機能

(2)　定義

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

検索キーワードがヒットした周辺文字列から作成したスニペットを返します。

IwsSearchCond.setUseHighLightで検索結果のハイライトを指定している場合，検索キーワード部分はハイライトクラス属性を指定されている<span>タグで囲まれています。また，スニペット内にHTMLで特殊な扱いの文字がある場合，その文字をエスケープします。エスケープする文字についてはIwsSearchCond.setUseHtmlEscapeを参照してください。

(2)　定義

public java.lang.String getSnippet()

(3)　引数

なし

(4)　戻り値

この検索結果エントリのスニペットを返します。

本文が無い場合は空の文字列を返します。

(5)　例外

なし

11.2.10　getTitle

＜この項の構成＞

(1)　機能

(2)　定義

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

この検索結果エントリのタイトルを返します。

IwsSearchCond.setUseHighLightで検索結果のハイライトを指定している場合で，タイトルに検索キーワードを含むとき，検索キーワード部分はハイライトクラス属性を指定されている<span>タグで囲まれています。また，スニペット内にHTMLで特殊な扱いの文字がある場合，その文字をエスケープします。エスケープする文字についてはIwsSearchCond.setUseHtmlEscapeを参照してください。

(2)　定義

public java.lang.String getTitle()

(3)　引数

なし

(4)　戻り値

コンテンツタイトルを返します。

タイトルが無い場合は空の文字列を返します。

(5)　例外

なし

11.2.11　getUrl

＜この項の構成＞

(1)　機能

(2)　定義

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

この検索結果エントリにアクセスするためのURLを返します。

(2)　定義

public java.lang.String getUrl()

(3)　引数

なし

(4)　戻り値

この検索結果のURLを返します。

URLが無い場合は空の文字列を返します。

(5)　例外

なし

11.2.12　isExist

＜この項の構成＞

(1)　機能

(2)　定義

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

この検索結果エントリが有効であるかどうかについて返します。

クローリングやインデクス作成のタイミングによっては，無効なデータが検索結果として取得される場合があります。

このメソッドの戻り値がfalseの場合，この検索結果エントリは無効エントリです。タイトルやURLといった検索結果の情報はすべて無いか，不明となります。

(2)　定義

public boolean isExist()

(3)　引数

なし

(4)　戻り値

true

この検索結果エントリは有効

false

この検索結果は無効

(5)　例外

なし

12.　IwsSearchUtilクラス

この章では，Enterprise SearchのJavaインターフェースのユーティリティクラスであるIwsSearchUtilクラスのインターフェース，およびメソッドについて説明します。

＜この章の構成＞

12.1　クラスの概要

12.2　メソッドの詳細

12.1　クラスの概要

IwsSearchUtilクラスは，Enterprise SearchのJavaインターフェースのユーティリティクラスです。

クラス定義

public final class IwsSearchUtil
extends java.lang.Object

パッケージ名

jp.co.hitachi_system.iwsearch.lib.client

IwsSearchUtilクラスのメソッドを次の表に示します。

表12-1　IwsSearchUtilクラスのメソッド

メソッド | 機能概要
convertAndOrNotKeyword | AND，OR，NOTのキーワードをEnterprise SearchのJavaインターフェースの条件に指定するキーワードに変換します。

12.2　メソッドの詳細

＜この節の構成＞

12.2.1　convertAndOrNotKeyword

12.2.1　convertAndOrNotKeyword

＜この項の構成＞

(1)　機能

(2)　定義

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

AND，OR，NOTのキーワードをEnterprise SearchのJavaインターフェースの条件に指定するキーワードに変換します。

AND，OR，NOT内に複数のキーワードを指定したい場合は，複数のキーワードを半角スペースで区切って指定してください。変換した結果をIwsSearchCond.setKeywordに指定してください。

(2)　定義

public static java.lang.String convertAndOrNotKeyword(java.lang.String andKeyword, java.lang.String orKeyword, java.lang.String notKeyword)

(3)　引数

andKeyword

ANDキーワードを指定します。

指定しない場合は空文字かnullを指定します。

orKeyword

ORキーワードを指定します。

指定しない場合は空文字かnullを指定します。

notKeyword

NOTキーワードを指定します。

指定しない場合は空文字かnullを指定します。

(4)　戻り値

AND，OR，NOTを変換した検索キーワードを返します。

(5)　例外

なし

13.　検索サーバーとの認証とアクセス権検索

この章では，検索サーバーの認証設定ごとにEnterprise SearchのJavaインターフェースに指定する認証情報と，アクセス権検索の対応について説明します。

＜この章の構成＞

13.1　検索サーバーとの認証とアクセス権検索の対応

13.1　検索サーバーとの認証とアクセス権検索の対応

検索サーバーと接続して検索するためには，検索サーバーの認証設定に合わせてEnterprise SearchのJavaインターフェースに認証用のIDやパスワードを指定する必要があります。また，検索サーバーの認証設定やEnterprise SearchのJavaインターフェースに設定する条件によって，どのアクセス権を反映した検索結果を表示するかも変わります。検索サーバーの認証設定ごとにEnterprise SearchのJavaインターフェースに指定する認証情報と，アクセス権検索の対応について次に示します。

検索サーバーの設定は管理者画面で設定します。指定の詳細はマニュアル「uCosminexus Enterprise Search 運用ガイド」を参照してください。

表13-1　認証情報とアクセス権付き検索との対応

検索サーバーの認証設定
認証情報
アクセス権付き検索の対応

Webサービス認証
認証設定

認証要否
認証方法

ユーザー認証を利用
必要
独自認証
検索サーバーのユーザー管理に存在するユーザーのログインIDとパスワードを，IwsSearcherクラスのsetLoginIDとsetPasswordに指定します。
Enterprise SearchのJavaインターフェースの認証に指定したログインIDのユーザーに関連付けられたアクセス権が反映されます。

LDAP認証
検索サーバーのユーザー管理に存在するユーザーのログインIDとLDAPで管理されているパスワードを，IwsSearcherクラスのsetLoginIDとsetPasswordに指定します。

LDAP認証（ユーザー管理にActive Directoryを使用する）
検索サーバーで設定したActive Directoryに存在するユーザーのログインIDとパスワードを，IwsSearcherクラスのsetLoginIDとsetPasswordに指定します。
Enterprise SearchのJavaインターフェースに指定したActive Directoryのユーザーのアクセス権が反映されます。

任意
独自認証
検索サーバーの認証設定が”任意”の場合は，Enterprise SearchのJavaインターフェースに認証設定を指定しなくても検索できます。
認証設定を指定する場合は認証要否の項目”必要”を参照してください。
Enterprise SearchのJavaインターフェースに認証情報を指定しなかった場合は，アクセス権が無くても参照できるコンテンツだけを検索します。
認証情報を指定した場合は認証要否の項目”必要”を参照してください。

LDAP認証する

LDAP認証（ユーザー管理にActive Directoryを使用する）

不要
－
Enterprise SearchのJavaインターフェースの認証設定は必要ありません。設定しても無視します。
アクセス権が無くても参照できるコンテンツだけを検索します。

独自認証を利用
必要
独自認証
検索サーバーのWebサービス認証に指定したログインIDとパスワードを，IwsSearcherクラスのsetLoginIDとsetPasswordに指定します。
検索サーバーに登録済みのユーザーのログインIDをIwsSearchCondクラスのsetSearchLoginIDに指定することで，指定したユーザーのアクセス権が反映されます。

LDAP認証
検索サーバーのWebサービス認証に指定したログインIDとLDAPで管理されているパスワードを，IwsSearcherクラスのsetLoginIDとsetPasswordに指定します。

ユーザ管理にActive Directoryを使用する
検索サーバーのWebサービス認証に指定したユーザーのログインIDとパスワードを，IwsSearcherクラスのsetLoginIDとsetPasswordに指定します。
IwsSearchCondクラスのsetSearchLoginIDに検索サーバーで設定した，Active DirectoryのユーザーのログインIDを指定することで，指定したユーザーのアクセス権が反映されます。

任意
独自認証
検索サーバーの認証設定が”任意”の場合は，Enterprise SearchのJavaインターフェースに認証設定を指定しなくても検索できます。
認証設定を指定する場合は認証要否の項目”必要”を参照してください。
Enterprise SearchのJavaインターフェースに認証情報を指定しなかった場合は，アクセス権が無くても参照できるコンテンツだけを検索します。
認証情報を指定した場合は認証要否の項目”必要”を参照してください。

任意
LDAP認証

任意
LDAP認証（ユーザー管理にActive Directoryを使用する）

不要
－
Enterprise SearchのJavaインターフェースの認証設定は必要ありません。設定しても無視します。
アクセス権が無くても参照できるコンテンツだけを検索します。

14.　Enterprise Search Javaインターフェースのログ

この章では，Enterprise SearchのJavaインターフェースのログ出力について説明します。

＜この章の構成＞

14.1　ログ内容

14.2　アプリケーションプログラム上でのログ出力先の指定方法

14.1　ログ内容

Enterprise SearchのJavaインターフェースではエラー情報，障害調査用のトレース情報などのログを出力することが可能です。ログを出力するためには，アプリケーションプログラムでログの出力を実装する必要があります。

Enterprise SearchのJavaインターフェースではログを5種類に分類しています。それぞれのログで出力する内容を次に示します。

表14-1　ログの出力内容

ログ名称
出力するログ

エラー
・Enterprise SearchのJavaインターフェースで発生したエラー情報
・検索サーバーで発生したエラー情報

ワーニング
・Enterprise SearchのJavaインターフェースで発生したワーニング情報
・検索サーバーで発生したワーニング情報

インフォメーション
・検索リクエストの実行時間

デバッグ
・検索リクエストの詳細
・検索結果のダンプ

トレース
・関数開始終了トレース

14.2　アプリケーションプログラム上でのログ出力先の指定方法

アプリケーションプログラムからログの出力先を指定する方法を次に示します。

Enterprise SearchのJavaインターフェース内のIwsSearchLoggerインターフェースを実装したログクラスを作成し，アプリケーションプログラムのログへメッセージを出力する処理を実装します。

１で作成したクラスのインスタンスを，IwsSearcherクラスのインスタンスに，検索実行前にセットします。

IwsSearchLoggerクラスには各ログ出力時に実行されるコールバックメソッド（error，warn，info，debug，trace)と，それぞれのコールバックメソッドを呼び出すかどうかを判定するコールバックメソッド(isErrorEnabled，isWarnEnabled，isInfoEnabled，isDebugEnabled，isTraceEnabled）が定義されています。

それぞれのコールバックメソッドを呼び出すかどうかを判定するコールバックメソッド（isErrorEnabled，isWarnEnabled，isInfoEnabled，isDebugEnabled，isTraceEnabled）でtrueを返したときだけ，ログ出力時に実行されるコールバックメソッド（error，warn，info，debug，trace）を呼び出します。ログを出力しない場合，それぞれのコールバックメソッドを呼び出すかどうかを判定するコールバックメソッド（isErrorEnabled，isWarnEnabled，isInfoEnabled，isDebugEnabled，isTraceEnabled）でfalseを返した方がEnterprise SearchのJavaインターフェースの処理性能が上がります。

アプリケーションプログラムを運用している間は，エラーログのみ出力する運用を推奨します。障害時の調査や，アプリケーションプログラム開発時の検索動作の確認に，エラー以外のログ情報を必要に応じて出力してください。

15.　注意事項

この章では，Enterprise SearchのJavaインターフェースを使用する際の注意事項ついて説明します。

＜この章の構成＞

15.1　Enterprise Search Javaインターフェースを使用する際の注意事項

15.1　Enterprise Search Javaインターフェースを使用する際の注意事項

Enterprise SearchのJavaインターフェースを使用する際の注意事項を次に示します。

Enterprise SearchのJavaインターフェースと検索サーバーはHTTPプロトコルで通信します。Enterprise SearchのJavaインターフェースを利用したアプリケーションを実行するマシンと検索サーバーが稼働するマシン間は，HTTPプロトコルで通信できるようにしてください。また，HTTPプロトコル通信時にBasic認証やDigest認証，Form認証，SiteMinderによる認証が発生するような環境では利用できません。認証が発生しないネットワーク構成にしてください。

Enterprise SearchのJavaインターフェースと検索サーバー間の通信は検索リクエストも検索結果も平文でやりとりします。安全なネットワーク下でEnterprise SearchのJavaインターフェース利用マシンと検索サーバー運用マシンを接続してください。通信の暗号化が必要な場合は，検索サーバーをHTTPSで運用し，プログラム中で指定する接続検索サーバーもHTTPSとしてください。

Enterprise SearchのJavaインターフェースと検索サーバーがHTTPSで通信する場合，Enterprise SearchのJavaインターフェースを呼び出しているJava環境で検索サーバーのSSLの証明書が信頼されていなくても（証明書で警告が発生しても）無視して通信します。ただし，SSLの証明書内のホスト名と実際に接続するURLのホスト名が異なる場合は接続できません。

Enterprise SearchのJavaインターフェースに指定可能な検索条件の限界は次のとおりです。

文章検索：30,000文字（30,000文字より後ろは無視する）

文章検索以外の指定：合計2,000文字まで
UCS-2の範囲を超える文字は1文字を2文字として数えます。

Enterprise SearchのJavaインターフェースを使用するアプリケーションプログラム上でJavaのセキュリティチェックを行う場合は，セキュリティポリシーに次の指定を加えてください。

grant codeBase "file:Enterprise Searchインストールディレクトリ/lib/iwsSearch.jar"
{
permission java.net.SocketPermission "検索サーバーホスト名", "connect";
};

※アンダーバーの部分は，構築環境に応じた値を設定してください。

16.　エラーメッセージ

この章では，Enterprise SearchのJavaインターフェースのエラーメッセージについて説明します。

＜この章の構成＞

16.1　出力形式

16.2　メッセージ一覧

16.1　出力形式

Enterprise SearchのJavaインターフェースのエラーメッセージはEnterprise SearchのJavaインターフェースがスローしたIwsSearchExceptionクラスのgetMessageで取得することができます。

出力される形式は次のとおりです。

KMESnnnn(n)-L : メッセージテキスト

KMES

メッセージプレフィクスです。

nnnn(n)

メッセージ番号です。

L

メッセージのレベルです。Eが出力されます。

E（Error）

エラーレベルのトラブルが起きたことを通知するメッセージです。

このメッセージが発行されたときは処理を中断します。ただし，致命的なエラーでなければ，処理を再開させることができます。

メッセージテキスト

メッセージの内容が出力されます。

＜この節の構成＞

16.1.1　メッセージの説明形式

16.1.1　メッセージの説明形式

メッセージは次の形式で説明しています。

メッセージ識別子

メッセージテキスト

可変値の説明※

（S）

メッセージ出力時のシステムの動作

（O）

メッセージ出力時のユーザーの動作※

注※

メッセージによっては記述しないものがあります。なお，「保守員に連絡してください」とある場合，サポートサービス契約に基づいてシステム管理者が弊社問い合わせ窓口に連絡してください。

16.2　メッセージ一覧

＜この節の構成＞

KMES15000-E

KMES15001-E

KMES15002-E

KMES15003-E

KMES15005-E

KMES15006-E

KMES15007-E

KMES15008-E

KMES15009-E

KMES15000-E

接続先のURLが不正です。(接続先URL:%1)

%1 = IwsSearcherに指定したURL

（S）

IwsSearcherに指定したURLがURLとして不正な値です。

（O）

指定するURLを見なおしてください。

KMES15001-E

検索サーバーとの通信中にエラーが発生しました。(詳細要因:%1)

%1 = エラーの詳細要因

（S）

検索サーバーとの通信中にエラーが発生しました。

（O）

次のどれかで対処してください。

検索サーバーが動作していることを確認してください。

Enterprise SearchのJavaインターフェースを使用するアプリケーションプログラムが動作するマシンから検索サーバーに接続可能かどうかを確認してください。

詳細要因のメッセージを見て対処してください。

KMES15002-E

検索結果の解析に失敗しました。(詳細要因：%1)

%1 = エラーの詳細要因

（S）

検索サーバーから取得したデータの解析に失敗しました。

（O）

次のどれかで対処してください。

検索サーバーが動作していることを確認してください。

接続先が正しいかどうか確認してください。

上記で解決しない場合は保守員に連絡してください。

KMES15003-E

検索サーバーとの認証に失敗しました。(詳細要因:%1)

%1 = 認証失敗の詳細要因

（S）

検索サーバーとの認証に失敗しました。

（O）

次のいずれかで対処してください。

検索サーバーのWebサービス設定の認証設定を見なおしてください。

Enterprise SearchのJavaインターフェースに設定している認証情報を確認してください。

KMES15005-E

検索に失敗しました。(詳細要因：%1)

%1 = エラーの詳細要因

（S）

検索条件が不正です。

（O）

検索条件を見なおしてください。

KMES15006-E

システムエラーが発生しました。(詳細要因：%1)

%1 = エラーの詳細要因

（S）

Enterprise SearchのJavaインターフェース内で内部矛盾が発生しています。

（O）

保守員に連絡してください。

KMES15007-E

検索サーバーが見つかりません。(接続先URL：%1)

%1 = IwsSearcherに指定したURL

（S）

接続先に指定したURLのホストが見つかりません。

（O）

次のいずれかで対処してください。

接続先のURLが正しいか確認してください。

接続先の検索サーバーが動作しているか確認してください。

KMES15008-E

検索サーバーでエラーが発生しました。(詳細要因：%1)

%1 = エラーの詳細要因

（S）

検索サーバーで検索時にエラーが発生しました。

（O）

検索サーバーのログを確認して発生しているエラー原因を取り除いてください。

KMES15009-E

Active Directoryからのアクセス権取得に失敗しました。サーバー設定画面の認証設定を見なおしてください。

（S）

Active Directoryからアクセス権を取得する時にログインに失敗しました。

（O）

サーバー設定画面に指定した"ActiveDirectoryログインID"と"ActiveDirectoryログインパスワード"が正しいかどうか確認してください。

付録

＜この付録の構成＞

付録A　このマニュアルの参考情報

付録A　このマニュアルの参考情報

このマニュアルを読むにあたっての参考情報を示します。

＜この節の構成＞

付録A.1　関連マニュアル

付録A.2　英略語

付録A.1　関連マニュアル

このマニュアルの関連マニュアルを次に示します。必要に応じてお読みください。

uCosminexus Enterprise Search　環境設定ガイド（3020-3-H90）
Enterprise Searchの環境設定について説明しています。

uCosminexus Enterprise Search　運用ガイド（3020-3-H91）
uCosminexus Enterprise Searchをシステム管理者としての運用する方法について説明しています。

uCosminexus Enterprise Search　ユーザーズガイド（3020-3-H92）
uCosminexus Enterprise Searchの検索画面の操作方法について説明しています。

uCosminexus Enterprise Search　メッセージ（3020-3-H93）
Enterprise Searchで出力されるメッセージについて知りたい場合に参照してください。

付録A.2　英略語

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

英略語 | 英字での表記
API | Application Program Interface
LDAP | Lightweight Directory Access Protocol
HTML | Hyper Text Markup Language
ID | Identifier
NTFS | NT File System
RDB | Relational Database System
RSS | Rich Site Summary
SSL | Secure Socket Layer
UCS-2 | Universal multi-octet coded Character Set 2
URL | Uniform Resource Locator
WWW | World Wide Web

索引

[Ａ][Ｃ][Ｄ][Ｅ][Ｇ][Ｉ][Ｋ][Ｓ][Ｔ][Ｕ][Ｗ]
[ア行][カ行][タ行][ハ行][マ行][ラ行]

(英字)

(Ａ)

addAddress

addAttribute

addAttributeOr

addAuthor

addCrawlType

addExtension

addFileName

(Ｃ)

clearAddressList

clearAttribute

clearAttributeOr

clearAuthorList

clearCrawlType

clearExtension

clearFileNameList

convertAndOrNotKeyword

(Ｄ)

debug

(Ｅ)

Enterprise Search Javaインターフェースのログ

Enterprise Search Javaインターフェースを使用する際の注意事項

error

(Ｇ)

getAddressList

getAttribute

getAttributeOr

getAttributes

getAuthor

getAuthorList

getCount

getCountOnly

getCrawlerName

getCrawlTypeList

getCurrentPage

getDataType

getDate(IwsSearchCond)

getDate(IwsSearchResultEntry)

getDateFilterType

getEndDate

getEntryCount

getEntryID

getExtensionList

getFileNameList

getHighLightClassName

getHitCount

getKeyword

getLastPageIndex

getLastPageNum

getMaxSize

getMessage

getMessageID

getMinSize

getName

getNextPageIndex

getOrder

getPageIndex

getPageList

getPageShowCount

getPartialMessage

getPath

getPrevPageIndex

getResultList

getSearchID

getSearchLoginID

getSentence

getSimilarID

getSimilarID

getSimilarTitle

getSize

getSnippet

getSnippetSize

getSort

getStartIndex(IwsSearchCond)

getStartIndex(IwsSearchResult)

getTimeout

getTitle

getUrl

getUseHighLight

getUseHtmlEscape

getValue

getWarnMessageList

(Ｉ)

info

isDebugEnabled

isErrorEnabled

isExist

isInfoEnabled

isLastPage

isOverHit

isStartPage

isTraceEnabled

isWarnEnabled

IwsAttribute

IwsAttributeクラス

IwsAttributeクラスの概要

IwsAttributeコンストラクタの詳細

IwsResultPageHelper

IwsResultPageHelperクラス

IwsResultPageHelperクラスの概要

IwsSearchCond

IwsSearchCondクラス

IwsSearchCondクラスの概要

IwsSearcher

IwsSearcherクラス

IwsSearcherクラスの概要

IwsSearchExceptionクラス

IwsSearchExceptionクラスの概要

IwsSearchLoggerインターフェース

IwsSearchResultEntryクラス

IwsSearchResultEntryクラスの概要

IwsSearchResultクラス

IwsSearchResultクラスの概要

IwsSearchUtilクラス

IwsSearchUtilクラスの概要

(Ｋ)

KMES15000-E

KMES15001-E

KMES15002-E

KMES15003-E

KMES15005-E

KMES15006-E

KMES15007-E

KMES15008-E

KMES15009-E

(Ｓ)

search

setCount

setCountOnly

setDate

setDateFilterType

setEndDate

setHighLightClassName

setKeyword

setLog

setLoginID

setMaxSize

setMinSize

setOrder

setPassword

setSearchLoginID

setSentence

setSimilarID

setSnippetSize

setSort

setStartIndex

setTimeout

setUseHighLight

setUseHtmlEscape

(Ｔ)

trace

(Ｕ)

uCosminexus Enterprise Search Javaインターフェースの概要

(Ｗ)

warn

(ア行)

(あ)

アプリケーションプログラム上でのログ出力先の指定方法

(え)

英略語

エラー出力形式

エラーメッセージ

(カ行)

(か)

開発環境

開発環境

関連マニュアル

(く)

クラスメソッドの発行順序の例

クラスメソッドの発行順序例

(け)

検索サーバーとの認証とアクセス権検索

検索サーバーとの認証とアクセス権検索の対応

(こ)

このマニュアルの参考情報

コンパイルおよび実行方法

(タ行)

(ち)

注意事項

(て)

提供する機能

(ハ行)

(ふ)

フィールドの詳細

(マ行)

(め)

メッセージ一覧

メッセージの説明形式

(ラ行)

(ろ)

ログ内容

■ 商標類

Active Directoryは，米国Microsoft Corporationの，米国およびその他の国における登録商標または商標です。
Lotus Notesは，IBM Corporationの登録商標です。
MicrosoftおよびWindowsは，米国Microsoft Corporationの米国およびその他の国における登録商標または商標です。
OracleとJavaは，Oracle Corporation 及びその子会社，関連会社の米国及びその他の国における登録商標です。
SiteMinderは，CA, Inc.の米国およびその他の国における登録商標または商標です。