org.vishia.odt.readOdt

Class TranslateOdtCommon.CommonArgs

java.lang.Object

org.vishia.util.Arguments

org.vishia.odt.readOdt.TranslateOdtCommon.CommonArgs

Direct Known Subclasses:

ReadOdt.CmdArgs, WriteOdt.CmdArgs

Enclosing class:

TranslateOdtCommon

protected abstract static class TranslateOdtCommon.CommonArgs
extends org.vishia.util.Arguments

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class org.vishia.util.Arguments

org.vishia.util.Arguments.Argument, org.vishia.util.Arguments.SetArgument

Field Summary

Fields

Modifier and Type	Field and Description
(package private) org.vishia.util.Arguments.Argument[]	argListCommon
(package private) boolean	bBackAll If given as true by "-backall:dir", then rename all existing backup files with a number (as "file.99.vml") to preserve all versions.
(package private) java.io.File	dirDbg
(package private) java.io.File	dirIn The input file to read, either odt or ZmL.
java.io.File	dirLabel Directory of the label file.
(package private) java.io.File	dirOutBack If set then create backup files for the current file.ZmL before writing the new one.
(package private) java.io.File	dirZml Directory (relative to current directory where the *.odt invokes this conversion) where the Zml and also label files are stored.
(package private) java.io.File	fIn The input file to read, either odt or ZmL.
(package private) java.io.OutputStream	fLog If not null then write the log output beside stdout, stderr in this file.
(package private) java.io.File	fReport If not null then write some report info.
(package private) java.lang.String	sCurrDir
protected java.lang.String	sDirSrcCmpn This should be present the component's directory in the 'src/component'.
(package private) java.lang.String	sExtOut
(package private) java.lang.String	sExtRefBesideHtml Contains the extension for reference links beside the own document from -labels.
(package private) java.lang.String	sExtRefBesidePdf Contains the extension for reference links beside the own document from -labels.
(package private) java.lang.String	sExtZmL Used extension for the ZmL file.
(package private) java.lang.String	sNameDoc This is either the whole name of fIn or the right part after a "++" in the name, without extension.
java.lang.String	sNameLabel "*" if * is written, read all files.
(package private) java.lang.String	sRefBesideHtml Contains a relative (or possible absolute) or also a URL path where foreign linked bookmark files are placed.
(package private) java.lang.String	sRefBesideInWWWHtml Contains the www URL path where the files with references to bookmarks to documents beside are placed additional to the given #-sRefBesidePdf It has the form "https://myPage.org/path/*.ext" where ".ext" may be ".html" to link to html files.
(package private) java.lang.String	sRefBesideInWWWPdf Contains the www URL path where the files with references to bookmarks to documents beside are placed additional to the given #-sRefBesidePdf It has the form "https://myPage.org/path/*.ext" where ".ext" may be ".html" to link to html files.
(package private) java.lang.String	sRefBesidePdf Contains a relative (or possible absolute) or also a URL path where foreign linked bookmark files are placed.

Fields inherited from class org.vishia.util.Arguments

aboutInfo, exitCodeArgError, helpInfo, sVersion

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CommonArgs()

Method Summary

Modifier and Type	Method and Description
protected TranslateOdtCommon.CommonArgs.DirName	getDirNameReplaceSrcCmpn(java.lang.String val) Combines the given 'val' with sDirSrcCmpn to a directory and extract maybe the given extension.
protected java.io.File	getDirRepaceSrcCmpn(java.lang.String sDirArg)
void	setCurrDir()

Methods inherited from class org.vishia.util.Arguments

aboutInfo, addArg, addArgs, checkArg, checkArgVal, errMsg, getEnv, getLogLevel, getLogPath, parseArgs, parseArgs, readArguments, readConfig, readConfig, replaceEnv, showHelp, testArgument, testConsistence

Methods inherited from class java.lang.Object

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

Field Detail

sCurrDir

java.lang.String sCurrDir

dirIn

java.io.File dirIn

The input file to read, either odt or ZmL.

fIn

java.io.File fIn

The input file to read, either odt or ZmL.

fReport

java.io.File fReport

If not null then write some report info.

fLog

java.io.OutputStream fLog

If not null then write the log output beside stdout, stderr in this file. Argument -log:path/to.

sDirSrcCmpn

protected java.lang.String sDirSrcCmpn

This should be present the component's directory in the 'src/component'.

• On ReadOdt argument '-odt:path/to/docu++file.odt' it is set with the left part of the odt file name before '++'.
• or it is set to null if the file does not contain '++'.
• On WriteOdt it is set with the directory name of the '--dirCmpn=path/to/component', usual '--dirCmpn=../..'
• or remains null if this argument is not given.

This variable is used:

• On ReadOdt to determine paths in '-ZmL:src/default++/*.ZmL' replacing the '++'
• On WriteOdt to determine a first part of the odt output file <&sDirCmpn>++<&sNameDoc>.odt

null or the first part of the name of fIn if this name contains "++" in mid. The ++ is adequate a separator but admissible for file names.

sNameDoc

java.lang.String sNameDoc

This is either the whole name of fIn or the right part after a "++" in the name, without extension. It is used to build the name of the ZmL file as <&sNameDoc>.ZmL

sExtOut

java.lang.String sExtOut

dirZml

java.io.File dirZml

Directory (relative to current directory where the *.odt invokes this conversion) where the Zml and also label files are stored.

sExtZmL

java.lang.String sExtZmL

Used extension for the ZmL file.

dirOutBack

java.io.File dirOutBack

If set then create backup files for the current file.ZmL before writing the new one.

bBackAll

boolean bBackAll

If given as true by "-backall:dir", then rename all existing backup files with a number (as "file.99.vml") to preserve all versions. Set to false by "-back:dir"

dirLabel

public java.io.File dirLabel

Directory of the label file.

sNameLabel

public java.lang.String sNameLabel

"*" if * is written, read all files.

sRefBesideHtml

java.lang.String sRefBesideHtml

Contains a relative (or possible absolute) or also a URL path where foreign linked bookmark files are placed. It has the form "path/*.ext" where ".ext" may be ".html" to link to html files.

sRefBesidePdf

java.lang.String sRefBesidePdf

Contains a relative (or possible absolute) or also a URL path where foreign linked bookmark files are placed. It has the form "path/*.ext" where ".ext" may be ".html" to link to html files.

sExtRefBesideHtml

java.lang.String sExtRefBesideHtml

Contains the extension for reference links beside the own document from -labels. It has the form "path/*.ext" where ".ext" may be ".html" to link to html files.

sExtRefBesidePdf

java.lang.String sExtRefBesidePdf

Contains the extension for reference links beside the own document from -labels. It has the form "path/*.ext" where ".ext" may be ".html" to link to html files.

sRefBesideInWWWHtml

java.lang.String sRefBesideInWWWHtml

Contains the www URL path where the files with references to bookmarks to documents beside are placed additional to the given #-sRefBesidePdf It has the form "https://myPage.org/path/*.ext" where ".ext" may be ".html" to link to html files.

sRefBesideInWWWPdf

java.lang.String sRefBesideInWWWPdf

Contains the www URL path where the files with references to bookmarks to documents beside are placed additional to the given #-sRefBesidePdf It has the form "https://myPage.org/path/*.ext" where ".ext" may be ".html" to link to html files.

dirDbg

java.io.File dirDbg

argListCommon

org.vishia.util.Arguments.Argument[] argListCommon

Constructor Detail

CommonArgs

protected CommonArgs()

Method Detail

setCurrDir

public void setCurrDir()

getDirNameReplaceSrcCmpn

protected TranslateOdtCommon.CommonArgs.DirName getDirNameReplaceSrcCmpn(java.lang.String val)

Combines the given 'val' with sDirSrcCmpn to a directory and extract maybe the given extension. This operation is used for several argument preparation.

• If '++/' is found in args, and sDirSrcCmpn is set (not null), then the directory part with '++' on end is replaced by sDirSrcCmpn.
• If '++/' is found, but sDirSrcCmpn null, (because the input file name has not contained a '++' in the name, or argument '-dirCmpn' was not given) then '++' is removed in the path, it means the directory name before '++' is used. This should be the default component path.
• If '++/' is not found, then the directory is built as given.

Only on 'bFile' = true: If '*' is containd in val, then:

• '/*' should be written, as last val path element.
• then TranslateOdtCommon.CommonArgs.DirName.name is set with the part after *
• If '*' is not found, then TranslateOdtCommon.CommonArgs.DirName.name is set with the last path entry as file name.

Parameters:

val - argument value can contain 'path/default++/to/*name.ext'

bFile - true then extract an file name or extension, false: build the directory with val

Returns:

getDirRepaceSrcCmpn

protected java.io.File getDirRepaceSrcCmpn(java.lang.String sDirArg)