org.vishia.libOffc.cfgui

Class WriteKeyAccl

java.lang.Object

org.vishia.libOffc.cfgui.WriteKeyAccl

public class WriteKeyAccl
extends java.lang.Object

This class presents an application which writes the key accelerator output of LibreOffice as human readable text file.

It can be used as template for the XmlJzReader usage in an application. Because the intrinsic processing of the read data is not part of this class. It is called in only one line in execute(): 'WriteKeyAcclPrc.exec(...)'. This line and the used 'XmlDataLOffcKeyAccl_Zbnf data' also only in execute() should be exchanged.

• Copy this class as source.java renamed
• Search and replace 'WriteKeyAccl' to the name used.
• First comment out the 'evalPrc' class and call, replace later with your evaluation process.
• The config file should be given, see XmlJzCfgAnalyzer or also https://vishia.org/Java/html/RWTrans/XmlJzReader.html. Replace with your configuration file for XmlCfg.
• The destination classes should be given, see also there. Replace with your destination classes.
• Test it. Look whether the config file is ok, destination is ok, look on your data read.

Due to the common approach as template, processing the result of XML reading is completely done in WriteKeyAcclPrc, see there.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	WriteKeyAccl.CmdArgs

Field Summary

Fields

Modifier and Type	Field and Description
(package private) WriteKeyAccl.CmdArgs	cmdArgs All command arguments after command line evaluation with Arguments.
private WriteKeyAcclPrc	evalPrc The class instance which is responsible to the evaluation of the XML parsing result.
private org.vishia.xmlReader.XmlCfg	xmlCfg XmlCfg how to read the xml file, prepared for XmlCfg.readCfgFile(File, LogMessage)
private org.vishia.xmlReader.XmlJzReader	xmlReader Instance of the xmlReader used with the xmlCfg

Constructor Summary

Constructors

Constructor and Description
WriteKeyAccl(WriteKeyAccl.CmdArgs cmdArgs)

Method Summary

Modifier and Type	Method and Description
static int	amain(WriteKeyAccl.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.
int	execute() Executes read the XML file and calls the evaluation: 'WriteKeyAcclPrc.exec(...)' This can be used as template for applications which uses the XmlJzReader
static void	main(java.lang.String[] sArgs) main for UFBglConv, invoked from cmd line.
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.

Methods inherited from class java.lang.Object

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

Field Detail

cmdArgs

final WriteKeyAccl.CmdArgs cmdArgs

All command arguments after command line evaluation with Arguments.

xmlCfg

private org.vishia.xmlReader.XmlCfg xmlCfg

XmlCfg how to read the xml file, prepared for XmlCfg.readCfgFile(File, LogMessage)

xmlReader

private org.vishia.xmlReader.XmlJzReader xmlReader

Instance of the xmlReader used with the xmlCfg

evalPrc

private final WriteKeyAcclPrc evalPrc

The class instance which is responsible to the evaluation of the XML parsing result.

Constructor Detail

WriteKeyAccl

public WriteKeyAccl(WriteKeyAccl.CmdArgs cmdArgs)

Method Detail

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 -

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.

amain

public static int amain(WriteKeyAccl.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.

execute

public int execute()
            throws java.io.IOException

Executes read the XML file and calls the evaluation: 'WriteKeyAcclPrc.exec(...)'

This can be used as template for applications which uses the XmlJzReader

Returns:

0 or an error level proper for main call.

Throws:

java.io.IOException - for file problems.