org.vishia.xmlReader

Class XmlJzCfgAnalyzer

java.lang.Object

org.vishia.xmlReader.XmlJzCfgAnalyzer

public class XmlJzCfgAnalyzer
extends java.lang.Object

This class reads any XML file and writes its structure to a XmlCfg format. With it the xmlCfg to read that file to data can be prepared.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
(package private) static class	XmlJzCfgAnalyzer.XmlStructureData
(package private) static class	XmlJzCfgAnalyzer.XmlStructureNode This class is one node for one element to store the structure of a XML file via XmlJzReader.

Field Summary

Fields

Modifier and Type	Field and Description
(package private) int	debugStopLineXmlInp
(package private) java.util.Map<java.lang.String,java.lang.String>	nameSpacesAll The declared name spaces found in all nodes.
static java.lang.String	version Version, License and History: 2022-06-06 Hartmut: produces the "xmlinput:finish" entry, see XmlCfg.
(package private) XmlJzCfgAnalyzer.XmlStructureData	xmlStructData The common structure data of the read XML file.
(package private) XmlJzCfgAnalyzer.XmlStructureNode	xmlStructTree The tree of the structure of the read XML file.

Constructor Summary

Constructors

Constructor and Description
XmlJzCfgAnalyzer()

Method Summary

Modifier and Type	Method and Description
private void	addWrNode(XmlNode wrCfgXmlNode, XmlJzCfgAnalyzer.XmlStructureNode structNode, int recursion) Adds the node and recursively all sub nodes from XmlJzCfgAnalyzer.XmlStructureNode It is invoked after a XML file war read with XmlCfg#newCfgReadStruct()
static void	main(java.lang.String[] args) Reads a XML file and writes its structure as cfg.xml to help creating a config for the XmlJzReader
static XmlCfg	newCfgReadStruct() Creates the configuration to read any xml file to store its structure especially in XmlJzCfgAnalyzer.XmlStructureNode.
private char	readAttributeOrSubnode(java.lang.String sLine)
void	readConfigText(java.io.File fin)
private void	readNameSpace(java.lang.String sLine)
private XmlJzCfgAnalyzer.XmlStructureNode	readNode(java.io.BufferedReader rd, java.lang.String sLine1)
private void	readRootStructure(java.lang.String sLine)
void	readXmlStruct(java.io.File fXmlIn) Reads any XML file and stores the structure in the xmlStructTree.
void	readXmlStructZip(java.io.File fXmlIn, java.lang.String pathInZip) Reads any XML file and stores the structure in the xmlStructTree.
void	setDebugStop(int line) Only for internal debug.
void	writeCfgTemplate(java.io.File wrCfg) Writes the config file for the XmlJzReader with config file.
void	writeCfgText(java.io.File fout) Writes the config file for the XmlJzReader with config file.
void	writeData(java.io.File fout)
private void	wrSetAddContentAttrib(XmlJzCfgAnalyzer.XmlStructureNode structNode, XmlNode wrCfgXmlNode)

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, License and History:

• 2022-06-06 Hartmut: produces the "xmlinput:finish" entry, see XmlCfg.
• 2022-06-06 Hartmut: regards all namespace entries
• 2019-08-18 improvements with namespace and usage for GenXmlCfgJavaData.
• 2018-09-10 writes cfg attributes.
• 2018-08-15 created.

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

debugStopLineXmlInp

int debugStopLineXmlInp

xmlStructData

final XmlJzCfgAnalyzer.XmlStructureData xmlStructData

The common structure data of the read XML file.

xmlStructTree

XmlJzCfgAnalyzer.XmlStructureNode xmlStructTree

The tree of the structure of the read XML file. It contains the same tag element only one time. It is tested in XmlJzCfgAnalyzer.XmlStructureNode.addElement(String).

nameSpacesAll

java.util.Map<java.lang.String,java.lang.String> nameSpacesAll

The declared name spaces found in all nodes.

Constructor Detail

XmlJzCfgAnalyzer

public XmlJzCfgAnalyzer()

Method Detail

main

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

Reads a XML file and writes its structure as cfg.xml to help creating a config for the XmlJzReader

Parameters:

args - pathfileIn.xml pathfileOutcfg.xml

newCfgReadStruct

public static XmlCfg newCfgReadStruct()

Creates the configuration to read any xml file to store its structure especially in XmlJzCfgAnalyzer.XmlStructureNode.

Returns:

instance of XmlCfg to do so.

setDebugStop

public void setDebugStop(int line)

Only for internal debug. See implementation. There is a possibility to set a break point if the parser reaches the line.

Parameters:

line -

writeCfgTemplate

public void writeCfgTemplate(java.io.File wrCfg)

Writes the config file for the XmlJzReader with config file.

Parameters:

wrCfg - the output file.

writeCfgText

public void writeCfgText(java.io.File fout)

Writes the config file for the XmlJzReader with config file.

Parameters:

wrCfg - the output file.

readConfigText

public void readConfigText(java.io.File fin)

readNameSpace

private void readNameSpace(java.lang.String sLine)

readNode

private XmlJzCfgAnalyzer.XmlStructureNode readNode(java.io.BufferedReader rd,
                                                   java.lang.String sLine1)
                                            throws java.io.IOException

Throws:

java.io.IOException

readAttributeOrSubnode

private char readAttributeOrSubnode(java.lang.String sLine)

readRootStructure

private void readRootStructure(java.lang.String sLine)

wrSetAddContentAttrib

private void wrSetAddContentAttrib(XmlJzCfgAnalyzer.XmlStructureNode structNode,
                                   XmlNode wrCfgXmlNode)
                            throws XmlException

Throws:

XmlException

addWrNode

private void addWrNode(XmlNode wrCfgXmlNode,
                       XmlJzCfgAnalyzer.XmlStructureNode structNode,
                       int recursion)
                throws XmlException

Adds the node and recursively all sub nodes from XmlJzCfgAnalyzer.XmlStructureNode It is invoked after a XML file war read with XmlCfg#newCfgReadStruct()

Parameters:

wrCfgXmlNode - The xml node for output to add.

structNode - The node from the structure of the read XML file,

recursion - decremented, exception on <=0

Throws:

XmlException - on XML error, IllegalArgumentException on recursion error.

readXmlStruct

public void readXmlStruct(java.io.File fXmlIn)
                   throws java.io.IOException

Reads any XML file and stores the structure in the xmlStructTree.

Parameters:

fXmlIn -

Throws:

java.io.IOException

readXmlStructZip

public void readXmlStructZip(java.io.File fXmlIn,
                             java.lang.String pathInZip)
                      throws java.io.IOException

Reads any XML file and stores the structure in the xmlStructTree.

Parameters:

fXmlIn -

Throws:

java.io.IOException

writeData

public void writeData(java.io.File fout)
               throws java.io.IOException

Throws:

java.io.IOException