org.vishia.odt.readOdt

Class ReadOdt

java.lang.Object

org.vishia.odt.readOdt.TranslateOdtCommon

org.vishia.odt.readOdt.ReadOdt

public class ReadOdt
extends TranslateOdtCommon

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ReadOdt.CmdArgs
private static class	ReadOdt.GathWrText Data for gathWrText(XmlDataNode, char) and its inner operation.
(package private) static class	ReadOdt.LabelRef

Nested classes/interfaces inherited from class org.vishia.odt.readOdt.TranslateOdtCommon

TranslateOdtCommon.CommonArgs

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	bInCodeBlock
private boolean	bInColumns
private boolean	bIsInclude Flag that a included file is read.
private boolean	bTitleFound Set to true if the title is found in odt.
private ReadOdt.CmdArgs	cmdArgs
private int	ctLabel Counter for non found, automatic numbered labels.
(package private) java.lang.IllegalArgumentException	excTOCnotUpdated The output channel for markup and asciidoc
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.
private java.util.Map<java.lang.String,ReadOdt.LabelRef>	idxLabelRef All found label references in Table of contents with internal reference for header, VML-Label, title text and page.
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.lang.String	lastXref
private java.util.List<ReadOdt.LabelRef>	listLabelRef
private java.util.List<org.vishia.xmlReader.XmlDataNode>	listNdTitle Node text:h with the title of the document.
private org.vishia.xmlReader.XmlDataNode	nodeDirectStyles
private org.vishia.xmlReader.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
private java.lang.String	sRefChapter Stores a found text in text to write it in <#label, text ....>
private StyleOdt	styleP
static java.lang.String	version Version, history and license.
private java.io.Writer	wr
private java.io.Writer	wra
private java.io.Writer	wrFrame
private java.io.Writer	wrRep
private org.vishia.xmlReader.XmlCfg	xmlCfgOdt

Fields inherited from class org.vishia.odt.readOdt.TranslateOdtCommon

javadocLabel, log

Constructor Summary

Constructors

Constructor and Description
ReadOdt(ReadOdt.CmdArgs cmdArgs) Note: close of LogMessageStream is in amain(CmdArgs) where this instance is constructed.

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 boolean	checkWrCrossRefPdf(ReadOdt.GathWrText thizi, org.vishia.xmlReader.XmlDataNode node1, java.util.ListIterator<org.vishia.xmlReader.XmlDataNode> iterNodes) This operation is called if a a:href with ">>>" as text is found.
private void	defineIndirectStyles() This operation defines the indirect styles which should be general known with its specific properties.
int	execute()
private void	executeViewDiff() Invokes the process in OS to show the Diff Tool adequate the option '-difftool:executable'
private void	gatherAllBookmarksInHeader(org.vishia.xmlReader.XmlDataNode ndHead)
private java.lang.String	gatherAllHeading(org.vishia.xmlReader.XmlDataNode ndText)
protected java.lang.String	gatherContent(org.vishia.xmlReader.XmlDataNode nodeContent, int deepnessSection)
private java.lang.String	gatherDirectStyles(org.vishia.xmlReader.XmlDataNode nodeDirectStyles) Gather all direct styles in the document.
private void	gathImageInFrame(org.vishia.xmlReader.XmlDataNode ndParagr, org.vishia.xmlReader.XmlDataNode nodeFrame, boolean bImgCaption)
private void	gathWrCodeInclude(org.vishia.xmlReader.XmlDataNode ndCaption, java.util.ListIterator<org.vishia.xmlReader.XmlDataNode> iterParentNodes)
private java.lang.String	gathWrFrameOrImage(org.vishia.xmlReader.XmlDataNode ndParagr, org.vishia.xmlReader.XmlDataNode ndFrame, java.lang.String styleFrameRaw, boolean bCaption)
private java.lang.String	gathWrHeader(org.vishia.xmlReader.XmlDataNode ndHeader, boolean bInInclude) Writes a header as
private java.lang.String	gathWrList(org.vishia.xmlReader.XmlDataNode nodeList)
private java.lang.String	gathWrListItem(org.vishia.xmlReader.XmlDataNode ndItem)
private java.lang.String	gathWrListItemOrNumbHeader(org.vishia.xmlReader.XmlDataNode nodeItem) Gather an item in a list, not known what is it.
private java.lang.String	gathWrParagraph(org.vishia.xmlReader.XmlDataNode node, java.util.ListIterator<org.vishia.xmlReader.XmlDataNode> iterParentNodes, 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	gathWrTable(org.vishia.xmlReader.XmlDataNode ndTable)
private java.lang.String	gathWrTableOfContent(org.vishia.xmlReader.XmlDataNode node)
private java.lang.String	gathWrText(org.vishia.xmlReader.XmlDataNode nodeP, char cSpanParagr) This is all inside a paragraph.
private java.lang.String	gathWrTextNode(ReadOdt.GathWrText thizi, org.vishia.xmlReader.XmlDataNode node, java.util.ListIterator<org.vishia.xmlReader.XmlDataNode> iterNodes, char cSpanParagr) Inner operation for one text node.
private java.lang.String	gathWrTextNodeLink(ReadOdt.GathWrText thizi, org.vishia.xmlReader.XmlDataNode node1, java.util.ListIterator<org.vishia.xmlReader.XmlDataNode> iterNodes, char cSpanParagr) This is called for a <text:a>...
private java.lang.String	gathWrXlink(org.vishia.xmlReader.XmlDataNode ndA, java.util.ListIterator<org.vishia.xmlReader.XmlDataNode> iterNodes, boolean bwrm) writes the appropriate ZmL for a <text:a> which is a hyperlink in odg.
private char	gathWrXRef(org.vishia.xmlReader.XmlDataNode nodeXref) Gathers a <text:bookmark-ref ...>, writes in Adoc as <<#label>>.
private int	getAttribNumber(org.vishia.xmlReader.XmlDataNode node, java.lang.String key, int defaultNr)
private StyleOdt	getBaseStyle(java.lang.String styleNameArg, char[] cStyleSpan) With the given direct style name the based indirect style is gotten.
private int	getNumber(java.lang.String sNr, int defaultNr)
private java.lang.String	getTextXml(org.vishia.xmlReader.XmlDataNode nodep, boolean bSubnodes) Gets the text inside a node, also regarding <text:s...> and <text:t for spaces and tabs And also searching in sub nodes.
private void	getTextXml(org.vishia.xmlReader.XmlDataNode nodep, java.lang.StringBuilder sbText, boolean bSubnodes) Inner operation for Get text from a text XML node from odt: content.xml with special handling called from getTextXml(XmlDataNode, boolean) and recursively from itself.
static void	main(java.lang.String[] sArgs) main for UFBglConv, invoked from cmd line.
private void	newLabelRef(java.util.List<java.lang.String> listBookmark, java.lang.String sBookmarkTOC, java.lang.String sBookmarkRef)
java.lang.String	readOdgxmlWriteZmL(org.vishia.xmlReader.XmlDataNode ndRootOdg) This is the main routine after reading the whole XML file content.xml from odg.
private java.lang.String	readXml(org.vishia.xmlReader.XmlDataNode data, java.io.File fInOdt) Reads completely the content.xml from the given odt file <::readXml.> and stores the data in the data instance.
private static java.lang.CharSequence	replaceToBackslashSubscription(java.lang.CharSequence textArg)
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.
private void	showArguments()
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, java.lang.String[] s2, boolean bEnd) Writes the buffer content to the file and supplements necessary line breaks for Asciidoc: A line break is set always after a ".
private java.lang.String	wrClose()
private void	writeAsciidocHead()
private void	writeLabelRef()
private java.lang.String	writeSpan(java.util.List<org.vishia.xmlReader.XmlDataNode> ndsSpan, StyleOdt style) span is for any text part with specific formatting.
private java.lang.String	writeTitle() The title should always be written as first.
private void	writeZmlHead()
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 ZmL.
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 org.vishia.odt.readOdt.TranslateOdtCommon

getLinkFileFromURL, getLinkNameFromURL, searchForReplacingLinkOperationLabel, writeBackupFile

Methods inherited from class java.lang.Object

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

Field Detail

version

public static final java.lang.String version

Version, history and license.

• 2024-12-13 Hartmut: enhancement for Linux usage: gathWrHeader(XmlDataNode, boolean) now also writes the Linux shell script lines in included files.
• 2024-05-29 Hartmut creation. Necessity to handle Libre Office writer content.

Copyright/Copyleft: For this source the LGPL Lesser General Public License, published by the Free Software Foundation is valid. It means:

1. You can use this source without any restriction for any desired purpose.
2. You can redistribute copies of this source to everybody.
3. Every user of this source, also the user of redistribute copies with or without payment, must accept this license for further using.
4. But the LPGL ist not appropriate for a whole software product, if this source is only a part of them. It means, the user must publish this part of source, but don't need to publish the whole source of the own product.
5. You can study and modify (improve) this source for own using or for redistribution, but you have to license the modified sources likewise under this LGPL Lesser General Public License. You mustn't delete this Copyright/Copyleft inscription in this source file.

If you are intent to use this sources without publishing its usage, you can get a second license subscribing a special contract with the author.

See Also:

Constant Field Values

cmdArgs

private final ReadOdt.CmdArgs cmdArgs

xmlCfgOdt

private org.vishia.xmlReader.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

idxLabelRef

private java.util.Map<java.lang.String,ReadOdt.LabelRef> idxLabelRef

All found label references in Table of contents with internal reference for header, VML-Label, title text and page.

listLabelRef

private java.util.List<ReadOdt.LabelRef> listLabelRef

ctLabel

private int ctLabel

Counter for non found, automatic numbered labels.

nodeDirectStyles

private org.vishia.xmlReader.XmlDataNode nodeDirectStyles

nodeText

private org.vishia.xmlReader.XmlDataNode nodeText

listNdTitle

private java.util.List<org.vishia.xmlReader.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 ....>

bIsInclude

private boolean bIsInclude

Flag that a included file is read. Used for conditional writeLabelRef(), not for included files..

bTitleFound

private boolean bTitleFound

Set to true if the title is found in odt. All content before is not written to ZmL. The title is necessary. The content before the title is the left empty page or such, automatically created, not as part of ZmL source text.

bInCodeBlock

private boolean bInCodeBlock

bInColumns

private boolean bInColumns

lastHlinkPathToReplaced

private java.lang.String lastHlinkPathToReplaced

The last anchor which is replaced for operation arguments.

lastXref

private java.lang.String lastXref

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.

excTOCnotUpdated

java.lang.IllegalArgumentException excTOCnotUpdated

The output channel for markup and asciidoc

wrFrame

private java.io.Writer wrFrame

wr

private java.io.Writer wr

wra

private java.io.Writer wra

wrRep

private java.io.Writer wrRep

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

Note: close of LogMessageStream is in amain(CmdArgs) where this instance is constructed. This closes also a given TranslateOdtCommon.CommonArgs.fLog because of call LogMessageStream(java.io.OutputStream, java.io.OutputStream, Appendable, Appendable, boolean, Charset) with trut for argument closeOnClose. * @param cmdArgs

Throws:

java.nio.charset.IllegalCharsetNameException

java.nio.charset.UnsupportedCharsetException

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

public int execute()
            throws java.io.IOException

Returns:

Throws:

java.io.IOException

showArguments

private void showArguments()

executeViewDiff

private void executeViewDiff()

Invokes the process in OS to show the Diff Tool adequate the option '-difftool:executable'

defineIndirectStyles

private void defineIndirectStyles()

This operation defines the indirect styles which should be general known with its specific properties. For example the "Heading 1" with internal name "Heading_20_1" is knwon with page break. Then an additional page break information is not generated. Same is for "TextPg", "TextCol".
But for styles which are not found here, this is for example "Heading_20_2" etc. the information <::pageBreak.> is generated in ZmL and internally the style is stored as "NAMEPg", as also for "NAMECol".

readXml

private java.lang.String readXml(org.vishia.xmlReader.XmlDataNode data,
                                 java.io.File fInOdt)
                          throws java.io.IOException

Reads completely the content.xml from the given odt file <::readXml.> and stores the data in the data instance.

Parameters:

data - The root node for all XML data

fInOdt - the odt file is a zip file

Returns:

null or an error message

Throws:

java.io.IOException - for file operation

readOdgxmlWriteZmL

public java.lang.String readOdgxmlWriteZmL(org.vishia.xmlReader.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(org.vishia.xmlReader.XmlDataNode nodeDirectStyles)

Gather all direct styles in the document. It is only interesting for some dedicated properties such as page break or column break which is added to a indirect style. The direct styles are stored in idxDirectOnlyStyle. The transfer from a direct style to the (indirect) parent style is stored in idxDirectToStyle for non images and idxImgDirectToStyle for images.

Parameters:

nodeDirectStyles - The direct style node.

Returns:

writeAsciidocHead

private void writeAsciidocHead()
                        throws java.io.IOException

Throws:

java.io.IOException

writeZmlHead

private void writeZmlHead()
                   throws java.io.IOException

Throws:

java.io.IOException

gatherAllHeading

private java.lang.String gatherAllHeading(org.vishia.xmlReader.XmlDataNode ndText)

gatherAllBookmarksInHeader

private void gatherAllBookmarksInHeader(org.vishia.xmlReader.XmlDataNode ndHead)

newLabelRef

private void newLabelRef(java.util.List<java.lang.String> listBookmark,
                         java.lang.String sBookmarkTOC,
                         java.lang.String sBookmarkRef)

writeTitle

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

The title should always be written as first. The document should only contain one paragraph formatted as title on top. This assures same output for included files as also generate from an odt from an included file.

Parameters:

nodeContent -

Returns:

Throws:

java.io.IOException

gatherContent

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

Throws:

java.io.IOException

gathWrHeader

private java.lang.String gathWrHeader(org.vishia.xmlReader.XmlDataNode ndHeader,
                                      boolean bInInclude)
                               throws java.io.IOException

Writes a header as

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

Parameters:

ndHeader - text:h or maybe text:p node

bInInclude - false for the main file, true if write a file.ZmL to include after '__PART_' label ??? if read first time, true if read recursively to write the same header without the '__PART_' label in the include file.

Returns:

Throws:

java.io.IOException

gathWrParagraph

private java.lang.String gathWrParagraph(org.vishia.xmlReader.XmlDataNode node,
                                         java.util.ListIterator<org.vishia.xmlReader.XmlDataNode> iterParentNodes,
                                         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

gathImageInFrame

private void gathImageInFrame(org.vishia.xmlReader.XmlDataNode ndParagr,
                              org.vishia.xmlReader.XmlDataNode nodeFrame,
                              boolean bImgCaption)
                       throws java.io.IOException

Throws:

java.io.IOException

gathWrCodeInclude

private void gathWrCodeInclude(org.vishia.xmlReader.XmlDataNode ndCaption,
                               java.util.ListIterator<org.vishia.xmlReader.XmlDataNode> iterParentNodes)
                        throws java.io.IOException

Throws:

java.io.IOException

gathWrText

private java.lang.String gathWrText(org.vishia.xmlReader.XmlDataNode nodeP,
                                    char cSpanParagr)
                             throws java.io.IOException

This is all inside a paragraph.

Parameters:

nodeP -

cSpanParagr - If not 0 then the whole paragraph is marked with italic or bold, cStyleSpan is Q, E, S Then it writes non span parts as such span.

Returns:

Throws:

java.io.IOException

gathWrTextNode

private java.lang.String gathWrTextNode(ReadOdt.GathWrText thizi,
                                        org.vishia.xmlReader.XmlDataNode node,
                                        java.util.ListIterator<org.vishia.xmlReader.XmlDataNode> iterNodes,
                                        char cSpanParagr)
                                 throws java.io.IOException

Inner operation for one text node.

• This operation calls itself for the ReadOdt.GathWrText.nodeLast it it is set in specific conditions. That's why it is extracted to handle one node.

Parameters:

thizi - the data class. Note: If this operation is part of the data class, then the access to ReadOdt instance data are more complex. It is more simple and understandable to use this 'thizi' for specific data.

node - The current node.

cSpanParagr -

Returns:

null or an error message.

Throws:

java.io.IOException

checkWrCrossRefPdf

private boolean checkWrCrossRefPdf(ReadOdt.GathWrText thizi,
                                   org.vishia.xmlReader.XmlDataNode node1,
                                   java.util.ListIterator<org.vishia.xmlReader.XmlDataNode> iterNodes)
                            throws java.io.IOException

This operation is called if a a:href with ">>>" as text is found. Supposed it is a link to a document in the same suite.

Parameters:

thizi -

node1 -

iterNodes -

Returns:

false if it has not the expected structure.

Throws:

java.io.IOException

gathWrTextNodeLink

private java.lang.String gathWrTextNodeLink(ReadOdt.GathWrText thizi,
                                            org.vishia.xmlReader.XmlDataNode node1,
                                            java.util.ListIterator<org.vishia.xmlReader.XmlDataNode> iterNodes,
                                            char cSpanParagr)
                                     throws java.io.IOException

This is called for a <text:a>... node, which is a hyperlink to outside. If is checked, if the node has '>>' as text or "Reference" as style, then following nodes are gathered which builds a combined link on odt, which is presented as one entry in ZmL.
If this condition is not true, the link are presented with gathWrXlink(XmlDataNode, ListIterator, boolean).
See WriteOdt#writeChapterRefExtern(String, LabelRef)

Parameters:

thizi -

node1 -

cSpanParagr -

Returns:

Throws:

java.io.IOException

getTextXml

private java.lang.String getTextXml(org.vishia.xmlReader.XmlDataNode nodep,
                                    boolean bSubnodes)

Gets the text inside a node, also regarding <text:s...> and <text:t for spaces and tabs And also searching in sub nodes. Whereby the tag of sub nodes is ignored. This is usefull for <text:span... whereby span in span should ignored (it is only direct formatting).

• Spaces are written in odt with <text:s text:c="12"/> contains number of spaces (0x20)
• Tabs are written in odt with <text:tab/> translated to 0x09
• Soft line breaks in a paragraph are written in odt with <text:line-break/> translated to 0x0a
• Sub nodes are handled by recursively call of this operation, add their texts.

It calls getTextXml(XmlDataNode, StringBuilder, boolean) which does the work. But if the node contains immediately text, this is returned.

Parameters:

nodep - the given node

bSubnodes - true then get the text also from all sub nodes, usefully for <span...

Returns:

getTextXml

private void getTextXml(org.vishia.xmlReader.XmlDataNode nodep,
                        java.lang.StringBuilder sbText,
                        boolean bSubnodes)

Inner operation for Get text from a text XML node from odt: content.xml with special handling called from getTextXml(XmlDataNode, boolean) and recursively from itself.

Parameters:

nodep - The text containing XmlDataNode node

sbText - Here the text is added to, a StringBuilder

bSubnodes - only on true read the text from sub nodes and insert it immediately.

writeSpan

private java.lang.String writeSpan(java.util.List<org.vishia.xmlReader.XmlDataNode> ndsSpan,
                                   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:

ndsSpan - all nodes for this span entry

style - The common style of maybe more as one span regions one after another, only the base style.

Returns:

Throws:

java.io.IOException

gathWrList

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

Throws:

java.io.IOException

gathWrListItemOrNumbHeader

private java.lang.String gathWrListItemOrNumbHeader(org.vishia.xmlReader.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(org.vishia.xmlReader.XmlDataNode ndItem)
                                 throws java.io.IOException

Throws:

java.io.IOException

gathWrTable

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

Throws:

java.io.IOException

gathWrTableOfContent

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

Throws:

java.io.IOException

gathWrFrameOrImage

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

Throws:

java.io.IOException

gathWrXlink

private java.lang.String gathWrXlink(org.vishia.xmlReader.XmlDataNode ndA,
                                     java.util.ListIterator<org.vishia.xmlReader.XmlDataNode> iterNodes,
                                     boolean bwrm)
                              throws java.io.IOException

writes the appropriate ZmL for a <text:a> which is a hyperlink in odg. It regards a bookmark ref link.

Parameters:

ndA -

iterNodes -

Returns:

Throws:

java.io.IOException

gathWrXRef

private char gathWrXRef(org.vishia.xmlReader.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,
                              char[] cStyleSpan)

With the given direct style name the based indirect style is gotten. If the indirect style stored in idxIndirectStyle has the same properties for page break, column break ... then only the indirect style is returned. Properties of the direct style are ignored. But if the direct style as definitively properties which are important, then the direct style is returned. The name of the direct style is completed with the specific properties, and the returned direct style is stored in idxIndirectStyle as quasi indirect style. It helps to save space if the same properties are given for another direct style (from view of LibreOffice internally) but based on the same indirect style.

Parameters:

styleNameArg -

Returns:

getNumber

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

getAttribNumber

private int getAttribNumber(org.vishia.xmlReader.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 ZmL. 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

replaceToBackslashSubscription

private static java.lang.CharSequence replaceToBackslashSubscription(java.lang.CharSequence textArg)

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,
                            java.lang.String[] s2,
                            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

writeLabelRef

private void writeLabelRef()

wrClose

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

Throws:

java.io.IOException