org.vishia.zbnf

Class Zbnf2Xml

java.lang.Object

org.vishia.zbnf.Zbnf2Xml

Direct Known Subclasses:

Zbnf2Text

public class Zbnf2Xml
extends java.lang.Object

This class contains a public static main routine able to invoke from command line to convert Plain Syntactical Textfiles via ZBNF to xml-output, using the vishia-ZBNF-parser.
To invoke the conversion use the commandline version with parameters see help output getting by invoking without parameters.
short description: invoke:

 >java -cp path/to/zbnf.jar org.vishia.zbnf.Zbnf2Xml -iINPUTPATHFILE -sSYNTAX.zbnf -yXMLOUTPUT

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	Zbnf2Xml.Args
protected static class	Zbnf2Xml.CmdLine The inner class CmdLine helps to evaluate the command line arguments and show help messages on command line.
static interface	Zbnf2Xml.PrepareXmlNode

Field Summary

Fields

Modifier and Type	Field and Description
protected Zbnf2Xml.Args	argsx Arguments from main of this class.
protected MainCmdLogging_ifc	logmaincmd Help reference to name the report output.
protected ZbnfParser	parser
static java.lang.String	sVersion Version, history and license.

Constructor Summary

Constructors

Constructor and Description
Zbnf2Xml(java.lang.String input, java.lang.String syntax, java.lang.String output, MainCmdLogging_ifc report)
Zbnf2Xml(Zbnf2Xml.Args args, MainCmdLogging_ifc report) Constructor of the main class.

Method Summary

Modifier and Type	Method and Description
boolean	execute() Deprecated. use parseAndWriteXml()
static void	main(java.lang.String[] sArgs) main started from java
boolean	parseAndWriteXml()
static java.lang.String	smain(java.lang.String[] sArgs) Invocation from another java program without exit the JVM
private static java.lang.String	smain(java.lang.String[] sArgs, boolean shouldExitVM)
static void	writeZbnf2Xml(ZbnfParser parser, java.lang.String sFileXmlOut, java.nio.charset.Charset encoding) Write a XML file with the parse result from the given parser.

Methods inherited from class java.lang.Object

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

Field Detail

sVersion

public static final java.lang.String sVersion

Version, history and license.

• 2022-02-08: Hartmut writeZbnf2Xml(ZbnfParser, String, Charset) is new but only refactored. content was given, own operation resolved.
• 2019-12-08: new option -opt:1 to use the optimizing of using already parsed results.
• 2014-06-17 Hartmut new: options -xmsSrcline[:[on|off]] -xmsSrctext[:[on|off]] and controls whether srcline="xx" and srctext="text" will be written to a XML output
• 2012-03-23 Hartmut new smain(String[], boolean) as alternative to main(String[]) to call from other Java parts. The main(String[]) calls System.exit(int) which terminates the JVM. Is it a good idea? Maybe main should only return, but how to deliver a errorlevel to a running shell script/batch without System.exit(errlevel). Maybe two methods are necessary.
• 2013-03-20 Hartmut bugfix close() on written XML file. Without close the file was not able to access in a later step in the same Java program, whereby ending the Java process closes from operation system.
• 2013-02-11 Hartmut chg: now does not use ZbnfXmlOutput but uses the intrinsic Xml tree returned with ZbnfParser.getResultTree().
• 2012-11-01 Hartmut Some changes in structure of args, non-function-relevant. It is to provide common structures with Zbnf2Text.
• 2006-05-00 Hartmut creation:

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 is 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

logmaincmd

protected final MainCmdLogging_ifc logmaincmd

Help reference to name the report output.

argsx

protected final Zbnf2Xml.Args argsx

Arguments from main of this class.

parser

protected ZbnfParser parser

Constructor Detail

Zbnf2Xml

public Zbnf2Xml(Zbnf2Xml.Args args,
                MainCmdLogging_ifc report)

Constructor of the main class. The command line arguments are parsed here. After them the execute class is created as composition of Zbnf2Xml.

Zbnf2Xml

public Zbnf2Xml(java.lang.String input,
                java.lang.String syntax,
                java.lang.String output,
                MainCmdLogging_ifc report)

Method Detail

main

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

main started from java

smain

public static java.lang.String smain(java.lang.String[] sArgs)

Invocation from another java program without exit the JVM

Parameters:

sArgs - same like main(String[])

Returns:

"" or an error String

smain

private static java.lang.String smain(java.lang.String[] sArgs,
                                      boolean shouldExitVM)

execute

@Deprecated
public final boolean execute()

Deprecated. use parseAndWriteXml()

Executes the parsing process and writes an XML file.

Returns:

true if successfull

parseAndWriteXml

public boolean parseAndWriteXml()

writeZbnf2Xml

public static void writeZbnf2Xml(ZbnfParser parser,
                                 java.lang.String sFileXmlOut,
                                 java.nio.charset.Charset encoding)
                          throws java.io.IOException

Write a XML file with the parse result from the given parser. The parser contains also namespace declarations.

Parameters:

parser - has successfully parsed.

sFileXmlOut - pathfile, destination directories will be created.

encoding - maybe null, then UTF-8

Throws:

java.io.IOException - especially FileNotFoundException on any error