ToHtml (BandM metatools API doc)

java.lang.Object
- eu.bandm.tools.tdom.runtime.BaseVisitor
- - eu.bandm.tools.lablog.xml.Visitor
  - - eu.bandm.tools.lablog.base.ToHtml

All Implemented Interfaces:: PCDataVisitor

public class ToHtml
extends Visitor

Generate from a collection of lablog entries an interactive HTML representation. Visit the lablog tdom model and create an xhtml tdom model.

The text structure of lablog is imported from d2d_gp.basic. One central issue is the difference in content models for the xhtml containers Element_p, Element_li, Element_td, etc., and the compositional modifiers Element_em, Element_span, etc. E.g. a visited PCData on the input side will be translated into very different of these target contexts, and thus wrapped into different eu.bandm.tools.tdom.runtum.TypedContent classes. For this the ToHtml.DeliveryContext is introduced.

A special problem is the "hierarchy rotation" between "p" on one side and "list" and "table" on the other. In d2d_gp.basic the "p" element is the central means for organizing text (e.g. the attributes "language", "style", "accessRights"), and all other elements containing text (even images) are subordinated. In xhtml its different and not so consistent:

          d2d_gp.basic:             xhtml:

          |                        |---------+--------+
          p                        p       list       p
          |--------+-----+         |                  |
          PCData  list PCData      PCData          PCData
  
    
  The xhtml Tdom defines some abstract classes which make this sorting easier:

           Element_body      Element_p              Element_li                E_span    Element_div
         Element_td                                                         E_em etc. _inline
  contains..
         E_block_content   E_p.Content            E_li.Content              E_span.Content  
                         wraps..
                           E_misc_inline|E_inline E_block_content|E_inline  E_misc_inline|_inline
                         which are..
                                        |_a|_phrase  |_fonstyle
                                           |_em|_kbd |_b|_big|_i|_tt
  which are..                                          
         E_form | E_form_content
                  E_block      | E_misc
                               | E_misc_inline|_noscript 
                               | _del|_ins|_script
                  E_div|_p|E_table
                  E_heading|E_blocktext
                  _h1|_h2..|hr pre address
  
  Element_misc_inline (del, ins, script, noscript) is not in a full copositional way.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`protected class`	`ToHtml.Alt`
`protected class`	`ToHtml.DeliverBlockContent`
`protected class`	`ToHtml.DeliverInline`
`protected class`	`ToHtml.DeliverToListItem`
`protected class`	`ToHtml.DeliverToPre`
`protected class`	`ToHtml.DeliverToTd`
`protected class`	`ToHtml.DeliveryContext<T>`

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`CL_authors` Class name for the css style definitions.
`static String`	`CL_costs_N` Class name for the css style definitions.
`static String`	`CL_docmatHeader` Class name for the css style definitions.
`static String`	`CL_issue_header` Class name for the css style definitions.
`static String`	`CL_issue_prefix` Class name for the css style definitions.
`static String`	`CL_issueDate` Class name for the css style definitions.
`static String`	`CL_noteHeader` Class name for the css style definitions.
`static String`	`CL_package_header` Class name for the css style definitions.
`static String`	`CL_prior_N` Class name for the css style definitions.
`static String`	`CL_status_N` Class name for the css style definitions.
`static String`	`CL_survey_tab` Class name for the css style definitions.
`static String`	`CL_survey_tab_ACTIVE` Class name for the css style definitions.
`static String`	`CL_td_nodecor` Class name for the css style definitions.
`static String`	`CL_topHeadline` Class name for the css style definitions.
`static Element_br`	`EL_BR`
`static Element_hr`	`EL_HR`
`protected Map<Element,File>`	`elements2file` Input parameter, passed in from the file visitor in `Main`, which collected the lablog tdom elements.
`static String`	`href_bandm_online_docu` Put into the footer.
`static String`	`ISSUE_SEPARATOR` Separator between the names of package and issue.
`static String`	`LINK_DOCMAT` Stub of the name of the anchor where the docmat region of a package begins.
`protected MessageReceiver<SimpleMessage<XMLDocumentIdentifier>>`	`msg`
`static String`	`path_to_javascript` Value which will be encoded in the generated html to address the stylesheet.
`static String`	`path_to_stylesheet` Value which will be encoded in the generated html to address the stylesheet.

Fields inherited from class eu.bandm.tools.tdom.runtime.BaseVisitor
validating

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected String`	`extractAuthors(Element el)` Visit an subtree of the d2d input and extract a list of author names.
`Element_html`	`makeHtml(SortedMap<String,List<Element_issue>> issuesByPackage, SortedMap<String,List<Element_docmat>> docmatsByPackage, Map<Element,File> elements2file, Map<File,MessageStore<SimpleMessage<XMLDocumentIdentifier>>> files2error)` Make the complete html rendering.
`protected void`	`renderDocmat(String packageName, String issueName, Element_docmat data)` Make the xhtml rendering of a d2d "docMat" element, which appears independent from an issue.
`protected void`	`renderIssue(String packageName, String issueName, Element_issue data)` Make the xhtml rendering of a d2d "issue" element.
`protected void`	`renderPackage(String packagename, @Opt List<Element_issue> issues, @Opt List<Element_docmat> docmats)` Make the xhtml rendering of a package header, i.e.
`void`	`visit(Element_a_emph el)` Construct an xhtml em from a d2d emph.
`void`	`visit(Element_a_link el)` Construct an xhtml link from a d2d link.
`void`	`visit(Element_a_list el)` Construct an xhtml list from a d2d list.
`void`	`visit(Element_a_listitem el)` Can be overridden by the user to define particular semantic operations.
`void`	`visit(Element_a_nl el)` Construct an xhtml br from a d2d nl.
`void`	`visit(Element_a_p el)` Construct an xhtml p from a d2d p.
`void`	`visit(Element_a_src el)` Construct an xhtml tt from a d2d scr.
`void`	`visit(Element_a_SRC el)` Construct an xhtml PRE from a d2d SRC.
`void`	`visit(Element_a_table el)` Construct an xhtml table from a d2d table.
`void`	`visit(Element_a_td el)` Construct an xhtml td from a d2d td.
`void`	`visit(Element_a_tr el)` Construct an xhtml tr from a d2d tr.
`void`	`visit(Element_desc el)` Make the xhtml rendering of a d2d "desc" element, which occurs is the main sub-element of an issue.
`void`	`visit(Element_note el)` Make the xhtml rendering of a note = a text aappended to an Issue.
`void`	`visit(TypedPCData data)`

Methods inherited from class eu.bandm.tools.lablog.xml.Visitor
visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit

Methods inherited from class eu.bandm.tools.tdom.runtime.BaseVisitor
visit

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

- Field Detail
  - path_to_stylesheet
```
public static final String path_to_stylesheet
```
    Value which will be encoded in the generated html to address the stylesheet.
    
    See Also:
    
    Constant Field Values
  - path_to_javascript
```
public static final String path_to_javascript
```
    Value which will be encoded in the generated html to address the stylesheet.
    
    See Also:
    
    Constant Field Values
  - ISSUE_SEPARATOR
```
public static final String ISSUE_SEPARATOR
```
    Separator between the names of package and issue. This must be valid XML NMTOKEN character but NOT part of a java package name
    
    See Also:
    
    Constant Field Values
  - href_bandm_online_docu
```
public static final String href_bandm_online_docu
```
    Put into the footer.
    
    See Also:
    
    Constant Field Values
  - LINK_DOCMAT
```
public static final String LINK_DOCMAT
```
    Stub of the name of the anchor where the docmat region of a package begins.
    
    See Also:
    
    Constant Field Values
  - CL_topHeadline
```
public static final String CL_topHeadline
```
    Class name for the css style definitions.
    
    See Also:
    
    Constant Field Values
  - CL_survey_tab
```
public static final String CL_survey_tab
```
    Class name for the css style definitions.
    
    See Also:
    
    Constant Field Values
  - CL_survey_tab_ACTIVE
```
public static final String CL_survey_tab_ACTIVE
```
    Class name for the css style definitions.
    
    See Also:
    
    Constant Field Values
  - CL_package_header
```
public static final String CL_package_header
```
    Class name for the css style definitions.
    
    See Also:
    
    Constant Field Values
  - CL_issue_header
```
public static final String CL_issue_header
```
    Class name for the css style definitions.
    
    See Also:
    
    Constant Field Values
  - CL_issue_prefix
```
public static final String CL_issue_prefix
```
    Class name for the css style definitions.
    
    See Also:
    
    Constant Field Values
  - CL_td_nodecor
```
public static final String CL_td_nodecor
```
    Class name for the css style definitions.
    
    See Also:
    
    Constant Field Values
  - CL_prior_N
```
public static final String CL_prior_N
```
    Class name for the css style definitions.
    
    See Also:
    
    Constant Field Values
  - CL_costs_N
```
public static final String CL_costs_N
```
    Class name for the css style definitions.
    
    See Also:
    
    Constant Field Values
  - CL_issueDate
```
public static final String CL_issueDate
```
    Class name for the css style definitions.
    
    See Also:
    
    Constant Field Values
  - CL_status_N
```
public static final String CL_status_N
```
    Class name for the css style definitions.
    
    See Also:
    
    Constant Field Values
  - CL_authors
```
public static final String CL_authors
```
    Class name for the css style definitions.
    
    See Also:
    
    Constant Field Values
  - CL_noteHeader
```
public static final String CL_noteHeader
```
    Class name for the css style definitions.
    
    See Also:
    
    Constant Field Values
  - CL_docmatHeader
```
public static final String CL_docmatHeader
```
    Class name for the css style definitions.
    
    See Also:
    
    Constant Field Values
  - EL_BR
```
public static final Element_br EL_BR
```
  - EL_HR
```
public static final Element_hr EL_HR
```
  - msg
```
protected MessageReceiver<SimpleMessage<XMLDocumentIdentifier>> msg
```
  - elements2file
```
protected Map<Element,File> elements2file
```
    Input parameter, passed in from the file visitor in Main, which collected the lablog tdom elements.
- Method Detail
  - visit
```
public void visit(TypedPCData data)
```
    Specified by:
    
    visit in interface PCDataVisitor
    
    Overrides:
    
    visit in class Visitor
  - visit
```
public void visit(Element_a_list el)
```
    Construct an xhtml list from a d2d list. For this, a currently growing xhtml paragraph must be closed and re-opened afterwards. ATTENTION: correspondig to d2d_gp toXhtml, a list without "symbol" entry is rendered by arabic numbers.
    
    Overrides:
    
    visit in class Visitor
  - visit
```
public void visit(Element_a_listitem el)
```
    Description copied from class: Visitor
    
    Can be overridden by the user to define particular semantic operations. Will be called whenever the default model instance traversal (as implemented by the methods in this class) reaches such an element.
    This default implementation descends into the element by calling visit(..) in turn for all PCData and all Elements in its contents.
    
    Overrides:
    
    visit in class Visitor
  - visit
```
public void visit(Element_a_table el)
```
    Construct an xhtml table from a d2d table. For this, a currently growing xhtml paragraph must be closed and re-opened afterwards.
    
    Overrides:
    
    visit in class Visitor
  - visit
```
public void visit(Element_a_tr el)
```
    Construct an xhtml tr from a d2d tr.
    
    Overrides:
    
    visit in class Visitor
  - visit
```
public void visit(Element_a_td el)
```
    Construct an xhtml td from a d2d td.
    
    Overrides:
    
    visit in class Visitor
  - visit
```
public void visit(Element_a_p el)
```
    Construct an xhtml p from a d2d p.
    
    Overrides:
    
    visit in class Visitor
  - visit
```
public void visit(Element_a_SRC el)
```
    Construct an xhtml PRE from a d2d SRC.
    
    Overrides:
    
    visit in class Visitor
  - visit
```
public void visit(Element_a_nl el)
```
    Construct an xhtml br from a d2d nl.
    
    Overrides:
    
    visit in class Visitor
  - visit
```
public void visit(Element_a_src el)
```
    Construct an xhtml tt from a d2d scr.
    
    Overrides:
    
    visit in class Visitor
  - visit
```
public void visit(Element_a_link el)
```
    Construct an xhtml link from a d2d link.
    ATTENTION renders from the "text" input only un-decorated text. Starting "0" is replaced by "http:/" and "1" by "https:/", for ease of writing.
    
    Overrides:
    
    visit in class Visitor
  - visit
```
public void visit(Element_a_emph el)
```
    Construct an xhtml em from a d2d emph.
    
    Overrides:
    
    visit in class Visitor
  - extractAuthors
```
protected String extractAuthors(Element el)
```
    Visit an subtree of the d2d input and extract a list of author names.
  - visit
```
public void visit(Element_note el)
```
    Make the xhtml rendering of a note = a text aappended to an Issue.
    
    Overrides:
    
    visit in class Visitor
  - visit
```
public void visit(Element_desc el)
```
    Make the xhtml rendering of a d2d "desc" element, which occurs is the main sub-element of an issue. Open a paragraph context in case that the "@p" alternative of its content model is chosen, and flushP() it on return, if necessary. If the "p*" alternative is chosen, this first (empty) paragraph will be flushed and the explicit/contained paragraph will also be flushed by its visitor code (thus inP==false).
    
    Overrides:
    
    visit in class Visitor
  - renderDocmat
```
protected void renderDocmat(String packageName,
                            String issueName,
                            Element_docmat data)
```
    Make the xhtml rendering of a d2d "docMat" element, which appears independent from an issue.
  - renderIssue
```
protected void renderIssue(String packageName,
                           String issueName,
                           Element_issue data)
```
    Make the xhtml rendering of a d2d "issue" element.
  - renderPackage
```
protected void renderPackage(String packagename,
                             @Opt
                             @Opt List<Element_issue> issues,
                             @Opt
                             @Opt List<Element_docmat> docmats)
```
    Make the xhtml rendering of a package header, i.e. a package name for which issues or docmats or both have been collected.
  - makeHtml
```
public Element_html makeHtml(SortedMap<String,List<Element_issue>> issuesByPackage,
                             SortedMap<String,List<Element_docmat>> docmatsByPackage,
                             Map<Element,File> elements2file,
                             Map<File,MessageStore<SimpleMessage<XMLDocumentIdentifier>>> files2error)
```
    Make the complete html rendering.

Class ToHtml

Nested Class Summary

Field Summary

Fields inherited from class eu.bandm.tools.tdom.runtime.BaseVisitor

Method Summary

Methods inherited from class eu.bandm.tools.lablog.xml.Visitor

Methods inherited from class eu.bandm.tools.tdom.runtime.BaseVisitor

Methods inherited from class java.lang.Object

Field Detail

path_to_stylesheet

path_to_javascript

ISSUE_SEPARATOR

href_bandm_online_docu

LINK_DOCMAT

CL_topHeadline

CL_survey_tab

CL_survey_tab_ACTIVE

CL_package_header

CL_issue_header

CL_issue_prefix

CL_td_nodecor

CL_prior_N

CL_costs_N

CL_issueDate

CL_status_N

CL_authors

CL_noteHeader

CL_docmatHeader

EL_BR

EL_HR

msg

elements2file

Method Detail

visit

visit

visit

visit

visit

visit

visit

visit

visit

visit

visit

visit

extractAuthors

visit

visit

renderDocmat

renderIssue

renderPackage

makeHtml