org.vishia.odt.readOdt

Class ReadOdt

java.lang.Object

org.vishia.odt.readOdt.ReadOdt

public class ReadOdt
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ReadOdt.CmdArgs

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	bInCodeBlock
private boolean	bInColumns
(package private) int[]	chapterNr If not null, then replace the first ' ' of the next output with this char.
private ReadOdt.CmdArgs	cmdArgs
private java.util.Map<java.lang.String,java.lang.String>	idxBookmarkToShort
private java.util.Map<java.lang.String,java.lang.String>	idxDirectOnlyStyle
private java.util.Map<java.lang.String,StyleOdt>	idxDirectToStyle
private java.util.Map<java.lang.String,StyleImg>	idxImgDirectToStyle
private java.util.Map<java.lang.String,StyleOdt>	idxIndirectStyle This index is filled initially with a few styles which are expected, especially TextPg and TextCol, because of StyleOdt.pgBreakBefore etc. known by knowledge.
private java.util.Map<java.lang.String,java.lang.String>	idxShortToStyle
private java.util.Map<java.lang.String,java.lang.String>	idxStyleToShort
private java.util.Map<java.lang.String,java.lang.String>	idxUsedStyles
private java.lang.String	lastHlinkPathToReplaced The last anchor which is replaced for operation arguments.
private java.util.List<XmlDataNode>	listNdTitle Node text:h with the title of the document.
LogMessage	log
private XmlDataNode	nodeDirectStyles
private XmlDataNode	nodeText
private java.lang.StringBuilder	sb Buffer able to see in debug for buffered writer for markup and asciidoc.
private java.lang.StringBuilder	sba Buffer able to see in debug for buffered writer for markup and asciidoc.
(package private) static java.lang.String[][]	sCheckReplace
(package private) static java.lang.String	sIndent
(package private) static java.lang.String[]	sNewlineCheck
(package private) static java.lang.String[]	sNewlineCheckBack Used for search a separator position if sNewlineCheck is not found.
private java.lang.String	sRefBookmark Stores a found BOOKMARK in to write it in <#label, text ....> to compare with the other refs.
private java.lang.String	sRefChapter Stores a found text in
private StyleOdt	styleP
private java.io.Writer	wr The output channel for markup and asciidoc
private java.io.Writer	wra The output channel for markup and asciidoc
private java.io.Writer	wrRep The output channel for markup and asciidoc
private XmlCfg	xmlCfgOdt

Constructor Summary

Constructors

Constructor and Description
ReadOdt(ReadOdt.CmdArgs cmdArgs)

Method Summary

Modifier and Type	Method and Description
static int	amain(ReadOdt.CmdArgs args) main for this class, with given prepared arguments Does not catch unexpected exceptions and does not System.exit(...), use it to execute in a Java environment.
private void	defineIndirectStyles()
private java.lang.String	execute()
private java.lang.String	gatherAllHeading(XmlDataNode ndText)
protected java.lang.String	gatherContent(XmlDataNode nodeContent, int deepnessSection)
private java.lang.String	gatherDirectStyles(XmlDataNode nodeDirectStyles)
private java.lang.String	gatherHeader(XmlDataNode node) Writes a header as ''' [#label] ==== Chapter title
private java.lang.String	gathWrFrameOrImage(XmlDataNode ndParagr, XmlDataNode ndFrame, java.lang.String styleFrameRaw, boolean bCaption)
private java.lang.String	gathWrList(XmlDataNode nodeList)
private java.lang.String	gathWrListItem(XmlDataNode ndItem)
private java.lang.String	gathWrListItemOrNumbHeader(XmlDataNode nodeItem) Gather an item in a list, not known what is it.
private java.lang.String	gathWrParagraph(XmlDataNode node, int indent, java.lang.String[] stylesExpected) Writes an paragraph from XML to VMU It does not write a newline after the paragraph text because TODO
private java.lang.String	gathWrSpan(XmlDataNode node, StyleOdt style) span is for any text part with specific formatting.
private java.lang.String	gathWrTable(XmlDataNode ndTable)
private java.lang.String	gathWrTableOfContent(XmlDataNode node)
private java.lang.String	gathWrText(XmlDataNode nodeP) This is all inside a paragraph.
private java.lang.String	gathWrXlink(XmlDataNode ndA)
private char	gathWrXRef(XmlDataNode nodeXref) Gathers a <text:bookmark-ref ...>, writes in Adoc as <<#label>>.
private int	getAttribNumber(XmlDataNode node, java.lang.String key, int defaultNr)
private StyleOdt	getBaseStyle(java.lang.String styleNameArg)
(package private) java.lang.String	getBookmarkShort(XmlDataNode node, java.lang.String sAttribKey)
private int	getNumber(java.lang.String sNr, int defaultNr)
static void	main(java.lang.String[] sArgs) main for UFBglConv, invoked from cmd line.
private java.lang.String	readOdgxmlWriteAsciidoc(XmlDataNode ndRootOdg) This is the main routine after reading the whole XML file content.xml from odg.
private java.lang.String	readXml(java.lang.Object data, java.io.File fInOdg) Reads completely the content.xml from the given odg file and stores the data in the returned instance.
private int	searchLineBreak(boolean[] bInsideRef, java.lang.StringBuilder sb1, int posStart, int posEndFocus, int posEndTextSentence, int posEndTextline) Searches a possible text line break for a beautification shortened text write style.
static int	smain(java.lang.String[] sArgs, java.lang.Appendable logHelp, java.lang.Appendable logError) main gets the arguments as String, but does not catch unexpected exceptions and does not System.exit(...), use it to execute in a Java environment.
private void	wrAdoc(java.lang.CharSequence text)
private void	wrBufferToFile(java.lang.StringBuilder sb1, java.io.Writer wr1, boolean bEnd) Writes the buffer content to the file and supplements necessary line breaks for Asciidoc: A line break is set always after a ". " whereby the space is replaced by the line break.
private java.lang.String	wrClose()
private void	writeAsciidocHead()
private java.lang.String	writeTitle(XmlDataNode nodeContent)
private void	writeVmlHead()
private void	wrm(java.lang.CharSequence text)
private void	wrRep(java.lang.CharSequence line)
private void	wrReplaceLastSpace(char cNew)
private java.lang.String	wrText(java.lang.String textArg) Writes a given text from XML to VML.
private java.lang.String	wrTextAdoc(java.lang.String textArg) Writes a given text from XML to Asciidoc, but with detection of pass:[...] parts.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

cmdArgs

private final ReadOdt.CmdArgs cmdArgs

log

public final LogMessage log

xmlCfgOdt

private XmlCfg xmlCfgOdt

idxDirectToStyle

private java.util.Map<java.lang.String,StyleOdt> idxDirectToStyle

idxImgDirectToStyle

private java.util.Map<java.lang.String,StyleImg> idxImgDirectToStyle

idxIndirectStyle

private java.util.Map<java.lang.String,StyleOdt> idxIndirectStyle

This index is filled initially with a few styles which are expected, especially TextPg and TextCol, because of StyleOdt.pgBreakBefore etc. known by knowledge. The index is supplemented by found style names without direct style, which are just indirect styles. The properties of the indirect styles are not known here, because the styles.xml is not evaluated.

idxDirectOnlyStyle

private java.util.Map<java.lang.String,java.lang.String> idxDirectOnlyStyle

idxUsedStyles

private java.util.Map<java.lang.String,java.lang.String> idxUsedStyles

idxStyleToShort

private java.util.Map<java.lang.String,java.lang.String> idxStyleToShort

idxShortToStyle

private java.util.Map<java.lang.String,java.lang.String> idxShortToStyle

idxBookmarkToShort

private java.util.Map<java.lang.String,java.lang.String> idxBookmarkToShort

nodeDirectStyles

private XmlDataNode nodeDirectStyles

nodeText

private XmlDataNode nodeText

listNdTitle

private java.util.List<XmlDataNode> listNdTitle

Node text:h with the title of the document. Set in gatherAllHeading(XmlDataNode).

styleP

private StyleOdt styleP

sRefBookmark

private java.lang.String sRefBookmark

Stores a found BOOKMARK in to write it in <#label, text ....> to compare with the other refs.

sRefChapter

private java.lang.String sRefChapter

Stores a found text in text to write it in <#label, text ....>

bInCodeBlock

private boolean bInCodeBlock

bInColumns

private boolean bInColumns

lastHlinkPathToReplaced

private java.lang.String lastHlinkPathToReplaced

The last anchor which is replaced for operation arguments.

chapterNr

int[] chapterNr

If not null, then replace the first ' ' of the next output with this char.

sb

private java.lang.StringBuilder sb

Buffer able to see in debug for buffered writer for markup and asciidoc.

sba

private java.lang.StringBuilder sba

Buffer able to see in debug for buffered writer for markup and asciidoc.

wr

private java.io.Writer wr

The output channel for markup and asciidoc

wra

private java.io.Writer wra

The output channel for markup and asciidoc

wrRep

private java.io.Writer wrRep

The output channel for markup and asciidoc

sIndent

static java.lang.String sIndent

sNewlineCheck

static final java.lang.String[] sNewlineCheck

sNewlineCheckBack

static final java.lang.String[] sNewlineCheckBack

Used for search a separator position if sNewlineCheck is not found. Also used to search forward the next possible separator position after "<:@xxx.> further text.

sCheckReplace

static java.lang.String[][] sCheckReplace

Constructor Detail

ReadOdt

public ReadOdt(ReadOdt.CmdArgs cmdArgs)
        throws java.nio.charset.IllegalCharsetNameException,
               java.nio.charset.UnsupportedCharsetException,
               java.io.FileNotFoundException,
               java.io.IOException

Throws:

java.nio.charset.IllegalCharsetNameException

java.nio.charset.UnsupportedCharsetException

java.io.FileNotFoundException

java.io.IOException

Method Detail

amain

public static int amain(ReadOdt.CmdArgs args)
                 throws java.io.IOException

main for this class, with given prepared arguments Does not catch unexpected exceptions and does not System.exit(...), use it to execute in a Java environment.

Parameters:

args - prepared cmd line arguments

Returns:

0 if all is ok

Throws:

java.io.IOException

java.lang.Exception - if unexpected.

smain

public static int smain(java.lang.String[] sArgs,
                        java.lang.Appendable logHelp,
                        java.lang.Appendable logError)
                 throws java.io.IOException

main gets the arguments as String, but does not catch unexpected exceptions and does not System.exit(...), use it to execute in a Java environment.

Parameters:

sArgs -

Returns:

0 if all is ok

Throws:

java.io.IOException

java.lang.Exception - if unexpected.

main

public static void main(java.lang.String[] sArgs)

main for UFBglConv, invoked from cmd line. Catch and report an unexpected exceptions via console error output, returns an exit code

Parameters:

sArgs -

execute

private java.lang.String execute()
                          throws java.io.IOException

Throws:

java.io.IOException

defineIndirectStyles

private void defineIndirectStyles()

readXml

private java.lang.String readXml(java.lang.Object data,
                                 java.io.File fInOdg)
                          throws java.io.IOException

Reads completely the content.xml from the given odg file and stores the data in the returned instance.

Parameters:

fInOdg - The file to read

Returns:

the read data from XML

Throws:

java.io.IOException - On file read problems

readOdgxmlWriteAsciidoc

private java.lang.String readOdgxmlWriteAsciidoc(XmlDataNode ndRootOdg)
                                          throws java.io.IOException

This is the main routine after reading the whole XML file content.xml from odg.

Parameters:

ndRootOdg - the root node of the content.xml

Returns:

Throws:

java.io.IOException

gatherDirectStyles

private java.lang.String gatherDirectStyles(XmlDataNode nodeDirectStyles)

writeAsciidocHead

private void writeAsciidocHead()
                        throws java.io.IOException

Throws:

java.io.IOException

writeVmlHead

private void writeVmlHead()
                   throws java.io.IOException

Throws:

java.io.IOException

gatherAllHeading

private java.lang.String gatherAllHeading(XmlDataNode ndText)

writeTitle

private java.lang.String writeTitle(XmlDataNode nodeContent)
                             throws java.io.IOException

Throws:

java.io.IOException

gatherContent

protected java.lang.String gatherContent(XmlDataNode nodeContent,
                                         int deepnessSection)
                                  throws java.io.IOException

Throws:

java.io.IOException

gatherHeader

private java.lang.String gatherHeader(XmlDataNode node)
                               throws java.io.IOException

Writes a header as

 '''
 [#label]
 ==== Chapter title
 

Parameters:

node - text:h or maybe text:p node

Returns:

Throws:

java.io.IOException

gathWrParagraph

private java.lang.String gathWrParagraph(XmlDataNode node,
                                         int indent,
                                         java.lang.String[] stylesExpected)
                                  throws java.io.IOException

Writes an paragraph from XML to VMU It does not write a newline after the paragraph text because TODO

Parameters:

node -

indent -

stylesExpected -

Returns:

Throws:

java.io.IOException

gathWrText

private java.lang.String gathWrText(XmlDataNode nodeP)
                             throws java.io.IOException

This is all inside a paragraph.

Parameters:

nodeP -

Throws:

java.io.IOException

gathWrSpan

private java.lang.String gathWrSpan(XmlDataNode node,
                                    StyleOdt style)
                             throws java.io.IOException

span is for any text part with specific formatting. Check whether it is

• Quotation or Citation, then write __text__
• Strong_20_Emphasis, then write **text**
• Emphasis, then write __**text**__
• ccode, then write `text`
• any other style, then write [STYLE]`text`

The text it is checked whether it contains special strings which are interpreting by Asciidoc, if yes then

• either `+text+` is written if '+' is not member of text,
• or `pass:[text]` is written if text does not contain ']'.
• or a combination is written with `+text+pass:[text2]` to prevent conflicts.

Parameters:

node -

style -

Returns:

Throws:

java.io.IOException

gathWrList

private java.lang.String gathWrList(XmlDataNode nodeList)
                             throws java.io.IOException

Throws:

java.io.IOException

gathWrListItemOrNumbHeader

private java.lang.String gathWrListItemOrNumbHeader(XmlDataNode nodeItem)
                                             throws java.io.IOException

Gather an item in a list, not known what is it. It may be a numbered header, an image, or a really list item.

Parameters:

nodeItem -

Returns:

Throws:

java.io.IOException

gathWrListItem

private java.lang.String gathWrListItem(XmlDataNode ndItem)
                                 throws java.io.IOException

Throws:

java.io.IOException

gathWrTable

private java.lang.String gathWrTable(XmlDataNode ndTable)
                              throws java.io.IOException

Throws:

java.io.IOException

gathWrTableOfContent

private java.lang.String gathWrTableOfContent(XmlDataNode node)
                                       throws java.io.IOException

Throws:

java.io.IOException

gathWrFrameOrImage

private java.lang.String gathWrFrameOrImage(XmlDataNode ndParagr,
                                            XmlDataNode ndFrame,
                                            java.lang.String styleFrameRaw,
                                            boolean bCaption)
                                     throws java.io.IOException

Throws:

java.io.IOException

gathWrXlink

private java.lang.String gathWrXlink(XmlDataNode ndA)
                              throws java.io.IOException

Throws:

java.io.IOException

gathWrXRef

private char gathWrXRef(XmlDataNode nodeXref)
                 throws java.io.IOException

Gathers a <text:bookmark-ref ...>, writes in Adoc as <<#label>>.

Parameters:

nodeXref -

Returns:

a char ' ' or '@' due tu the text:reference-format="chapter" or "page" to decide what to do with the text following, ignore space and ", page"

Throws:

java.io.IOException

getBaseStyle

private StyleOdt getBaseStyle(java.lang.String styleNameArg)

getNumber

private int getNumber(java.lang.String sNr,
                      int defaultNr)

getBookmarkShort

java.lang.String getBookmarkShort(XmlDataNode node,
                                  java.lang.String sAttribKey)

getAttribNumber

private int getAttribNumber(XmlDataNode node,
                            java.lang.String key,
                            int defaultNr)

wrText

private java.lang.String wrText(java.lang.String textArg)
                         throws java.io.IOException

Writes a given text from XML to VML. If the text contains specific designations given in WriteOdt.sTextReplace such as non-breaking spaces or the backslash then the adequate transcription is used. This is in the same kind also in the WriteOdg direction.

Parameters:

text - The text from XML

Returns:

null

Throws:

java.io.IOException

wrTextAdoc

private java.lang.String wrTextAdoc(java.lang.String textArg)
                             throws java.io.IOException

Writes a given text from XML to Asciidoc, but with detection of pass:[...] parts. If the text contains specific designations given in WriteOdt.sTextCtrlCommon then either +text+ or pass:[text] is translated to Asciidoc with the adequate text parts. This can/should be given in the same kind in the WriteOdg direction.

Parameters:

text - The text from XML

Returns:

null

Throws:

java.io.IOException

wrReplaceLastSpace

private void wrReplaceLastSpace(char cNew)

wrAdoc

private void wrAdoc(java.lang.CharSequence text)
             throws java.io.IOException

Throws:

java.io.IOException

wrm

private void wrm(java.lang.CharSequence text)
          throws java.io.IOException

Throws:

java.io.IOException

searchLineBreak

private int searchLineBreak(boolean[] bInsideRef,
                            java.lang.StringBuilder sb1,
                            int posStart,
                            int posEndFocus,
                            int posEndTextSentence,
                            int posEndTextline)

Searches a possible text line break for a beautification shortened text write style.

Parameters:

sb1 - The whole buffer

posStart - focus from here.

posEndFocus - spread span from start of the focus to detect also <:@....> as long span.

posEndTextline - spread or span from start ot length of a normal sentence till ". " or alternativel till ", " etc.

Returns:

wrBufferToFile

private void wrBufferToFile(java.lang.StringBuilder sb1,
                            java.io.Writer wr1,
                            boolean bEnd)
                     throws java.io.IOException

Writes the buffer content to the file and supplements necessary line breaks for Asciidoc:

• A line break is set always after a ". " whereby the space is replaced by the line break.
• If the resulting line is longer than TDODO then search backward to a ", " TODO

Parameters:

bEnd - true then writes all, false then prevent the last content without dot on end. if false, further output comes which is regarded later.

Throws:

java.io.IOException

wrRep

private void wrRep(java.lang.CharSequence line)
            throws java.io.IOException

Throws:

java.io.IOException

wrClose

private java.lang.String wrClose()
                          throws java.io.IOException

Throws:

java.io.IOException