fuku.eb4j
クラス SubBook

java.lang.Object
  上位を拡張 fuku.eb4j.SubBook

public final class SubBook
extends Object

副本クラス。

バージョン:
0.3.4
作成者:
Hisaya FUKUMOTO

メソッドの概要
 SubAppendix getAppendix()
          この副本に対応する付録パッケージを返します。
 Book getBook()
          この副本が含まれる書籍を返します。
 Object getCandidate(int multiIndex, int entryIndex, Hook hook)
          この副本の指定されたエントリの候補一覧を返します。
 Object getCopyright(Hook hook)
          この副本の著作権表示を返します。
 ExtFont getFont()
          現在設定されているサイズの外字を返します。
 ExtFont getFont(int type)
          指定されたサイズの外字を返します。
 BinaryData getGraphicData()
          この副本の画像データを返します。
 EBFile getGraphicFile()
          この副本の画像ファイルを返します。
 Object getHeading(long pos, Hook hook)
          指定位置の見出しを返します。
 Object getHeading(Result result, Hook hook)
          指定位置の見出しを返します。
 Object getMenu(Hook hook)
          この副本のメニュー表示を返します。
 File getMovieFile(String name)
          動画ファイルを返します。
 File[] getMovieFileList()
          動画ファイルのリストを返します。
 int getMultiCount()
          複合検索の数を返します。
 int getMultiEntryCount(int multiIndex)
          指定された複合検索のエントリ数を返します。
 String getMultiEntryLabel(int multiIndex, int entryIndex)
          指定されたエントリのラベルを返します。
 String getMultiTitle(int multiIndex)
          指定された複合検索のタイトルを返します。
 String getName()
          この副本のディレクトリ名を返します。
 Result getNextResult()
          次の検索結果を返します。
 BinaryData getSoundData()
          この副本の音声データを返します。
 EBFile getSoundFile()
          この副本の音声ファイルを返します。
 Object getText(long pos, Hook hook)
          指定位置の本文を返します。
 Object getText(Result result, Hook hook)
          指定位置の本文を返します。
 EBFile getTextFile()
          この副本の本文ファイルを返します。
 String getTitle()
          この副本のタイトルを返します。
 boolean hasCopyright()
          この副本が著作権表示をサポートしているかどうかを判別します。
 boolean hasEndwordSearch()
          この副本が後方一致検索をサポートしているかどうかを判別します。
 boolean hasExactwordSearch()
          この副本が完全一致検索をサポートしているかどうかを判別します。
 boolean hasKeywordSearch()
          この副本が条件検索をサポートしているかどうかを判別します。
 boolean hasMenu()
          この副本がメニューをサポートしているかどうかを判別します。
 boolean hasMultiEntryCandidate(int multiIndex, int entryIndex)
          指定されたエントリに候補があるかどうかを判別します。
 boolean hasMultiSearch()
          この副本が複合検索をサポートしているかどうかを判別します。
 boolean hasWordSearch()
          この副本が前方一致検索をサポートしているかどうかを判別します。
 void searchEndword(String word)
          後方一致検索を行います。
 void searchExactword(String word)
          完全一致検索を行います。
 void searchKeyword(String[] word)
          条件検索を行います。
 void searchMulti(int multiIndex, String[] word)
          複合検索を行います。
 void searchWord(String word)
          前方一致検索を行います。
 void setFont(int type)
          使用する外字を指定されたサイズに設定します。
 String toString()
          このクラスの文字列表現(副本のタイトル)を返します。
 
クラス java.lang.Object から継承されたメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

メソッドの詳細

getBook

public Book getBook()
この副本が含まれる書籍を返します。

戻り値:
書籍

getAppendix

public SubAppendix getAppendix()
この副本に対応する付録パッケージを返します。

戻り値:
付録パッケージ

getTitle

public String getTitle()
この副本のタイトルを返します。

戻り値:
タイトル

getName

public String getName()
この副本のディレクトリ名を返します。

戻り値:
副本のディレクトリ名

getFont

public ExtFont getFont()
現在設定されているサイズの外字を返します。

戻り値:
外字

getFont

public ExtFont getFont(int type)
指定されたサイズの外字を返します。

パラメータ:
type - 外字の種類
戻り値:
外字
例外:
IllegalArgumentException - 外字の種類が不当な場合
関連項目:
ExtFont.FONT_16, ExtFont.FONT_24, ExtFont.FONT_30, ExtFont.FONT_48

setFont

public void setFont(int type)
使用する外字を指定されたサイズに設定します。

パラメータ:
type - 外字の種類
例外:
IllegalArgumentException - 外字の種類が不当な場合
関連項目:
ExtFont.FONT_16, ExtFont.FONT_24, ExtFont.FONT_30, ExtFont.FONT_48

getGraphicData

public BinaryData getGraphicData()
この副本の画像データを返します。

戻り値:
画像データ

getSoundData

public BinaryData getSoundData()
この副本の音声データを返します。

戻り値:
音声データ

getTextFile

public EBFile getTextFile()
この副本の本文ファイルを返します。

戻り値:
本文ファイル

getGraphicFile

public EBFile getGraphicFile()
この副本の画像ファイルを返します。

戻り値:
画像ファイル

getSoundFile

public EBFile getSoundFile()
この副本の音声ファイルを返します。

戻り値:
音声ファイル

getMovieFileList

public File[] getMovieFileList()
動画ファイルのリストを返します。

戻り値:
動画ファイルのリスト

getMovieFile

public File getMovieFile(String name)
動画ファイルを返します。

パラメータ:
name - ファイル名
戻り値:
動画ファイル

getHeading

public Object getHeading(Result result,
                         Hook hook)
                  throws EBException
指定位置の見出しを返します。

パラメータ:
result - 検索結果
hook - フック (nullの場合はデフォルトのフック)
戻り値:
フックによって加工されたオブジェクト
例外:
EBException - ファイル読み込み中にエラーが発生した場合

getHeading

public Object getHeading(long pos,
                         Hook hook)
                  throws EBException
指定位置の見出しを返します。

パラメータ:
pos - データ位置
hook - フック (nullの場合はデフォルトのフック)
戻り値:
フックによって加工されたオブジェクト
例外:
EBException - ファイル読み込み中にエラーが発生した場合

getText

public Object getText(Result result,
                      Hook hook)
               throws EBException
指定位置の本文を返します。

パラメータ:
result - 検索結果
hook - フック (nullの場合はデフォルトのフック)
戻り値:
フックによって加工されたオブジェクト
例外:
EBException - ファイル読み込み中にエラーが発生した場合

getText

public Object getText(long pos,
                      Hook hook)
               throws EBException
指定位置の本文を返します。

パラメータ:
pos - データ位置
hook - フック (nullの場合はデフォルトのフック)
戻り値:
フックによって加工されたオブジェクト
例外:
EBException - ファイル読み込み中にエラーが発生した場合

getMenu

public Object getMenu(Hook hook)
               throws EBException
この副本のメニュー表示を返します。

パラメータ:
hook - フック (nullの場合はデフォルトのフック)
戻り値:
フックによって加工されたオブジェクト (メニュー表示がサポートされていない場合はnull)
例外:
EBException - ファイル読み込み中にエラーが発生した場合

getCopyright

public Object getCopyright(Hook hook)
                    throws EBException
この副本の著作権表示を返します。

パラメータ:
hook - フック (nullの場合はデフォルトのフック)
戻り値:
フックによって加工されたオブジェクト (著作権表示がサポートされていない場合はnull)
例外:
EBException - ファイル読み込み中にエラーが発生した場合

getNextResult

public Result getNextResult()
                     throws EBException
次の検索結果を返します。

戻り値:
検索結果 (次の検索結果がない場合null)
例外:
EBException - 検索中にエラーが発生した場合

searchExactword

public void searchExactword(String word)
                     throws EBException
完全一致検索を行います。

パラメータ:
word - 検索語
例外:
EBException - 検索中にエラーが発生した場合

searchWord

public void searchWord(String word)
                throws EBException
前方一致検索を行います。

パラメータ:
word - 検索語
例外:
EBException - 検索中にエラーが発生した場合

searchEndword

public void searchEndword(String word)
                   throws EBException
後方一致検索を行います。

パラメータ:
word - 検索語
例外:
EBException - 検索中にエラーが発生した場合

searchKeyword

public void searchKeyword(String[] word)
                   throws EBException
条件検索を行います。

パラメータ:
word - 検索語
例外:
EBException - 検索中にエラーが発生した場合

searchMulti

public void searchMulti(int multiIndex,
                        String[] word)
                 throws EBException
複合検索を行います。

パラメータ:
multiIndex - 複合検索のインデックス
word - 検索語 (外字が含まれる場合は外字を"\####"のように"\"でエスケープして文字コードを記述すること)
例外:
EBException - 検索中にエラーが発生した場合
IllegalArgumentException - 引数の値が不当な場合

hasMenu

public boolean hasMenu()
この副本がメニューをサポートしているかどうかを判別します。

戻り値:
メニューをサポートしている場合はtrue、そうでない場合はfalse

hasCopyright

public boolean hasCopyright()
この副本が著作権表示をサポートしているかどうかを判別します。

戻り値:
著作権表示をサポートしている場合はtrue、そうでない場合はfalse

hasExactwordSearch

public boolean hasExactwordSearch()
この副本が完全一致検索をサポートしているかどうかを判別します。

戻り値:
完全一致検索をサポートしている場合はtrue、そうでない場合はfalse

hasWordSearch

public boolean hasWordSearch()
この副本が前方一致検索をサポートしているかどうかを判別します。

戻り値:
前方一致検索をサポートしている場合はtrue、そうでない場合はfalse

hasEndwordSearch

public boolean hasEndwordSearch()
この副本が後方一致検索をサポートしているかどうかを判別します。

戻り値:
後方一致検索をサポートしている場合はtrue、そうでない場合はfalse

hasKeywordSearch

public boolean hasKeywordSearch()
この副本が条件検索をサポートしているかどうかを判別します。

戻り値:
条件検索をサポートしている場合はtrue、そうでない場合はfalse

hasMultiSearch

public boolean hasMultiSearch()
この副本が複合検索をサポートしているかどうかを判別します。

戻り値:
複合検索をサポートしている場合はtrue、そうでない場合はfalse

getMultiCount

public int getMultiCount()
複合検索の数を返します。

戻り値:
複合検索数

getMultiTitle

public String getMultiTitle(int multiIndex)
指定された複合検索のタイトルを返します。

パラメータ:
multiIndex - 複合検索のインデックス
戻り値:
複合検索のタイトル
例外:
IllegalArgumentException - インデックスの値が不当な場合

getMultiEntryCount

public int getMultiEntryCount(int multiIndex)
指定された複合検索のエントリ数を返します。

パラメータ:
multiIndex - 複合検索のインデックス
戻り値:
エントリ数
例外:
IllegalArgumentException - インデックスの値が不当な場合

getMultiEntryLabel

public String getMultiEntryLabel(int multiIndex,
                                 int entryIndex)
指定されたエントリのラベルを返します。

パラメータ:
multiIndex - 複合検索のインデックス
entryIndex - エントリのインデックス
戻り値:
エントリのラベル
例外:
IllegalArgumentException - インデックスの値が不当な場合

getCandidate

public Object getCandidate(int multiIndex,
                           int entryIndex,
                           Hook hook)
                    throws EBException
この副本の指定されたエントリの候補一覧を返します。

パラメータ:
multiIndex - 複合検索のインデックス
entryIndex - エントリのインデックス
hook - フック (nullの場合はデフォルトのフック)
戻り値:
フックによって加工されたオブジェクト (候補一覧が存在しない場合はnull)
例外:
EBException - ファイル読み込み中にエラーが発生した場合
IllegalArgumentException - インデックスの値が不当な場合

hasMultiEntryCandidate

public boolean hasMultiEntryCandidate(int multiIndex,
                                      int entryIndex)
指定されたエントリに候補があるかどうかを判別します。

パラメータ:
multiIndex - 複合検索のインデックス
entryIndex - エントリのインデックス
戻り値:
エントリに候補がある場合はtrue、そうでない場合はfalse
例外:
IllegalArgumentException - インデックスの値が不当な場合

toString

public String toString()
このクラスの文字列表現(副本のタイトル)を返します。

オーバーライド:
クラス Object 内の toString
戻り値:
文字列表現


Copyright © 2002-2004 Hisaya FUKUMOTO. All rights reserved.