org.vishia.docuGen

Class DocuGen

java.lang.Object

org.vishia.docuGen.DocuGen

public class DocuGen
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DocuGen.Args
static class	DocuGen.CmdLine
static class	DocuGen.Content
static class	DocuGen.DocuInput
static class	DocuGen.Document
static class	DocuGen.HyperlinkAssociation
static class	DocuGen.Inset
static class	DocuGen.Target
static class	DocuGen.Topic
static class	DocuGen.ZbnfDocuGenCtrl This is the root class for the Zbnf parsing result for the docuGenCtrl script file.

Field Summary

Fields

Modifier and Type	Field and Description
(package private) MainCmd_ifc	console Aggregation to the Console implementation class.
static java.lang.String	sVersion Version, history and license.

Constructor Summary

Constructors

Constructor and Description
DocuGen(MainCmd_ifc console)

Method Summary

Modifier and Type	Method and Description
(package private) void	execute(DocuGen.Args args)
static void	main(java.lang.String[] args) main started from java
private DocuGen.ZbnfDocuGenCtrl	parseAndStoreInput(DocuGen.Args args) This method reads the input script, parses it with ZBNF, stores all results in the Java-class ZbnfResultData
private void	prepareDocuGenCtrl(DocuGen.ZbnfDocuGenCtrl zsrcData)

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.

• 2015-12-05 Hartmut new: Created, with schema of StateMcHgen. It should be the main class for documentation generation using JZcmd instead XSLT and ANT.

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

console

final MainCmd_ifc console

Aggregation to the Console implementation class.

Constructor Detail

DocuGen

public DocuGen(MainCmd_ifc console)

Method Detail

main

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

main started from java

execute

void execute(DocuGen.Args args)
      throws java.io.IOException,
             java.lang.IllegalAccessException

Throws:

java.io.IOException

java.lang.IllegalAccessException

prepareDocuGenCtrl

private void prepareDocuGenCtrl(DocuGen.ZbnfDocuGenCtrl zsrcData)

parseAndStoreInput

private DocuGen.ZbnfDocuGenCtrl parseAndStoreInput(DocuGen.Args args)

This method reads the input script, parses it with ZBNF, stores all results in the Java-class ZbnfResultData