Skip navigation links
EDB/Java
jp.ac.tokushima_u.edb

Class EdbDoc



  • public final class EdbDoc
    extends Object
    ドキュメントを表し,ドキュメント生成エンジンにより出力された情報を保持します.
    Version:
    $Id: EdbDoc.java,v 1.86 2024/10/28 06:37:11 alex Exp $
    • Constructor Detail

      • EdbDoc

        public EdbDoc()
    • Method Detail

      • getInstance

        public static EdbDoc getInstance(EDB edb,
                                         EdbDocSpi spi,
                                         PrintStream ps)
        指定されたエンジンを持つドキュメントのインスタンスを取得します.
        Parameters:
        edb - EDB コンテキスト
        spi - engine
        ps - 出力先
        Returns:
        成功した場合はインスタンスを返します.失敗した場合は null を返します.
      • getInstance

        public static EdbDoc getInstance(EDB edb,
                                         EdbDocSpi spi,
                                         PrintWriter ps)
        指定されたエンジンを持つドキュメントのインスタンスを取得します.
        Parameters:
        edb - EDB コンテキスト
        spi - engine
        ps - 出力先
        Returns:
        成功した場合はインスタンスを返します.失敗した場合は null を返します.
      • getInstance

        public static EdbDoc getInstance(EDB edb,
                                         Class<? extends EdbDocSpi> c,
                                         PrintStream ps)
        指定されたエンジンを持つドキュメントのインスタンスを取得します.
        Parameters:
        edb - EDB コンテキスト
        c - エンジン
        ps - 出力先
        Returns:
        成功した場合はインスタンスを返します.失敗した場合は null を返します.
      • getInstance

        public static EdbDoc getInstance(EDB edb,
                                         Class<? extends EdbDocSpi> c,
                                         PrintWriter ps)
        指定されたエンジンを持つドキュメントのインスタンスを取得します.
        Parameters:
        edb - EDB コンテキスト
        c - エンジン
        ps - 出力先
        Returns:
        成功した場合はインスタンスを返します.失敗した場合は null を返します.
      • getInstance

        public static EdbDoc getInstance(EDB edb,
                                         String dml,
                                         PrintStream ps)
        指定された DML のエンジンを持つドキュメントのインスタンスを取得します.
        Parameters:
        edb - EDB コンテキスト
        dml - DML
        ps - 出力先
        Returns:
        成功した場合はインスタンスを返します.失敗した場合は null を返します.
      • getInstance

        public static EdbDoc getInstance(EDB edb,
                                         String dml,
                                         PrintWriter ps)
        指定された DML のエンジンを持つドキュメントのインスタンスを取得します.
        Parameters:
        edb - EDB コンテキスト
        dml - DML
        ps - 出力先
        Returns:
        成功した場合はインスタンスを返します.失敗した場合は null を返します.
      • getInstance

        public static EdbDoc getInstance(EDB edb,
                                         Class<? extends EdbDocSpi> c)
        指定されたエンジンを持つドキュメントのインスタンスを取得します.
        Parameters:
        edb - EDB コンテキスト
        c - エンジン
        Returns:
        成功した場合はインスタンスを返します.失敗した場合は null を返します.
      • getInstance

        public static EdbDoc getInstance(EDB edb,
                                         EdbDocSpi spi)
        指定されたエンジンを持つドキュメントのインスタンスを取得します.
        Parameters:
        edb - EDB コンテキスト
        spi - エンジンのインスタンス.
        Returns:
        成功した場合はインスタンスを返します.失敗した場合は null を返します.
      • getDefaultFileExtension

        public String getDefaultFileExtension()
        デフォルトのファイル拡張子を取得します.
        Returns:
        デフォルトのファイル拡張子を返します.
      • textToDMLText

        public static CharSequence textToDMLText(EDB edb,
                                                 Class<? extends EdbDocSpi> c,
                                                 CharSequence text)
        テキストを指定されたDMLに変換する.
        Parameters:
        edb - EDB コンテキスト
        c - エンジン
        text - テキスト.
        Returns:
        DMLで変換されたテキスト
      • getSequence

        public CharSequence getSequence()
        エンジンによって生成された文字列を取得します.

        このメソッドは呼び出されるたびに,生成された内容を保持しているバッファを新しいものに差し替えリセットします. また,ドキュメントの出力先を変更している場合はそちらに出力されるため,このメソッドは空文字列を返します.

        Returns:
        生成された文字列を返します.
      • append

        int append(byte[] b)
      • append

        int append(int cp)
      • puts

        public int puts(CharSequence s)
        指定された文字列をプットします.
        Parameters:
        s - 文字列
        Returns:
        エンジンが扱う形式で格納された文字の文字数を返します.
      • textPuts

        public int textPuts(CharSequence s)
        指定されたテキスト文字列をプットします.
        Parameters:
        s - テキスト文字列
        Returns:
        エンジンが扱う形式で格納された文字の文字数を返します.
      • putDocumentHeader

        public int putDocumentHeader(CharSequence title)
        ドキュメントヘッダをプットします.
        Parameters:
        title - タイトル
        Returns:
        エンジンが扱う形式で格納されたドキュメントヘッダの文字数を返します.
        See Also:
        EdbDocSpi.enginePutDocumentHeader(CharSequence)
      • putDocumentTrailer

        public int putDocumentTrailer()
        ドキュメントトレイラをプットします.
        Returns:
        エンジンが扱う形式で格納されたドキュメントトレイラの文字数を返します.
        See Also:
        EdbDocSpi.enginePutDocumentTrailer()
      • listingBegin

        public int listingBegin(boolean o)
        リスティングの区間を開始します.
        Parameters:
        o - 番号付かどうか
        Returns:
        エンジンが扱う形式で格納された区間開始文字の文字数を返します.
        See Also:
        listingEnd(boolean)
      • listingEnd

        public int listingEnd(boolean o)
        リスティングの区間を終了します.
        Parameters:
        o - 番号付かどうか.開始時のものと同じ値を指定
        Returns:
        エンジンが扱う形式で格納された区間終了文字の文字数を返します.
        See Also:
        listingBegin(boolean)
      • tableBegin

        public int tableBegin(int cols)
        Begin Table.
        Parameters:
        cols - カラム数
        Returns:
        エンジンが扱う形式で格納された文字数を返します.
      • tableEnd

        public int tableEnd()
        End Table.
        Returns:
        エンジンが扱う形式で格納された文字数を返します.
      • tableBodyBegin

        public int tableBodyBegin()
        Begin Table Body.
        Returns:
        エンジンが扱う形式で格納された文字数を返します.
      • tableBodyEnd

        public int tableBodyEnd()
        End Table Body.
        Returns:
        エンジンが扱う形式で格納された文字数を返します.
      • repeat

        public static EdbDoc.Container repeat(int n,
                                              EdbDoc.Content... cons)
        create repeat contents.
        Parameters:
        n - repeat.
        cons - contents
        Returns:
        Container
      • createNewPage

        public static EdbDoc.Container createNewPage()
        Create New Page.
        Returns:
        New Page container.
      • createListingTitle

        public static EdbDoc.Container createListingTitle(CharSequence title)
        Create Listing Title Container.
        Parameters:
        title - title.
        Returns:
        listing title container.
      • createListItem

        public static EdbDoc.Container createListItem(EdbDoc.AttributeSpi... attrs)
        Create Listing Item.
        Parameters:
        attrs - attributes.
        Returns:
        listing item container.
      • createDefinitionTerm

        public static EdbDoc.Container createDefinitionTerm(EdbDoc.AttributeSpi... attrs)
        Create Definition Term.
        Parameters:
        attrs - attributes.
        Returns:
        definition term container.
      • createDefinitionDescription

        public static EdbDoc.Container createDefinitionDescription(EdbDoc.AttributeSpi... attrs)
        Create Definition Description.
        Parameters:
        attrs - attributes.
        Returns:
        definition description container.
      • createDefinitionDescription

        public static EdbDoc.Container createDefinitionDescription(CharSequence text,
                                                                   EdbDoc.AttributeSpi... attrs)
        Create Definition Description.
        Parameters:
        text - text.
        attrs - attributes.
        Returns:
        definition description container.
      • createHeading

        public static EdbDoc.Container createHeading(int level,
                                                     EdbDoc.Content con,
                                                     EdbDoc.AttributeSpi... attrs)
        Create Heading Container.
        Parameters:
        level - heading level.
        con - content.
        attrs - attributes.
        Returns:
        heading container.
      • createHeading

        public static EdbDoc.Container createHeading(int level,
                                                     CharSequence text,
                                                     EdbDoc.AttributeSpi... attrs)
        Create Heading Container.
        Parameters:
        level - heading level.
        text - heading text.
        attrs - attributes.
        Returns:
        heading container.
      • createHeading

        public static EdbDoc.Container createHeading(int level,
                                                     MLText text,
                                                     EdbDoc.AttributeSpi... attrs)
        Create Heading Container.
        Parameters:
        level - heading level.
        text - heading text.
        attrs - attributes.
        Returns:
        heading container.
      • createHeading

        public static EdbDoc.Container createHeading(int level,
                                                     EdbDoc.AttributeSpi... attrs)
        Create Heading Container.
        Parameters:
        level - heading level.
        attrs - attributes.
        Returns:
        heading container.
      • createParagraph

        public static EdbDoc.Container createParagraph(MLText text,
                                                       EdbDoc.AttributeSpi... attrs)
        Create Paragraph Container.
        Parameters:
        text - heading text.
        attrs - attributes.
        Returns:
        paragraph container.
      • createParagraph

        public static EdbDoc.Container createParagraph(EdbDoc.AttributeSpi... attrs)
        Create Paragraph Container.
        Parameters:
        attrs - attributes.
        Returns:
        paragraph container.
      • createCell

        public static EdbDoc.Container createCell(int rows,
                                                  int cols,
                                                  EdbDoc.Content content,
                                                  EdbDoc.AttributeSpi... attrs)
        Create Cell Container.
        Parameters:
        rows - row span.
        cols - column span.
        content - container.
        attrs - attribute.
        Returns:
        cell container.
      • createCell

        public static EdbDoc.Container createCell(int rows,
                                                  int cols,
                                                  EdbDoc.AttributeSpi... attrs)
        Create Cell Container.
        Parameters:
        rows - row span.
        cols - column span.
        attrs - attribute.
        Returns:
        cell container.
      • createCell

        public static EdbDoc.Container createCell(int rows,
                                                  int cols,
                                                  CharSequence text,
                                                  EdbDoc.AttributeSpi... attrs)
        Create Cell Container.
        Parameters:
        rows - row span.
        cols - column span.
        text - cell value.
        attrs - attribute.
        Returns:
        cell container.
      • createCell

        public static EdbDoc.Container createCell(int rows,
                                                  int cols,
                                                  MLText text,
                                                  EdbDoc.AttributeSpi... attrs)
        Create Cell Container.
        Parameters:
        rows - row span.
        cols - column span.
        text - cell value.
        attrs - attribute.
        Returns:
        cell container.
      • createTableRow

        public static EdbDoc.Container createTableRow(EdbDoc.AttributeSpi... attrs)
        Create TableRow Container.
        Parameters:
        attrs - attributes.
        Returns:
        table row container.
      • createTableHead

        public static EdbDoc.Container createTableHead(EdbDoc.AttributeSpi... attrs)
        Create TableHead Container.
        Parameters:
        attrs - attributes.
        Returns:
        table head container.
      • createTableBody

        public static EdbDoc.Container createTableBody(EdbDoc.AttributeSpi... attrs)
        Create TableBody Container.
        Parameters:
        attrs - attributes.
        Returns:
        table body container.
      • createTableTitle

        public static EdbDoc.Container createTableTitle(CharSequence title)
        Create Table Title Container.
        Parameters:
        title - title.
        Returns:
        table title container.
EDB/Java

EDB Working Group at Tue Jun 10 17:08:59 JST 2025