dssp.brailleLib

クラス BrailleInfo

java.lang.Object

dssp.brailleLib.BrailleInfo

すべての実装されたインタフェース:

java.lang.Cloneable

public class BrailleInfo
extends java.lang.Object
implements java.lang.Cloneable

墨字と点字の情報

作成者:

DSSP/Minoru Yagi

ネストされたクラスの概要

ネストされたクラス

修飾子とタイプ	クラスと説明
static class	BrailleInfo.CHECK この字の前後に区切り符号の確認が必要か
static class	BrailleInfo.EXTRA 外字符、大文字符などの符号
static class	BrailleInfo.TABLE 行列、表の位置情報 ・宣言の順に開始と終了とをチェックするので、順場を変えてはいけない
static class	BrailleInfo.TABLE_OPTION 行列や表のオプション情報

フィールドの概要

フィールド

修飾子とタイプ	フィールドと説明
static int	MAX_DOT_COUNT マスの点の最大数

メソッドの概要

メソッド

修飾子とタイプ	メソッドと説明
int	addDotList(int[] dots) マスを追加する ・マスの番号に-1を指定して、addDotListを呼ぶ
int	addDotList(int index, int[] dots) 番号を指定してマスを追加する ・指定した番号以後にマスがある場合は右に移動する
BrailleInfo	clone() 複製する
boolean	delDotList(int index) マスを削除する
boolean	equals(java.lang.Object o)
java.lang.String	getDesc() 説明を取得する
int[]	getDotList(int index) マスの点のリストを取得する
int	getDotListCount() マスの数を取得する ・外字符、大文字符などの符号は含まない
BrailleInfo	getExtraCode(BrailleInfo.EXTRA extra) 外字符、大文字符などの符号のBraleInfoを取得する
java.lang.String	getSumiji() 墨字を取得する
<T> T	getTableOption(BrailleInfo.TABLE_OPTION key) 行列や表のオプション情報を取得するKbr/>
int	hashCode()
boolean	haveExtra(BrailleInfo.EXTRA extra) 外字符、大文字付などの符号の有無を取得する
boolean	haveTable(BrailleInfo.TABLE mark) 行列や表の位置情報を確認する
boolean	isEmpty() 空点字かどうかを取得する
boolean	isExtra() 外字符、大文字符などの符号かどうかを取得する
boolean	isExtraOf(BrailleInfo.EXTRA extra) 外字符、大文字符などの符号かどうかを取得する
boolean	isLineBreak() 改行文字の設定を取得する
int	moveLeft(int index) マスを左に移動する ・indexが1より小さいか、マスの数以上の場合は何もしない
int	moveRight(int index) マスを右に移動する ・indexが負か、(マスの数-1)以上の場合は何もしない
boolean	needCheck(BrailleInfo.CHECK check) この字の前後に区切り符号の確認が必要かを取得する
static BrailleInfo	newBrailleInfo(BrailleDict dict) インスタンスを生成する
void	setCheck(BrailleInfo.CHECK check, boolean flag)
void	setDesc(java.lang.String desc) 説明を設定する
void	setDotList(int index, int[] dots) マスを入れ替える
void	setExtra(BrailleInfo.EXTRA extra, boolean flag) 外字符、大文字符などの符号の有無を設定する
void	setLineBreak(boolean flag) 改行文字の設定をする
void	setSumiji(java.lang.String sumiji) 墨字を登録する
void	setTable(BrailleInfo.TABLE mark, java.util.EnumMap<BrailleInfo.TABLE_OPTION,java.lang.Object> options) 行列や表のオプション情報を設定する ・オプション情報はTABLE_OPTION
java.lang.String	toString()
void	unsetTable(BrailleInfo.TABLE mark) 行列や表の位置情報を削除する

クラスから継承されたメソッド java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

フィールドの詳細

MAX_DOT_COUNT

public static final int MAX_DOT_COUNT

マスの点の最大数

関連項目:

定数フィールド値

メソッドの詳細

toString

public java.lang.String toString()

オーバーライド:

toString クラス内 java.lang.Object

newBrailleInfo

public static BrailleInfo newBrailleInfo(BrailleDict dict)

インスタンスを生成する

パラメータ:

dict - 辞書

戻り値:

生成したインスタンス

例外:

java.lang.IllegalArgumentException - dictがnullの場合

clone

public BrailleInfo clone()

複製する

オーバーライド:

clone クラス内 java.lang.Object

戻り値:

複製したインスタンス

equals

public boolean equals(java.lang.Object o)

オーバーライド:

equals クラス内 java.lang.Object

hashCode

public int hashCode()

オーバーライド:

hashCode クラス内 java.lang.Object

getSumiji

public java.lang.String getSumiji()

墨字を取得する

戻り値:

墨字

setSumiji

public void setSumiji(java.lang.String sumiji)

墨字を登録する

パラメータ:

sumiji - 墨字

getExtraCode

public BrailleInfo getExtraCode(BrailleInfo.EXTRA extra)

外字符、大文字符などの符号のBraleInfoを取得する

パラメータ:

extra - 符号

戻り値:

符号のBrailleInfo。符号がない場合はnul

getDotListCount

public int getDotListCount()

マスの数を取得する
・外字符、大文字符などの符号は含まない

戻り値:

マスの数

getDotList

public int[] getDotList(int index)

マスの点のリストを取得する

パラメータ:

index - マスの番号(0から始まる)

戻り値:

点のリスト

例外:

java.lang.IndexOutOfBoundsException - indexが負か、マスの数以上

addDotList

public int addDotList(int[] dots)

マスを追加する
・マスの番号に-1を指定して、addDotListを呼ぶ

パラメータ:

dots - マスの点のリスト

戻り値:

追加されたマスの番号(0から始まる)

addDotList

public int addDotList(int index,
             int[] dots)

番号を指定してマスを追加する
・指定した番号以後にマスがある場合は右に移動する

パラメータ:

index - マスの番号。-1の場合はマスのリストの最後に追加する

dots - マスの点のリスト

戻り値:

追加されたマスの番号(0から始まる)

setDotList

public void setDotList(int index,
              int[] dots)

マスを入れ替える

パラメータ:

index - マスの番号(0から始まる)

dots - マスの点のリスト

例外:

java.lang.IndexOutOfBoundsException - indexが負か、マスの数以上

delDotList

public boolean delDotList(int index)

マスを削除する

パラメータ:

index - マスの番号(0から始まる)

戻り値:

true=成功 false=失敗

例外:

java.lang.IndexOutOfBoundsException - indexが負か、マスの数以上

moveLeft

public int moveLeft(int index)

マスを左に移動する
・indexが1より小さいか、マスの数以上の場合は何もしない

パラメータ:

index - マスの番号(0から始まる)

戻り値:

移動後のマスの番号(0から始まる)

moveRight

public int moveRight(int index)

マスを右に移動する
・indexが負か、(マスの数-1)以上の場合は何もしない

パラメータ:

index - マスの番号(0から始まる)

戻り値:

移動後のマスの番号(0から始まる)

setExtra

public void setExtra(BrailleInfo.EXTRA extra,
            boolean flag)

外字符、大文字符などの符号の有無を設定する

パラメータ:

extra - 符号

flag - true=あり false=なし

haveExtra

public boolean haveExtra(BrailleInfo.EXTRA extra)

外字符、大文字付などの符号の有無を取得する

パラメータ:

extra - 符号

戻り値:

true=あり false=なし

isExtra

public boolean isExtra()

外字符、大文字符などの符号かどうかを取得する

戻り値:

true=符号 false=符号ではない

isExtraOf

public boolean isExtraOf(BrailleInfo.EXTRA extra)

外字符、大文字符などの符号かどうかを取得する

パラメータ:

extra - 確かめる符号

戻り値:

true=符号 false=符号ではない

setTable

public void setTable(BrailleInfo.TABLE mark,
            java.util.EnumMap<BrailleInfo.TABLE_OPTION,java.lang.Object> options)

行列や表のオプション情報を設定する
・オプション情報はTABLE_OPTION

パラメータ:

mark - 位置情報

options - オプション情報(ない場合はnull)

unsetTable

public void unsetTable(BrailleInfo.TABLE mark)

行列や表の位置情報を削除する

パラメータ:

mark - 位置情報

haveTable

public boolean haveTable(BrailleInfo.TABLE mark)

行列や表の位置情報を確認する

パラメータ:

mark - 位置情報

戻り値:

true=位置情報がある false=ない

getTableOption

public <T> T getTableOption(BrailleInfo.TABLE_OPTION key)

行列や表のオプション情報を取得するKbr/>

パラメータ:

key - 情報の種類

戻り値:

情報(ない場合はnullか0)

setLineBreak

public void setLineBreak(boolean flag)

改行文字の設定をする

パラメータ:

flag - true=改行文字にする false = 設定を解除する

isLineBreak

public boolean isLineBreak()

改行文字の設定を取得する

戻り値:

true=改行文字
改行文字ではない

getDesc

public java.lang.String getDesc()

説明を取得する

戻り値:

説明のテキスト

setDesc

public void setDesc(java.lang.String desc)

説明を設定する

パラメータ:

desc - 説明のテキスト

setCheck

public void setCheck(BrailleInfo.CHECK check,
            boolean flag)

パラメータ:

flag -

needCheck

public boolean needCheck(BrailleInfo.CHECK check)

この字の前後に区切り符号の確認が必要かを取得する

isEmpty

public boolean isEmpty()

空点字かどうかを取得する

戻り値:

true=空点字