EdbCaption (EDB/Java API Specification)

java.lang.Object
- jp.ac.tokushima_u.edb.EdbCaption

```
public class EdbCaption
extends Object
```
EID の指し示す情報から生成される見出しを表します．
見出しは，次の２つに部分を使い表されます．
- 主見出し(短い見出し)
- 副見出し(長い見出し)
それぞれの部分が表す内容は，個人情報なら次のようになります．
- 主見出し ... 姓名
- 副見出し ... 所属
ある情報について，どの項目を主見出し，副見出しにするかはテーブルの定義により決定され，テーブル定義のカラム要素の中の見出し要素がそれに当たります．
```
 <edb:caption>value</edb:caption>

 value
 0 …見出しに利用しない
 1 …主見出しに利用
 2 …副見出しに利用
 
```
Version:

$Id: EdbCaption.java,v 1.15 2019/05/08 06:19:10 alex Exp $

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`CAP_delimiter_comma` 区切り文字にカンマ「,」を使う．
`static int`	`CAP_delimiter_newline` 区切り文字に改行「\n」を使う．
`static int`	`CAP_lax_language` 厳密でない言語利用を行う．
`static int`	`CAP_long` 長い見出しを生成する．
`static int`	`CAP_nobracket` 括弧で見出しを表示するのを抑制する．
`static int`	`CAP_nomapto` タプル全体としてマップしている情報がある場合にマップ先を(->マップ先の見出し)のように表示するのを抑制する．
`static int`	`CAP_norecurse` 組織名などの階層化されている情報をフルに作成せず，組織の名前のみで見出しを作成する．
`static int`	`CAP_noreverse` 英語表記の組織名のように，組織名を逆順に並べない．
`(package private) boolean`	`complete`
`(package private) String`	`main_en`
`(package private) String`	`main_ja`
`(package private) String`	`main_pr`
`(package private) static int`	`MAX_CAP_RECURSE`
`(package private) int`	`mode`
`(package private) String`	`sub_en`
`(package private) String`	`sub_ja`

Constructor Summary

Constructors
Constructor and Description
`EdbCaption()` 見出しを作成するときのモードの指定なしで，見出しの新しいインスタンスを初期化します．
`EdbCaption(int m)` 見出しを作成するときのモードを指定し，見出しの新しいインスタンスを初期化します．

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`childMode()` 入れ子になっている情報の見出しを作成するときのモードを取得します．
`void`	`concatenate(EdbCaption c)` 見出しを連結します．
`void`	`concatenate(String s)` 見出しを英文，和文の主見出しと連結します．
`void`	`concatenate(String delim, EdbCaption c)` 見出しを連結します．
`void`	`concatenate(String en, String ja)` 英文，和文の主見出しを連結します．連結される内容との区切り文字はスラッシュ("/")になります．
`void`	`concatenate(String en, String ja, String pr)` 英文，和文，読みの主見出しを連結します．連結される内容との区切り文字は，英文，和文ではスラッシュ("/")，読みではスペース(" ")になります．
`void`	`concatenateSub(EdbCaption c)` 副見出しを連結します．連結内容との区切り文字はスラッシュ("/")になります．
`void`	`concatenateSub(String delim, EdbCaption c)` 副見出しを連結します．
`EdbCaption`	`exchangeLanguage()` 言語を入れ換える．
`String`	`getMain()` 主見出しを取得します．
`String`	`getMainEnglish()` 英文の主見出しを取得します．
`String`	`getMainJapanese()` 和文の主見出しを取得します．
`String`	`getMainPronounce()` 読みの主見出しを取得します．
`int`	`getMode()` 見出しを作成するときのモードを取得します．
`String`	`getSub()` 副見出しを取得します．
`String`	`getSubEnglish()` 英文の副見出しを取得します．
`String`	`getSubJapanese()` 和文の副見出しを取得します．
`static boolean`	`isCapDelimiterComma(int mode)` 指定の見出しを作成するときのモードに `CAP_delimiter_comma` の指定が含まれるかどうかを判定します．
`static boolean`	`isCapDelimiterNewline(int mode)` 指定の見出しを作成するときのモードに `CAP_delimiter_newline` の指定が含まれるかどうかを判定します．
`static boolean`	`isCapLong(int mode)` 指定の見出しを作成するときのモードに `CAP_long` の指定が含まれるかどうかを判定します．
`static boolean`	`isCapNoBracket(int mode)` 指定の見出しを作成するときのモードに `CAP_nobracket` の指定が含まれるかどうかを判定します．
`static boolean`	`isCapNoMapto(int mode)` 指定の見出しを作成するときのモードに `CAP_nomapto` の指定が含まれるかどうかを判定します．
`static boolean`	`isCapNoRecurse(int mode)` 指定の見出しを作成するときのモードに `CAP_norecurse` の指定が含まれるかどうかを判定します．
`static boolean`	`isCapNoReverse(int mode)` 指定の見出しを作成するときのモードに `CAP_noreverse` の指定が含まれるかどうかを判定します．
`static boolean`	`isCapRecurse(int mode)` 指定の見出しを作成するときのモードに `CAP_norecurse` の指定が含まれないかどうかを判定します．
`static boolean`	`isCapReverse(int mode)` 指定の見出しを作成するときのモードに `CAP_noreverse` の指定が含まれないかどうかを判定します．
`boolean`	`isComplete()` 見出しの作成が完了しているかどうかを取得します．
`boolean`	`isEmpty()` 見出しが空かどうかを判定します．
`boolean`	`isLoading()` 見出しの作成が未完了かどうかを取得します．
`boolean`	`mainIsEmpty()` 主見出しが空かどうかを判定します．
`void`	`mainToLowerCase()` 英文，和文の主見出しのアルファベットの大文字を小文字に変換します．
`void`	`setComplete(boolean c)` 見出しの作成が完成しているかどうかを設定します．
`boolean`	`subIsEmpty()` 副見出しが空かどうかを判定します．
`void`	`subToLowerCase()` 副見出しのアルファベットの大文字を小文字に変換します．
`String`	`toString()` 見出しの文字列に変換します．

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - CAP_long
```
public static final int CAP_long
```
    長い見出しを生成する．
    
    See Also:
    
    Constant Field Values
  - CAP_norecurse
```
public static final int CAP_norecurse
```
    組織名などの階層化されている情報をフルに作成せず，組織の名前のみで見出しを作成する．
    
    See Also:
    
    Constant Field Values
  - CAP_nomapto
```
public static final int CAP_nomapto
```
    タプル全体としてマップしている情報がある場合にマップ先を(->マップ先の見出し)のように表示するのを抑制する．
    
    See Also:
    
    Constant Field Values
  - CAP_nobracket
```
public static final int CAP_nobracket
```
    括弧で見出しを表示するのを抑制する．
    
    See Also:
    
    Constant Field Values
  - CAP_noreverse
```
public static final int CAP_noreverse
```
    英語表記の組織名のように，組織名を逆順に並べない．
    
    See Also:
    
    Constant Field Values
  - CAP_delimiter_comma
```
public static final int CAP_delimiter_comma
```
    区切り文字にカンマ「,」を使う．
    
    See Also:
    
    Constant Field Values
  - CAP_delimiter_newline
```
public static final int CAP_delimiter_newline
```
    区切り文字に改行「\n」を使う．
    
    See Also:
    
    Constant Field Values
  - CAP_lax_language
```
public static final int CAP_lax_language
```
    厳密でない言語利用を行う．
    
    See Also:
    
    Constant Field Values
  - MAX_CAP_RECURSE
```
static final int MAX_CAP_RECURSE
```
    See Also:
    
    Constant Field Values
  - mode
```
int mode
```
  - main_en
```
String main_en
```
  - main_ja
```
String main_ja
```
  - main_pr
```
String main_pr
```
  - sub_en
```
String sub_en
```
  - sub_ja
```
String sub_ja
```
  - complete
```
boolean complete
```
- Constructor Detail
  - EdbCaption
```
public EdbCaption()
```
    見出しを作成するときのモードの指定なしで，見出しの新しいインスタンスを初期化します．
  - EdbCaption
```
public EdbCaption(int m)
```
    見出しを作成するときのモードを指定し，見出しの新しいインスタンスを初期化します．
    
    Parameters:
    
    m - 見出しを作成するときのモード，0 又は見出しを作成するときのモードの定数の値の組み合わせ
    
    See Also:
    
    CAP_long, CAP_norecurse, CAP_nomapto, CAP_nobracket, CAP_noreverse, CAP_delimiter_comma, CAP_delimiter_newline
- Method Detail
  - isCapLong
```
public static boolean isCapLong(int mode)
```
    指定の見出しを作成するときのモードに CAP_long の指定が含まれるかどうかを判定します．
    
    Parameters:
    
    mode - 見出しを作成するときのモード
    
    Returns:
    
    含まれる場合は true，その他 false を返します．
  - isCapRecurse
```
public static boolean isCapRecurse(int mode)
```
    指定の見出しを作成するときのモードに CAP_norecurse の指定が含まれないかどうかを判定します．
    
    Parameters:
    
    mode - 見出しを作成するときのモード
    
    Returns:
    
    含まれない場合は true，その他 false を返します．
  - isCapNoRecurse
```
public static boolean isCapNoRecurse(int mode)
```
    指定の見出しを作成するときのモードに CAP_norecurse の指定が含まれるかどうかを判定します．
    
    Parameters:
    
    mode - 見出しを作成するときのモード
    
    Returns:
    
    含まれる場合は true，その他 false を返します．
  - isCapNoMapto
```
public static boolean isCapNoMapto(int mode)
```
    指定の見出しを作成するときのモードに CAP_nomapto の指定が含まれるかどうかを判定します．
    
    Parameters:
    
    mode - 見出しを作成するときのモード
    
    Returns:
    
    含まれる場合は true，その他 false を返します．
  - isCapNoBracket
```
public static boolean isCapNoBracket(int mode)
```
    指定の見出しを作成するときのモードに CAP_nobracket の指定が含まれるかどうかを判定します．
    
    Parameters:
    
    mode - 見出しを作成するときのモード
    
    Returns:
    
    含まれる場合は true，その他 false を返します．
  - isCapReverse
```
public static boolean isCapReverse(int mode)
```
    指定の見出しを作成するときのモードに CAP_noreverse の指定が含まれないかどうかを判定します．
    
    Parameters:
    
    mode - 見出しを作成するときのモード
    
    Returns:
    
    含まれない場合は true，その他 false を返します．
  - isCapNoReverse
```
public static boolean isCapNoReverse(int mode)
```
    指定の見出しを作成するときのモードに CAP_noreverse の指定が含まれるかどうかを判定します．
    
    Parameters:
    
    mode - 見出しを作成するときのモード
    
    Returns:
    
    含まれる場合は true，その他 false を返します．
  - isCapDelimiterComma
```
public static boolean isCapDelimiterComma(int mode)
```
    指定の見出しを作成するときのモードに CAP_delimiter_comma の指定が含まれるかどうかを判定します．
    
    Parameters:
    
    mode - 見出しを作成するときのモード
    
    Returns:
    
    含まれる場合は true，その他 false を返します．
  - isCapDelimiterNewline
```
public static boolean isCapDelimiterNewline(int mode)
```
    指定の見出しを作成するときのモードに CAP_delimiter_newline の指定が含まれるかどうかを判定します．
    
    Parameters:
    
    mode - 見出しを作成するときのモード
    
    Returns:
    
    含まれる場合は true，その他 false を返します．
  - mainIsEmpty
```
public boolean mainIsEmpty()
```
    主見出しが空かどうかを判定します．
    
    Returns:
    
    空の場合は true，その他 false を返します．
  - subIsEmpty
```
public boolean subIsEmpty()
```
    副見出しが空かどうかを判定します．
    
    Returns:
    
    空の場合は true，その他 false を返します．
  - isEmpty
```
public boolean isEmpty()
```
    見出しが空かどうかを判定します．
    
    Returns:
    
    空の場合は true，その他 false を返します．
  - getMainEnglish
```
public String getMainEnglish()
```
    英文の主見出しを取得します．
    
    Returns:
    
    英文の主見出しを返します．
  - getMainJapanese
```
public String getMainJapanese()
```
    和文の主見出しを取得します．
    
    Returns:
    
    和文の主見出しがあればそれを返します．なければ，英文の主見出しを返します．
  - getMainPronounce
```
public String getMainPronounce()
```
    読みの主見出しを取得します．
    
    Returns:
    
    読みの主見出しを返します．
  - getMain
```
public String getMain()
```
    主見出しを取得します．
    このメソッドは，getMainJapanese メソッドをラップしたものです．
    
    Returns:
    
    見出しを返します．
  - getSubEnglish
```
public String getSubEnglish()
```
    英文の副見出しを取得します．
    
    Returns:
    
    英文の副見出しを返します．
  - getSubJapanese
```
public String getSubJapanese()
```
    和文の副見出しを取得します．
    
    Returns:
    
    和文の副見出しがあればそれを返します．なければ，英文の副見出しを返します．
  - getSub
```
public String getSub()
```
    副見出しを取得します．
    このメソッドは，getSubJapanese メソッドをラップしたものです．
    
    Returns:
    
    副見出しを返します．
  - isLoading
```
public boolean isLoading()
```
    見出しの作成が未完了かどうかを取得します．
    見出しの作成時に参照している情報がまだ読込まれておらず，見出しの作成が完全に完了していない場合があります．このメソッドは，見出しの作成が完了しているかどうかを判断するのに使用されます．
    
    Returns:
    
    未完了の場合は true，その他 false を返します．
    
    See Also:
    
    isComplete()
  - isComplete
```
public boolean isComplete()
```
    見出しの作成が完了しているかどうかを取得します．
    見出しの作成時に参照している情報がまだ読込まれておらず，見出しの作成が完全に完了していない場合があります．このメソッドは，見出しの作成が完了しているかどうかを判断するのに使用されます．
    
    Returns:
    
    完了している場合は true，その他 false を返します．
    
    See Also:
    
    isLoading()
  - setComplete
```
public void setComplete(boolean c)
```
    見出しの作成が完成しているかどうかを設定します．
    
    Parameters:
    
    c - 完成しているかどうか
  - getMode
```
public int getMode()
```
    見出しを作成するときのモードを取得します．
    
    Returns:
    
    見出しを作成するときのモードを返します．
    
    See Also:
    
    CAP_long, CAP_norecurse, CAP_nomapto, CAP_nobracket, CAP_noreverse, CAP_delimiter_comma, CAP_delimiter_newline
  - childMode
```
public int childMode()
```
    入れ子になっている情報の見出しを作成するときのモードを取得します．
    見出しは再帰的に作成されます．つまり，個人情報の所属に関して，[評価情報分析センター]という登録が，他の情報(組織情報)への参照で登録というような場合，個人情報の見出し作成で，所属の項目に至ったとき EID から組織情報の見出しを作成します．このメソッドは，そのように再帰的に見出しを作成する場合に，入れ子になった情報の見出しを作成するときのモードを返します．
    
    Returns:
    
    入れ子になっている情報の見出しを作成するときのモードを返します．
    
    See Also:
    
    CAP_long, CAP_norecurse, CAP_nomapto, CAP_nobracket, CAP_noreverse, CAP_delimiter_comma, CAP_delimiter_newline
  - toString
```
public String toString()
```
    見出しの文字列に変換します．
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    見出し文字列を返します．
  - concatenate
```
public void concatenate(String delim,
                        EdbCaption c)
```
    見出しを連結します．
    
    Parameters:
    
    delim - 連結される内容との区切り文字
    
    c - EDB 見出し
  - concatenate
```
public void concatenate(EdbCaption c)
```
    見出しを連結します．
    連結される内容との区切り文字は，見出しモードの指定によって異なり次のようになります．
    - 改行 ... CAP_delimiter_newline が指定されている場合
    - カンマ(",") ... CAP_delimiter_comma が指定されている場合
    - スラッシュ("/") ... その他
    Parameters:
    
    c - EDB 見出し
    
    See Also:
    
    CAP_delimiter_comma, CAP_delimiter_newline
  - concatenate
```
public void concatenate(String en,
                        String ja)
```
    英文，和文の主見出しを連結します．連結される内容との区切り文字はスラッシュ("/")になります．
    
    Parameters:
    
    en - 英文の主見出し
    
    ja - 和文の主見出し
  - concatenate
```
public void concatenate(String en,
                        String ja,
                        String pr)
```
    英文，和文，読みの主見出しを連結します．連結される内容との区切り文字は，英文，和文ではスラッシュ("/")，読みではスペース(" ")になります．
    
    Parameters:
    
    en - 英文の主見出し
    
    ja - 和文の主見出し
    
    pr - 読みの主見出し
  - concatenate
```
public void concatenate(String s)
```
    見出しを英文，和文の主見出しと連結します．
    このメソッドは，concatenate メソッドを次のように呼び出すのと等価です．
```
 concatenate(s, s);
 
```
    Parameters:
    
    s - 見出し
  - concatenateSub
```
public void concatenateSub(String delim,
                           EdbCaption c)
```
    副見出しを連結します．
    
    Parameters:
    
    delim - 連結内容との区切り文字
    
    c - EDB 見出し
  - concatenateSub
```
public void concatenateSub(EdbCaption c)
```
    副見出しを連結します．連結内容との区切り文字はスラッシュ("/")になります．
    
    Parameters:
    
    c - EDB 見出し
  - mainToLowerCase
```
public void mainToLowerCase()
```
    英文，和文の主見出しのアルファベットの大文字を小文字に変換します．
  - subToLowerCase
```
public void subToLowerCase()
```
    副見出しのアルファベットの大文字を小文字に変換します．
  - exchangeLanguage
```
public EdbCaption exchangeLanguage()
```
    言語を入れ換える．
    
    Returns:
    
    言語を入れ換えたキャプション．

Class EdbCaption

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

CAP_long

CAP_norecurse

CAP_nomapto

CAP_nobracket

CAP_noreverse

CAP_delimiter_comma

CAP_delimiter_newline

CAP_lax_language

MAX_CAP_RECURSE

mode

main_en

main_ja

main_pr

sub_en

sub_ja

complete

Constructor Detail

EdbCaption

EdbCaption

Method Detail

isCapLong

isCapRecurse

isCapNoRecurse

isCapNoMapto

isCapNoBracket

isCapReverse

isCapNoReverse

isCapDelimiterComma

isCapDelimiterNewline

mainIsEmpty

subIsEmpty

isEmpty

getMainEnglish

getMainJapanese

getMainPronounce

getMain

getSubEnglish

getSubJapanese

getSub

isLoading

isComplete

setComplete

getMode

childMode

toString

concatenate

concatenate

concatenate

concatenate

concatenate

concatenateSub

concatenateSub

mainToLowerCase

subToLowerCase

exchangeLanguage