EdbDocSpi (EDB/Java API Specification)

java.lang.Object
- jp.ac.tokushima_u.edb.EdbDocSpi<C>

Direct Known Subclasses:

CSV, DOCX, EdbDocUSS, HTML, PLAIN, POISS, TeX, XML
```
public abstract class EdbDocSpi<C extends EdbDocSpi.ContentPrinterContext>
extends Object
```
特定のデータ形式の情報を出力するドキュメント生成エンジンのインターフェースを定義します．

Version:

$Id: EdbDocSpi.java,v 1.41 2022/10/19 05:57:58 alex Exp $

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class EdbDocSpi.ContentPrinterContext

protected static class EdbDocSpi.MATH

Nested Classes
Modifier and Type	Class and Description
`static class`	`EdbDocSpi.ContentPrinterContext`
`protected static class`	`EdbDocSpi.MATH`

Field Summary

Fields
Modifier and Type	Field and Description
`protected Stack<C>`	`context_stack`
`protected C`	`current_context`
`protected EDB`	`edb`
`protected EdbText`	`edbtext`
`protected int`	`lastcp`
`protected int`	`numberOfTableColumns`
`protected int`	`tableColumnIndex`
`protected boolean`	`tableHeader`

Constructor Summary

Constructors
Constructor and Description

EdbDocSpi()

Constructors
Constructor and Description
`EdbDocSpi()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`protected int`	`append(byte[] b)`
`protected int`	`append(CharSequence s)`
`protected int`	`append(int cp)`
`protected CharSequence`	`collectText(EdbDoc.Container con)`
`protected C`	`createContext()` プリンターのコンテキストを作成する．
`protected boolean`	`dmlIsInLimited(EdbDoc.Container con)`
`protected C`	`duplicateContext(C ctxt)` プリンターコンテキストの複製を作成する．
`protected void`	`engineBoldBegin()` 太字の区間を開始します．
`protected void`	`engineBoldEnd()` 太字の区間を終了します．
`protected void`	`engineColorBegin(int fgc)` 色付き文字の区間を開始します．
`protected void`	`engineColorEnd()` 色付き文字の区間を終了します．
`protected EdbDoc.Content`	`engineCreateAND()` AND 文字列のコンテンツを返します．
`protected EdbDoc.Content`	`engineCreateDATE(EdbDate d, EdbDate.FMT fmt)` エンジンが扱う形式で指定された日付のコンテンツを返します．
`protected EdbDoc.Content`	`engineCreateDATE2(EdbDate2 period, EdbDate.FMT fmt)` エンジンが扱う形式で指定された期間のコンテンツを返します．
`protected EdbDoc.Content`	`engineCreateEMAIL(CharSequence s)` エンジンが扱う形式で指定されたメールアドレスのコンテキストを返します．
`protected EdbDoc.Content`	`engineCreateGMSBegin()` エンジンが扱う形式で GMS ( 名・ミドルネーム・姓 ) の区間開始のコンテンツを作成します．
`protected EdbDoc.Content`	`engineCreateGMSDelimiter(boolean v)` エンジンが扱う形式で GMS ( 名・ミドルネーム・姓 ) の区切りのコンテンツを作成します．
`protected EdbDoc.Content`	`engineCreateGMSEnd()` エンジンが扱う形式で GMS ( 名・ミドルネーム・姓 ) の区間終了のコンテンツを作成します．
`protected EdbDoc.Content`	`engineCreateMONETARY(double money, boolean latin)` エンジンが扱う形式で指定された金額のコンテンツを返します．
`protected EdbDoc.Content`	`engineCreatePageNumber(String[] page, boolean latin)` エンジンが扱う形式で指定されたページ番号のコンテンツを返します．
`protected EdbDoc.Content`	`engineCreateSMGBegin()` エンジンが扱う形式で SMG ( 姓・ミドルネーム・名 ) の区間開始のコンテンツを作成します．
`protected EdbDoc.Content`	`engineCreateSMGDelimiter(boolean v)` エンジンが扱う形式で SMG ( 姓・ミドルネーム・名 ) の区切りのコンテンツを作成します．
`protected EdbDoc.Content`	`engineCreateSMGEnd()` エンジンが扱う形式で SMG ( 姓・ミドルネーム・名 ) の区間終了のコンテンツを作成します．
`protected EdbDoc.Content`	`engineCreateURL(CharSequence s)` エンジンが扱う形式で指定された URL のコンテントを返します．
`abstract String`	`engineGetDefaultFileExtension()` デフォルトのファイル拡張子を取得します．
`abstract String`	`engineGetDML()` DML を取得します．
`Set<String>`	`engineGetDMLSet()` DMLの階層化セットを取得します．
`protected void`	`engineImportSpecialAttributes(List<EdbDoc.Attribute> list)`
`(package private) void`	`engineInitialize(EDB ec, EdbDoc doc)`
`protected void`	`engineItalicBegin()` イタリック体文字の区間を開始します．
`protected void`	`engineItalicEnd()` イタリック体文字の区間を終了します．
`protected void`	`engineLineThroughBegin()` LineThough文字の区間を開始します．
`protected void`	`engineLineThroughEnd()` LineThough文字の区間を終了します．
`protected abstract void`	`engineListingBegin(boolean o)` リスティングの区間を開始します．
`protected abstract void`	`engineListingEnd(boolean o)` リスティングの区間を終了します．
`protected abstract void`	`engineListingItemBegin(CharSequence s)` リスティング項目の区間を開始します．
`protected abstract void`	`engineListingItemEnd(CharSequence s)` リスティング項目の区間を終了します．
`protected void`	`engineListingTitle(CharSequence name)` リスティングのタイトルをセットします．
`protected void`	`engineMathEnter()` 数式モードに入ります．
`protected void`	`engineMathLeave()` 数式から出ます．
`protected void`	`engineNewPage()` 改ページ．
`protected void`	`engineParagraphBegin()`
`protected void`	`engineParagraphEnd()`
`protected void`	`enginePostProcessings()`
`protected void`	`enginePreProcessings()` 前処理 (set attributes) enginePreProcessings() engine`XXX`Begin() (print contents) engine`XXX`End() enginePostProcessings()
`protected void`	`enginePrint(EdbDoc.Content content)` Contentを出力する．
`protected void`	`enginePrintContent(EdbDoc.Content content)` Contentを出力する．
`protected abstract void`	`enginePutc(int c)` エンジンが扱う形式で指定された文字をプットします．
`protected abstract void`	`enginePutComment(CharSequence s)` エンジンが扱う形式で指定されたコメントをプットします．
`protected abstract void`	`enginePutDocumentHeader(CharSequence s)` エンジンが扱う形式でドキュメントヘッダのコンテンツを作成します．
`protected abstract void`	`enginePutDocumentTrailer()` エンジンが扱う形式でドキュメントトレイラのコンテンツを作成します．
`protected void`	`enginePuts(CharSequence s)` エンジンが扱う形式で指定された文字列をプットします．
`protected void`	`engineTableBegin()`
`protected void`	`engineTableBegin(int cols)` Begin Table.
`protected void`	`engineTableBodyBegin()` Begin Table Body.
`protected void`	`engineTableBodyEnd()` End Table Body.
`protected void`	`engineTableCellBegin()` Begin Table Cell.
`protected void`	`engineTableCellEnd()` End Table Cell.
`protected void`	`engineTableEnd()` End Table.
`protected void`	`engineTableHeaderBegin()` Begin Table Header.
`protected void`	`engineTableHeaderEnd()` End Table Header.
`protected void`	`engineTableRowBegin()` Begin Table Row.
`protected void`	`engineTableRowEnd()` End Table Row.
`protected void`	`engineTableTitle(CharSequence title)` set Table Title
`protected abstract void`	`engineTextParse(int cp, CharSequence s)` テキスト文字列のプット中にエスケープシーケンスが見つかったときに呼び出されます．
`protected abstract void`	`engineTextPutc(int cp)` エンジンが扱う形式で指定されたテキスト文字をプットします．
`protected void`	`engineTextPuts(CharSequence s)` エンジンが扱う形式で指定されたテキスト文字をプットします．
`protected void`	`engineTextPuts3(CharSequence l, CharSequence s, CharSequence t)` エンジンが扱う形式で指定されたテキスト文字をプットします．
`protected void`	`engineUnderlineBegin()` 下線付き文字の区間を開始します．
`protected void`	`engineUnderlineEnd()` 下線付き文字の区間を終了します．
`protected EdbDocSpi.MATH`	`getMathMode()`
`protected boolean`	`isMath()`
`protected boolean`	`isMathExplicit()`
`protected boolean`	`isMathImplicit()`
`protected void`	`mathEnter(EdbDocSpi.MATH m)`
`protected void`	`mathLeave()`
`protected void`	`printContainerContents(EdbDoc.Container con)`
`protected void`	`setMathMode(EdbDocSpi.MATH m)`

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

- Field Detail
  - edb
```
protected EDB edb
```
  - edbtext
```
protected EdbText edbtext
```
  - lastcp
```
protected int lastcp
```
  - numberOfTableColumns
```
protected int numberOfTableColumns
```
  - tableColumnIndex
```
protected int tableColumnIndex
```
  - tableHeader
```
protected boolean tableHeader
```
  - current_context
```
protected C extends EdbDocSpi.ContentPrinterContext current_context
```
  - context_stack
```
protected Stack<C extends EdbDocSpi.ContentPrinterContext> context_stack
```
- Constructor Detail
  - EdbDocSpi
```
public EdbDocSpi()
```
- Method Detail
  - engineInitialize
```
void engineInitialize(EDB ec,
                      EdbDoc doc)
```
  - append
```
protected final int append(byte[] b)
```
  - append
```
protected final int append(int cp)
```
  - append
```
protected final int append(CharSequence s)
```
  - isMath
```
protected final boolean isMath()
```
  - isMathImplicit
```
protected final boolean isMathImplicit()
```
  - isMathExplicit
```
protected final boolean isMathExplicit()
```
  - getMathMode
```
protected final EdbDocSpi.MATH getMathMode()
```
  - setMathMode
```
protected final void setMathMode(EdbDocSpi.MATH m)
```
  - mathEnter
```
protected final void mathEnter(EdbDocSpi.MATH m)
```
  - mathLeave
```
protected final void mathLeave()
```
  - engineGetDML
```
public abstract String engineGetDML()
```
    DML を取得します．
    
    Returns:
    
    DML を返します．
    
    See Also:
    
    EdbDoc.getDML()
  - engineGetDMLSet
```
public Set<String> engineGetDMLSet()
```
    DMLの階層化セットを取得します．
    
    Returns:
    
    DMLの階層化セット．
    
    See Also:
    
    engineGetDML()
  - engineGetDefaultFileExtension
```
public abstract String engineGetDefaultFileExtension()
```
    デフォルトのファイル拡張子を取得します．
    
    Returns:
    
    デフォルトのファイル拡張子を返します．
  - engineMathEnter
```
protected void engineMathEnter()
```
    数式モードに入ります．
  - engineMathLeave
```
protected void engineMathLeave()
```
    数式から出ます．
  - enginePutc
```
protected abstract void enginePutc(int c)
```
    エンジンが扱う形式で指定された文字をプットします．
    
    Parameters:
    
    c - 文字
  - enginePuts
```
protected final void enginePuts(CharSequence s)
```
    エンジンが扱う形式で指定された文字列をプットします．
    
    Parameters:
    
    s - 文字
    
    See Also:
    
    EdbDoc.puts(CharSequence)
  - engineTextPutc
```
protected abstract void engineTextPutc(int cp)
```
    エンジンが扱う形式で指定されたテキスト文字をプットします．
    
    Parameters:
    
    cp - テキスト文字
  - engineTextParse
```
protected abstract void engineTextParse(int cp,
                                        CharSequence s)
```
    テキスト文字列のプット中にエスケープシーケンスが見つかったときに呼び出されます．
    
    Parameters:
    
    cp - エスケープシーケンスの意味を表す文字
    
    s - エスケープシーケンスに繋げられた引数
  - engineTextPuts
```
protected final void engineTextPuts(CharSequence s)
```
    エンジンが扱う形式で指定されたテキスト文字をプットします．
    
    Parameters:
    
    s - テキスト文字列
    
    See Also:
    
    EdbDoc.textPuts(CharSequence)
  - engineTextPuts3
```
protected final void engineTextPuts3(CharSequence l,
                                     CharSequence s,
                                     CharSequence t)
```
    エンジンが扱う形式で指定されたテキスト文字をプットします．
    
    Parameters:
    
    l - 前置文字列
    
    s - テキスト文字列
    
    t - 後置文字列
  - enginePutComment
```
protected abstract void enginePutComment(CharSequence s)
```
    エンジンが扱う形式で指定されたコメントをプットします．
    
    Parameters:
    
    s - コメント
  - engineCreateSMGBegin
```
protected EdbDoc.Content engineCreateSMGBegin()
```
    エンジンが扱う形式で SMG ( 姓・ミドルネーム・名 ) の区間開始のコンテンツを作成します．
    
    Returns:
    
    Content
    
    See Also:
    
    EdbDoc.NameSMG
  - engineCreateSMGDelimiter
```
protected EdbDoc.Content engineCreateSMGDelimiter(boolean v)
```
    エンジンが扱う形式で SMG ( 姓・ミドルネーム・名 ) の区切りのコンテンツを作成します．
    
    Parameters:
    
    v - 表示するかどうか
    
    Returns:
    
    Content
    
    See Also:
    
    EdbDoc.NameSMG
  - engineCreateSMGEnd
```
protected EdbDoc.Content engineCreateSMGEnd()
```
    エンジンが扱う形式で SMG ( 姓・ミドルネーム・名 ) の区間終了のコンテンツを作成します．
    
    Returns:
    
    Content
    
    See Also:
    
    EdbDoc.NameSMG
  - engineCreateGMSBegin
```
protected EdbDoc.Content engineCreateGMSBegin()
```
    エンジンが扱う形式で GMS ( 名・ミドルネーム・姓 ) の区間開始のコンテンツを作成します．
    
    Returns:
    
    Content
    
    See Also:
    
    EdbDoc.NameGMS
  - engineCreateGMSDelimiter
```
protected EdbDoc.Content engineCreateGMSDelimiter(boolean v)
```
    エンジンが扱う形式で GMS ( 名・ミドルネーム・姓 ) の区切りのコンテンツを作成します．
    
    Parameters:
    
    v - 表示するかどうか
    
    Returns:
    
    Content
    
    See Also:
    
    EdbDoc.NameGMS
  - engineCreateGMSEnd
```
protected EdbDoc.Content engineCreateGMSEnd()
```
    エンジンが扱う形式で GMS ( 名・ミドルネーム・姓 ) の区間終了のコンテンツを作成します．
    
    Returns:
    
    Content
    
    See Also:
    
    EdbDoc.NameGMS
  - engineCreateAND
```
protected EdbDoc.Content engineCreateAND()
```
    AND 文字列のコンテンツを返します．
    
    Returns:
    
    Content
    
    See Also:
    
    EdbDoc.ANDText
  - engineNewPage
```
protected void engineNewPage()
```
    改ページ．
  - enginePutDocumentHeader
```
protected abstract void enginePutDocumentHeader(CharSequence s)
```
    エンジンが扱う形式でドキュメントヘッダのコンテンツを作成します．
    
    Parameters:
    
    s - タイトル
    
    See Also:
    
    EdbDoc.putDocumentHeader(CharSequence)
  - enginePutDocumentTrailer
```
protected abstract void enginePutDocumentTrailer()
```
    エンジンが扱う形式でドキュメントトレイラのコンテンツを作成します．
    
    See Also:
    
    EdbDoc.putDocumentTrailer()
  - engineListingBegin
```
protected abstract void engineListingBegin(boolean o)
```
    リスティングの区間を開始します．
    
    Parameters:
    
    o - 番号付かどうか
  - engineListingEnd
```
protected abstract void engineListingEnd(boolean o)
```
    リスティングの区間を終了します．
    
    Parameters:
    
    o - 番号付かどうか．開始時のものと同じ値を指定
  - engineListingTitle
```
protected void engineListingTitle(CharSequence name)
```
    リスティングのタイトルをセットします．
    
    Parameters:
    
    name - タイトル．
  - engineListingItemBegin
```
protected abstract void engineListingItemBegin(CharSequence s)
```
    リスティング項目の区間を開始します．
    
    Parameters:
    
    s - リスティング番号
  - engineListingItemEnd
```
protected abstract void engineListingItemEnd(CharSequence s)
```
    リスティング項目の区間を終了します．
    
    Parameters:
    
    s - リスティング番号
  - engineParagraphBegin
```
protected void engineParagraphBegin()
```
  - engineParagraphEnd
```
protected void engineParagraphEnd()
```
  - engineTableBegin
```
protected void engineTableBegin(int cols)
```
    Begin Table.
    
    Parameters:
    
    cols - カラム数
  - engineTableBegin
```
protected void engineTableBegin()
```
  - engineTableEnd
```
protected void engineTableEnd()
```
    End Table.
  - engineTableHeaderBegin
```
protected void engineTableHeaderBegin()
```
    Begin Table Header.
  - engineTableHeaderEnd
```
protected void engineTableHeaderEnd()
```
    End Table Header.
  - engineTableBodyBegin
```
protected void engineTableBodyBegin()
```
    Begin Table Body.
  - engineTableBodyEnd
```
protected void engineTableBodyEnd()
```
    End Table Body.
  - engineTableRowBegin
```
protected void engineTableRowBegin()
```
    Begin Table Row.
  - engineTableRowEnd
```
protected void engineTableRowEnd()
```
    End Table Row.
  - engineTableCellBegin
```
protected void engineTableCellBegin()
```
    Begin Table Cell.
  - engineTableCellEnd
```
protected void engineTableCellEnd()
```
    End Table Cell.
  - engineTableTitle
```
protected void engineTableTitle(CharSequence title)
```
    set Table Title
    
    Parameters:
    
    title - タイトル
  - engineColorBegin
```
protected void engineColorBegin(int fgc)
```
    色付き文字の区間を開始します．
    
    Parameters:
    
    fgc - 文字色．24bit RGB
  - engineColorEnd
```
protected void engineColorEnd()
```
    色付き文字の区間を終了します．
  - engineUnderlineBegin
```
protected void engineUnderlineBegin()
```
    下線付き文字の区間を開始します．
  - engineUnderlineEnd
```
protected void engineUnderlineEnd()
```
    下線付き文字の区間を終了します．
  - engineLineThroughBegin
```
protected void engineLineThroughBegin()
```
    LineThough文字の区間を開始します．
  - engineLineThroughEnd
```
protected void engineLineThroughEnd()
```
    LineThough文字の区間を終了します．
  - engineBoldBegin
```
protected void engineBoldBegin()
```
    太字の区間を開始します．
  - engineBoldEnd
```
protected void engineBoldEnd()
```
    太字の区間を終了します．
  - engineItalicBegin
```
protected void engineItalicBegin()
```
    イタリック体文字の区間を開始します．
  - engineItalicEnd
```
protected void engineItalicEnd()
```
    イタリック体文字の区間を終了します．
  - engineCreateEMAIL
```
protected EdbDoc.Content engineCreateEMAIL(CharSequence s)
```
    エンジンが扱う形式で指定されたメールアドレスのコンテキストを返します．
    
    Parameters:
    
    s - メールアドレス
    
    Returns:
    
    Content
    
    See Also:
    
    EdbDoc.EMailText
  - engineCreateURL
```
protected EdbDoc.Content engineCreateURL(CharSequence s)
```
    エンジンが扱う形式で指定された URL のコンテントを返します．
    
    Parameters:
    
    s - URL文字列
    
    Returns:
    
    Content
    
    See Also:
    
    EdbDoc.URLText
  - engineCreateDATE
```
protected EdbDoc.Content engineCreateDATE(EdbDate d,
                                          EdbDate.FMT fmt)
```
    エンジンが扱う形式で指定された日付のコンテンツを返します．
    
    Parameters:
    
    d - 日付
    
    fmt - フォーマット，フォーマットの定数の値を指定
    
    Returns:
    
    Content
    
    See Also:
    
    EdbDoc.DateText, EdbDate.FMT
  - engineCreateDATE2
```
protected EdbDoc.Content engineCreateDATE2(EdbDate2 period,
                                           EdbDate.FMT fmt)
```
    エンジンが扱う形式で指定された期間のコンテンツを返します．
    
    Parameters:
    
    period - 期間．期間 ( 始まり ) ・期間 ( 終わり ) の配列
    
    fmt - フォーマット，フォーマットの定数の値を指定
    
    Returns:
    
    Content
    
    See Also:
    
    EdbDate.FMT, EdbDoc.Date2Text
  - engineCreatePageNumber
```
protected EdbDoc.Content engineCreatePageNumber(String[] page,
                                                boolean latin)
```
    エンジンが扱う形式で指定されたページ番号のコンテンツを返します．
    
    Parameters:
    
    page - ページ．ページ ( 始まり ) ・ページ ( 終わり ) の配列
    
    latin - 英語 (Latin) かどうか
    
    Returns:
    
    Content
    
    See Also:
    
    EdbDoc.PageNumberText
  - engineCreateMONETARY
```
protected EdbDoc.Content engineCreateMONETARY(double money,
                                              boolean latin)
```
    エンジンが扱う形式で指定された金額のコンテンツを返します．
    
    Parameters:
    
    money - 金額
    
    latin - 英語 (Latin) かどうか
    
    Returns:
    
    Content
    
    See Also:
    
    EdbDoc.MonetaryText
  - engineImportSpecialAttributes
```
protected void engineImportSpecialAttributes(List<EdbDoc.Attribute> list)
```
  - enginePreProcessings
```
protected void enginePreProcessings()
```
    前処理
    - (set attributes)
    - enginePreProcessings()
    - engineXXXBegin()
    - (print contents)
    - engineXXXEnd()
    - enginePostProcessings()
  - enginePostProcessings
```
protected void enginePostProcessings()
```
  - createContext
```
protected C createContext()
```
    プリンターのコンテキストを作成する．
    
    Returns:
    
    コンテキスト
  - duplicateContext
```
protected C duplicateContext(C ctxt)
```
    プリンターコンテキストの複製を作成する．
    
    Parameters:
    
    ctxt - 複製されるコンテキスト
    
    Returns:
    
    複製されたコンテキスト
  - printContainerContents
```
protected void printContainerContents(EdbDoc.Container con)
```
  - enginePrint
```
protected final void enginePrint(EdbDoc.Content content)
```
    Contentを出力する．
    
    Parameters:
    
    content - Content.
  - enginePrintContent
```
protected void enginePrintContent(EdbDoc.Content content)
```
    Contentを出力する．
    
    Parameters:
    
    content - Content.
  - dmlIsInLimited
```
protected boolean dmlIsInLimited(EdbDoc.Container con)
```
  - collectText
```
protected CharSequence collectText(EdbDoc.Container con)
```

Class EdbDocSpi<C extends EdbDocSpi.ContentPrinterContext>

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

edb

edbtext

lastcp

numberOfTableColumns

tableColumnIndex

tableHeader

current_context

context_stack

Constructor Detail

EdbDocSpi

Method Detail

engineInitialize

append

append

append

isMath

isMathImplicit

isMathExplicit

getMathMode

setMathMode

mathEnter

mathLeave

engineGetDML

engineGetDMLSet

engineGetDefaultFileExtension

engineMathEnter

engineMathLeave

enginePutc

enginePuts

engineTextPutc

engineTextParse

engineTextPuts

engineTextPuts3

enginePutComment

engineCreateSMGBegin

engineCreateSMGDelimiter

engineCreateSMGEnd

engineCreateGMSBegin

engineCreateGMSDelimiter

engineCreateGMSEnd

engineCreateAND

engineNewPage

enginePutDocumentHeader

enginePutDocumentTrailer

engineListingBegin

engineListingEnd

engineListingTitle

engineListingItemBegin

engineListingItemEnd

engineParagraphBegin

engineParagraphEnd

engineTableBegin

engineTableBegin

engineTableEnd

engineTableHeaderBegin

engineTableHeaderEnd

engineTableBodyBegin

engineTableBodyEnd

engineTableRowBegin

engineTableRowEnd

engineTableCellBegin

engineTableCellEnd

engineTableTitle

engineColorBegin

engineColorEnd

engineUnderlineBegin

engineUnderlineEnd

engineLineThroughBegin

engineLineThroughEnd

engineBoldBegin

engineBoldEnd

engineItalicBegin

engineItalicEnd