org.vishia.odt.readOdt

Class TranslateOdtCommon

java.lang.Object

org.vishia.odt.readOdt.TranslateOdtCommon

Direct Known Subclasses:

ReadOdt, WriteOdt

abstract class TranslateOdtCommon
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	TranslateOdtCommon.CommonArgs

Field Summary

Fields

Modifier and Type	Field and Description
(package private) GetJavadocLabel	javadocLabel
org.vishia.msgDispatch.LogMessage	log Central possibility to write messages.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	TranslateOdtCommon(org.vishia.msgDispatch.LogMessage log)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getLinkFileFromURL(java.lang.String sURL) Gets the file name of the linked file inside a URL, without extension.
java.lang.String	getLinkNameFromURL(java.lang.String sURL) Gets the name of the linked file inside a URL, without extension.
protected java.lang.String	searchForReplacingLinkOperationLabel(java.lang.String sHtml, java.lang.String sTarget, java.io.File dirBase) Replace the sTarget with the correct javadoc-operation target if it is an operation written with '(...)', or also search the given javadoc-operation and check whether it is unique.
protected void	writeBackupFile(java.io.File fOut, java.io.File dirBack, java.lang.String sBackExtArg, TranslateOdtCommon.CommonArgs args) Writes a backup file for the given output file to generate if the fOut exists.

Methods inherited from class java.lang.Object

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

Field Detail

log

public final org.vishia.msgDispatch.LogMessage log

Central possibility to write messages. Can be in file, on screen.

javadocLabel

final GetJavadocLabel javadocLabel

Constructor Detail

TranslateOdtCommon

protected TranslateOdtCommon(org.vishia.msgDispatch.LogMessage log)

Method Detail

searchForReplacingLinkOperationLabel

protected java.lang.String searchForReplacingLinkOperationLabel(java.lang.String sHtml,
                                                                java.lang.String sTarget,
                                                                java.io.File dirBase)

Replace the sTarget with the correct javadoc-operation target if it is an operation written with '(...)', or also search the given javadoc-operation and check whether it is unique. This operation should be only called either if the javadoc-operation is written with "(...)" (ZmL to odt) or if the javadoc-operation is given and should be tested whether it is unique (odt to ZmL)

• With 'sHtml', the proper entry in GetJavadocLabel.idxHtmlFilesAnchors will be gotten, or the html file will be parsed now, and entered in this index.
• The 'name' (java-identifier) from sTarget is extracted, sTarget should start with a name either from an operation or also it is the name of a field.
• with the gotten 'idxOperations' and the 'name' the proper anchor (inner link target) is searched. if it is found, this is the proper target for the link which is returned.
• If it is not found, but it is not unique, the '?' on end is the signal to preserve the link while converting odt to ZmL
• If it is not found, the sTarget is returned to use unchanged.

Parameters:

sHtml -

sTarget -

dirBase -

Returns:

sTarget itself or the correct operation target.

getLinkNameFromURL

public java.lang.String getLinkNameFromURL(java.lang.String sURL)

Gets the name of the linked file inside a URL, without extension.

Parameters:

sURL - for example "../name.ext#Label"

Returns:

for example "name"

getLinkFileFromURL

public java.lang.String getLinkFileFromURL(java.lang.String sURL)

Gets the file name of the linked file inside a URL, without extension.

Parameters:

sURL - for example "../name.ext#Label"

Returns:

for example "name.ext"

writeBackupFile

protected void writeBackupFile(java.io.File fOut,
                               java.io.File dirBack,
                               java.lang.String sBackExtArg,
                               TranslateOdtCommon.CommonArgs args)

Writes a backup file for the given output file to generate if the fOut exists. This is also important to compare the generated ZmL files as also for data recovery on unexpected faults. Depending from TranslateOdtCommon.CommonArgs.bBackAll an existing backup file will be renamed before with a current number testing all existing files.

Parameters:

fOut - The output file, if exists make a copy

args - arguments