パッケージ jp.co.antenna.ptl

クラス PtlSearchTextResult

java.lang.Object
jp.co.antenna.ptl.PtlSearchTextResult
すべての実装されたインタフェース:
AutoCloseable
public class PtlSearchTextResult extends Object implements AutoCloseable
PtlPDFDocument/PtlPageのsearchText関数で取得されるテキスト検索結果を表現したクラスです。 
 
  PtlSearchTextResults
     PtlSearchTextResult
        ページ番号
        検索に使用した文字
        PtlSearchTextResultDetails
           PtlSearchTextResultDetail
              検索でヒットした文字
              検索でヒットした文字を囲むQuadPoint

(例) "日本の夏"と"ヨーロッパの冬"で検索して3箇所ヒット
    PtlSearchTextResults
        PtlSearchTextResult
            1ページ
            "日本の夏"
            PtlSearchTextResultDetails
                PtlSearchTextResultDetail
                "日本の夏"
        PtlSearchTextResult
            1ページ
            "日本の夏"
            PtlSearchTextResultDetails
                PtlSearchTextResultDetail
                "日本の"
                PtlSearchTextResultDetail
                "夏"
        PtlSearchTextResult
            1ページ
            "ヨーロッパの冬"
            PtlSearchTextResultDetails
                PtlSearchTextResultDetail
                "ヨーロッパの冬"

  • コンストラクタの詳細

    • PtlSearchTextResult

      public PtlSearchTextResult() throws PtlException
      コンストラクタ
      例外:
      PtlException - 例外

    • PtlSearchTextResult

      public PtlSearchTextResult(PtlSearchTextResult obj) throws PtlException
      コピーコンストラクタ
      alias copy
      パラメータ:
      obj - コピー元オブジェクト。
      例外:
      PtlException - 例外

  • メソッドの詳細

    • close

      public void close()
      終了処理。

      このオブジェクトが抱えているネイティブ側にあるリソースなどを廃棄して終了処理を行ないます。
      このオブジェクトを使い終わったら必ず呼ばなければなりません。

      定義:
      close インタフェース内 AutoCloseable

    • getPageNumber

      public int getPageNumber() throws PtlException
      テキスト検索したページ番号を取得。

      ページ番号は0オリジンです。

      戻り値:
      検索したページ番号。
      例外:
      PtlException - 例外

    • getKeyword

      public String getKeyword() throws PtlException
      テキスト検索に使用した文字を取得。
      戻り値:
      検索に使用した文字
      例外:
      PtlException - 例外

    • getResultDetails

      public PtlSearchTextResultDetails getResultDetails() throws PtlException
      テキスト検索結果の詳細コンテナを取得。

      検索結果の詳細コンテナを取得します。
      検索した結果を1つのQuadPointで囲めることができたら詳細コンテナは1つの詳細のみ持ちますが、
      複数のQuaddPointを使うことになった場合は、複数の詳細を持つことになります。
      (例)
      例えば、"日本の夏"を検索して、"日本の"と"夏"が別のQuadPointで囲まれた場合、
      "日本の"と"夏"が別々のPtlSearchTextResultDetailに設定されることになります。
      この場合、PtlSearchTextResultDetailsには2件のPtlSearchTextResultDetailが格納されています。

      戻り値:
      検索結果の詳細コンテナ。
      例外:
      PtlException - 例外