org.opengion.hayabusa.resource.LabelData

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

public final class LabelData extends Object implements LabelInterface

systemId , lang に対応したラベルデータを作成します。ラベルデータは、項目(CLM)に対して、各種ラベル情報を持っています。従来のラベルは、表示名称として、一種類しか持っていませんでしたが、ラベルデータは、３種類の名称と、１種類の概要を持っています。 label : 名称(長) 従来のラベルと同じで定義された文字そのものです。 shortLabel : 名称(HTML短) 概要説明をバルーン表示する短い名称です。 longLabel : 名称(HTML長) 概要説明をバルーン表示する長い名称です。 description : 概要説明カラムの説明やバルーンに使用します。名称(HTML長)は、従来の表示名称にあたります。これは、一般的なラベルとして使用されます。名称(HTML短)は、テーブル一覧のヘッダーの様に、特殊なケースで、簡略化された名称を使用するときに利用されます。この切り替えは、自動で判断されます。名称(HTML短)に、なにも設定されていない場合は、名称(HTML長)が自動的に使用されますので初期データ移行時には、そのまま、通常時もテーブルヘッダー時も同じ文字列が使用されます。ただし、一覧表示のうち、EXCEL出力などのデータには、名称(長)が使用されます。これは、名称(HTML短)や名称(HTML長)は、Tips表示を行う為のHTML構文を採用している為テキスト等に出力するには不適切だからです。また、EXCEL等のツールでは、ラベル名が長くてもセル幅等で調整できる為、簡略化された名称よりも正式名称で出力します。ラベルデータを作成する場合は、同一ラベルで、作成区分(KBSAKU)違いの場合は、最も大きな作成区分を持つコードを使用します。作成区分(KBSAKU)は、0:システム予約、1:アプリ設定、2:ユーザー設定という具合にカスタマイズの度合いに応じて大きな数字を割り当てることで、キー情報を上書き修正することが可能になります。(削除することは出来ません。)

変更履歴:: 4.0.0.0 (2004/12/31) 新規作成
機能分類: リソース管理
導入されたバージョン:: JDK5.0,

フィールドの概要

フィールド

修飾子とタイプ

フィールド

説明

static final int

CLM

内部データのカラム番号 0

static final int

DESCRIPTION

内部データのカラム番号 3

(package private) static final int

FG_LOAD

リソース読み込みのために一時利用 4.3.5.7 (2009/03/22)

static final int

KBSAKU

内部データのカラム番号 7

static final int

LNAME

内部データのカラム番号 2

static final int

SNAME

内部データのカラム番号 1

static final int

SNO

内部データのカラム番号 8

(package private) static final int

SYSTEM_ID

FGLOAD の読み込み済み設定用のSYSTEM_ID 6.3.1.1 (2015/07/10)

(package private) static final int

UNIQ

FGLOAD の読み込み済み設定用のUNIQ 6.3.1.1 (2015/07/10)
コンストラクタの概要

コンストラクタ

コンストラクタ

説明

LabelData(String inkey)

null LabelData オブジェクトを作成します。

LabelData(String[] data)

配列文字列のデータを元に、LabelDataオブジェクトを構築します。

LabelData(String inkey, String inLbl)

名前とﾗﾍﾞﾙだけ異なるLabelDataオブジェクトを作成します。
メソッドの概要

修飾子とタイプ

メソッド

説明

String

getDescription()

ラベルオブジェクトの概要説明を返します。

String

getDescription(String... vals)

ラベルオブジェクトの概要説明を返します。

String

getKey()

ラベルオブジェクトのキーを返します。

String

getLabel()

ラベルオブジェクトの名称を返します。

String

getLongLabel()

ラベルオブジェクトの名称(長)を返します。

String

getLongLabel(String title)

ラベルインターフェースの名称(長)を返します。

String

getMessage(String... vals)

ラベルインターフェースの引数付きメッセージを返します。

String

getRawLongLabel()

ラベルオブジェクトの名称(長)をそのままの形で返します。

String

getRawShortLabel()

ラベルオブジェクトの名称(短)をspanタグを付けない状態で返します。

String

getRawShortLabel(String defVal)

ラベルオブジェクトの名称(短)をspanタグを付けない状態で返します。

String

getShortLabel()

ラベルオブジェクトの名称(短)を返します。

String

getShortMessage(String... vals)

ラベルオブジェクトの名称(未変換短)を返します。

boolean

isOfficial()

リソースＤＢから作成されたかどうかを返します。

String

toString()

オブジェクトの識別子として、詳細なユーザー情報を返します。

クラスから継承されたメソッド java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

フィールド詳細
- CLM
  
  public static final int CLM
  
  内部データのカラム番号 0
  関連項目:
  
  定数フィールド値
- SNAME
  
  public static final int SNAME
  
  内部データのカラム番号 1
  関連項目:
  
  定数フィールド値
- LNAME
  
  public static final int LNAME
  
  内部データのカラム番号 2
  関連項目:
  
  定数フィールド値
- DESCRIPTION
  
  public static final int DESCRIPTION
  
  内部データのカラム番号 3
  関連項目:
  
  定数フィールド値
- FG_LOAD
  
  static final int FG_LOAD
  
  リソース読み込みのために一時利用 4.3.5.7 (2009/03/22)
  関連項目:
  
  定数フィールド値
- UNIQ
  
  static final int UNIQ
  
  FGLOAD の読み込み済み設定用のUNIQ 6.3.1.1 (2015/07/10)
  関連項目:
  
  定数フィールド値
- SYSTEM_ID
  
  static final int SYSTEM_ID
  
  FGLOAD の読み込み済み設定用のSYSTEM_ID 6.3.1.1 (2015/07/10)
  関連項目:
  
  定数フィールド値
- KBSAKU
  
  public static final int KBSAKU
  
  内部データのカラム番号 7
  関連項目:
  
  定数フィールド値
- SNO
  
  public static final int SNO
  
  内部データのカラム番号 8
  関連項目:
  
  定数フィールド値
コンストラクタの詳細
- LabelData
  
  public LabelData(String inkey)
  
  null LabelData オブジェクトを作成します。このオブジェクトは、ＤＢリソース上に存在しない場合に使用される null 情報を表す、LabelData オブジェクトです。
  
  パラメータ:
  
  inkey - キー情報
  
  変更履歴:
  
  5.6.8.2 (2013/09/20) rawLongLabel対応, 5.7.3.0 (2014/02/07) public に格上げします。, 7.0.1.5 (2018/12/10) 名前とﾗﾍﾞﾙだけ異なるLabelDataオブジェクトを作成します。
- LabelData
  
  public LabelData(String inkey, String inLbl)
  
  名前とﾗﾍﾞﾙだけ異なるLabelDataオブジェクトを作成します。これは、ﾗﾍﾞﾙを簡易的に利用する場合に使用する、LabelData オブジェクトです。
  
  パラメータ:
  
  inkey - キー情報
  
  inLbl - ﾗﾍﾞﾙ
  
  変更履歴:
  
  7.0.1.5 (2018/12/10) 名前とﾗﾍﾞﾙだけ異なるLabelDataオブジェクトを作成します。, 7.1.0.1 (2020/02/07) isFormat、isFormatDescは、長,短,概要などあるため、直前にチェックするので廃止。
- LabelData
  
  LabelData(String[] data)
  
  配列文字列のデータを元に、LabelDataオブジェクトを構築します。このコンストラクタは、他のパッケージから呼び出せないように、パッケージプライベートにしておきます。このコンストラクタは、ＤＢリソースファイルを想定しています。
  
  パラメータ:
  
  data - CLM,SNAME,LNAME,DESCRIPTION
  
  変更履歴:
  
  5.4.0.1 (2011/11/01) SNAME、概要説明、rawShortLabel 関係の処理を修正, 5.6.8.2 (2013/09/20) rawLongLabel対応, 6.2.2.0 (2015/03/27) BRと\nを相互に変換する処理を追加, 6.2.2.3 (2015/04/10) htmlフィルターに、BR→改行処理機能を追加。, 6.3.9.0 (2015/11/06) StringUtil.yenN2br は、null を返しません。, 7.1.0.1 (2020/02/07) isFormat、isFormatDescは、長,短,概要などあるため、直前にチェックするので廃止。, 7.2.9.0 (2020/10/12) rawShortLabelは、DB検索未設定の場合は、nullなので、初期値指定を行う。
メソッドの詳細
- getKey
  
  public String getKey()
  
  ラベルオブジェクトのキーを返します。
  
  定義:
  
  getKey インタフェース内 LabelInterface
  
  戻り値:
  
  ラベルオブジェクトのキー
- getLabel
  
  public String getLabel()
  
  ラベルオブジェクトの名称を返します。これは、ＤＢ上の LNAME(名称(長))に該当します。
  
  定義:
  
  getLabel インタフェース内 LabelInterface
  
  戻り値:
  
  ラベルオブジェクトの名称(長)
- getMessage
  
  public String getMessage(String... vals)
  
  ラベルインターフェースの引数付きメッセージを返します。メッセージの引数部分に、文字列配列を適用して、MessageFormat で変換した結果を返します。(MessageData でのみ有効です。)
  
  定義:
  
  getMessage インタフェース内 LabelInterface
  
  パラメータ:
  
  vals - メッセージ引数の文字列配列(可変長引数)
  
  戻り値:
  
  ラベルインターフェースの引数付きメッセージ
  
  変更履歴:
  
  4.0.0.0 (2007/10/17) メッセージリソース統合に伴い、MessageDataより移行, 4.3.8.0 (2009/08/01) 引数にHTMLサニタイジング処理, 5.0.0.2 (2009/09/15) サニタイジング処理をやめる, 6.4.3.4 (2016/03/11) ラベル {n} が存在しない場合は、引数を連結せず、元のラベルを返す。, 6.4.5.0 (2016/04/08) リソースから作成された場合は、引数を連結せず、そうでない場合は連結します。, 6.4.7.0 (2016/06/03) IllegalArgumentException が発生した場合に、見えるようにする。, 7.0.7.0 (2019/12/13) #getMessage(String...) , #getDescription(String...) , #getShortMessage(String...) を統合します。
- getShortLabel
  
  public String getShortLabel()
  
  ラベルオブジェクトの名称(短)を返します。概要説明がない場合でかつＤＢ上のSNAMEが未設定の場合は、 LNAME が返されます。SNAMEが設定されている場合は、ツールチップにLNAME が表示されます。概要説明が存在する場合は、ツールチップに概要説明が表示されます。
  
  定義:
  
  getShortLabel インタフェース内 LabelInterface
  
  戻り値:
  
  ラベルオブジェクトの名称(短)
- getShortMessage
  
  public String getShortMessage(String... vals)
  
  ラベルオブジェクトの名称(未変換短)を返します。このメソッドでは{0},{1}...をパラメータで置換します。
  
  定義:
  
  getShortMessage インタフェース内 LabelInterface
  
  パラメータ:
  
  vals - メッセージ引数の文字列配列(可変長引数)
  
  戻り値:
  
  ラベルインターフェースの名前(短)
  
  変更履歴:
  
  7.0.7.0 (2019/12/13) #getMessage(String...) , #getDescription(String...) , #getShortMessage(String...) を統合します。, 7.2.9.0 (2020/10/12) rawShortLabelは、DB検索未設定の場合は、nullなので、初期値指定を行う。
- getLongLabel
  
  public String getLongLabel()
  
  ラベルオブジェクトの名称(長)を返します。概要説明が存在する場合は、ツールチップに概要説明が表示されます。
  定義:
  
  getLongLabel インタフェース内 LabelInterface
  
  戻り値:
  
  ラベルオブジェクトの名称(長)
  
  関連項目:
  
  getLongLabel(String)
- getLongLabel
  
  public String getLongLabel(String title)
  
  ラベルインターフェースの名称(長)を返します。ツールチップに表示するタイトル属性(概要説明)を置き換えます。 null の場合は、既存のgetLongLabel()を返します。
  定義:
  
  getLongLabel インタフェース内 LabelInterface
  
  パラメータ:
  
  title - ツールチップに表示するタイトル属性
  
  戻り値:
  
  ラベルインターフェースの名称(長)
  
  関連項目:
  
  getLongLabel()
  
  変更履歴:
  
  6.2.2.0 (2015/03/27) BRと\nを相互に変換する処理を追加, 6.2.2.3 (2015/04/10) htmlフィルターに、BR→改行処理機能を追加。
- getDescription
  
  public String getDescription()
  
  ラベルオブジェクトの概要説明を返します。概要説明が存在する場合は、ラベルのツールチップに概要説明が表示されます。
  
  定義:
  
  getDescription インタフェース内 LabelInterface
  
  戻り値:
  
  ラベルオブジェクトの概要説明
- getDescription
  
  public String getDescription(String... vals)
  
  ラベルオブジェクトの概要説明を返します。このメソッドでは{0},{1}...をパラメータで置換します。
  
  定義:
  
  getDescription インタフェース内 LabelInterface
  
  パラメータ:
  
  vals - メッセージ引数の文字列配列(可変長引数)
  
  戻り値:
  
  ラベルオブジェクトの概要説明
  
  変更履歴:
  
  4.3.7.6 (2009/07/15) 新規作成, 4.3.8.0 (2009/08/01) 引数にHTMLサニタイジング処理, 5.0.0.2 (2009/09/15) サニタイジング処理をやめる, 5.4.0.1 (2011/11/01) {}が存在しない場合は単に概要を出力, 6.4.7.0 (2016/06/03) IllegalArgumentException が発生した場合に、見えるようにする。, 7.0.7.0 (2019/12/13) #getMessage(String...) , #getDescription(String...) , #getShortMessage(String...) を統合します。
- isOfficial
  
  public boolean isOfficial()
  
  リソースＤＢから作成されたかどうかを返します。正式な場合は、true / リソースになく、独自に作成された場合は、false になります。
  
  定義:
  
  isOfficial インタフェース内 LabelInterface
  
  戻り値:
  
  リソースDBから作成されたかどうか
- getRawLongLabel
  
  public String getRawLongLabel()
  
  ラベルオブジェクトの名称(長)をそのままの形で返します。（discription等を付けない)
  
  戻り値:
  
  ラベルオブジェクトの名称(長)そのままの状態
  
  変更履歴:
  
  5.6.8.2 (2009/08/01) 追加
  
  このﾒｿｯﾄﾞは、nullを返しません
- getRawShortLabel
  
  public String getRawShortLabel()
  
  ラベルオブジェクトの名称(短)をspanタグを付けない状態で返します。 SNAMEが未設定の場合は、LNAME が返されます。
  
  戻り値:
  
  ラベルオブジェクトの名称(短)にspanタグを付けない状態
  
  変更履歴:
  
  4.3.8.0 (2009/08/01) 追加, 7.2.9.0 (2020/10/12) rawShortLabelは、DB検索未設定の場合は、nullなので、初期値指定を行う。
  
  このﾒｿｯﾄﾞは、nullを返しません
- getRawShortLabel
  
  public String getRawShortLabel(String defVal)
  
  ラベルオブジェクトの名称(短)をspanタグを付けない状態で返します。 SNAMEが未設定の場合は、LNAME が返されます。
  
  パラメータ:
  
  defVal - 名称(短)がnullの場合の初期値
  
  戻り値:
  
  ラベルオブジェクトの名称(短)にspanタグを付けない状態
  
  変更履歴:
  
  7.2.9.0 (2020/10/12) rawShortLabelは、DB検索未設定の場合は、nullなので、初期値指定を行う。
- toString
  
  public String toString()
  
  オブジェクトの識別子として、詳細なユーザー情報を返します。
  
  オーバーライド:
  
  toString クラス内 Object
  
  戻り値:
  
  詳細なユーザー情報
  
  このﾒｿｯﾄﾞは、nullを返しません

クラス LabelData

フィールドの概要

コンストラクタの概要

メソッドの概要

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

フィールド詳細

CLM

SNAME

LNAME

DESCRIPTION

FG_LOAD

UNIQ

SYSTEM_ID

KBSAKU

SNO

コンストラクタの詳細

LabelData

LabelData

LabelData

メソッドの詳細

getKey

getLabel

getMessage

getShortLabel

getShortMessage

getLongLabel

getLongLabel

getDescription

getDescription

isOfficial

getRawLongLabel

getRawShortLabel

getRawShortLabel

toString