org.vishia.zbnf

Class ZbnfJavaOutput

java.lang.Object

org.vishia.zbnf.ZbnfJavaOutput

public final class ZbnfJavaOutput
extends java.lang.Object

This class helps to convert a ZBNF-parse-result into a tree of Java objects. The user have to be provide a toplevel-instance with given access type which contains public Fields or public new_-, set_- or add_-methods for any parse result. The fields or methods are find out using the reflection.

Saving the content of simple result using fields: Simple results are the basicly components of ZBNF such as <#?any_number> or <""?Astring>. Depending on the type of result a field with the appropriate name is searched in the users Object of the current level, and the result content is stored there. The field should be start with a lower-case letter, independent of the case of the first letter of the semantic identifier of the parse result. The type of the field should be matched to the type of the parse result: String for String-results, and int, float, double for value results. The numeric type is flexible.

Saving the content of result-components using fields: Result-components are the complex results, which have a tree of results inside. The appropriate syntax-components are declared in ZBNF writing component::=.... If such results should be stored using fields, a field of type List should be exists with the semantic identifier of the parse result. Than a new element of the List type will be created, that object will be filled with the component's result and than add to the list.

Saving the content of simple result using methods: A method with name set_Semantic(Type) should be exist. The Semantic is the semantic identifier of the parse result. The Type of the argument should follow the type of the parse result. Thereby an integer parse result can be associated to one of the scalar number types, a float or double result can associated to both a float or double parameter type. Any other result should be have a String parameter. While accepting several parameter types, the architecture of the user methods can be adapted to the user's requirements.

Saving the content of syntax components using methods:

If a Type new_semantic()-method will be found, it is invoked to get an instance for the syntax-components's content. It is possible, that this instance isn't a new instance, but it is a static allocated instance which is reused temporary to hold the components data. Another way is to call a new operator to get a new instance. The return type of the Type new_semantic()-method, or the field type of non-containers or the generic-type of List fields is used to search fields or methods for the component. The types may be defined somewhere else in the Java-package-tree, but the classes have to be be public.

Than the got instance is used to fill the content of the component like described above.

After them the appropriated method void add_semantic(Type) or void set_semantic(Type) is called to store the content. One of that methods have to be exist. Both method-variants, add_ or set_ have the same meaning for processing the data, the name considers the meaning of the users action. add associates adding a content to a container, where set means a simple setting of data. The implementation of this method can be store the reference of the instance, or it can evaluate the content with special tests, copy in a special way etc. It is user-free.



Public fields or methods, interfaces

All elements which should be used to store parse results have to be public, because the access to it using reflection is done. Using public fields is more simple, but using public methods is better to debug and encapsulate. The methods may be overridden or interface methods, the class-type which is returned by new_Name(...) may be a basic type or interface. The implementation method is called of course. This concept enables a break of dependency between the classes, which are known in context of storing a parse result and the really implementing classes. It is a application of the standard interface pattern.



Encapsulation, Safety of data while using public access methods or public fields

The toplevel-instance is provided internally. If it isn't able to access in a public way, it and all its child data are safety, though the elements of the class are public. The access to the instance is protected.



Comparison with Apache-ANT concept to store parameters for Tasks

The rules for this things are some different but with same principle likewise arguments for call of java classes extends org.apache.tools.ant.Task called in ant (http://ant.apache.org/manual/develop.html). There are much more simple:

• The semantic identifier is used as name for fields and methods, named name in the description below. For set- and get-methods the name is used exactly like written in the ZBNF syntax script. For searching field names the first character is converted to lower case.
• For non-ZBNF-components first a set_name(Type)- or add_name(Type)-method is searched and invoked, if found.
• The type of the methods argument is predetermined by the type of the stored result. For components, it is the component instance type. For elements, the type of elements determine the argument type:
• If no method is found, a field Type name is searched. If it is found, the type is tested. For parse result elements, the type of fields must be java.lang.String or long, int, float or double. To store instances for parse result components, the type of the field determines the components class type.
• java.util.List< Type> name fields for the child parse result components,
• Type fields for the child parse result components if only 1 child is able.
• java.lang.String name-fields for parsed string represented results,
• long, int, float, double fields for parsed numbers.

Special functionality for storing the line and column number of the input text

The knowledge of the column inside a source line may be important for evaluating the result. That is for example for indented texts whereby the indentation have a semantic meaning. The line and file may be important especially for some information which should refer to the source.

The the user's class can implement SetLineColumn_ifc. Then the column position, the line, the file will be stored in the users instance. If only the column is necessary, only it will be stored. The effort to get the line and the file will be higher, therefore it is not gotten if not necessary. The parser knows the column, line and file it is parse result if the input allows to detect it. To capture the line number a StringPartFromFileLines have to be used for input for the ZBNF parser, because only this class overrides the org.vishia.util.StringPart#getLineCt() method with a really line number. This class reads a file line per line.

There is an older form: The user class can have an element public int inputLine_ or a method set_inputLine_(int) to store the line number of the input text, respectively public int inputColumn_ or a method set_inputColumn_(int) if the input column of the parsed text should be stored. It will be checked whether that fields are existent, then this information will be stored.



Error detecting and handling

If a appropriate method or field isn't found, either an IllegalArgumentException is thrown or the errors are collected and returned in a String. The first behavior is practicable, because mostly a false content of destination classes may be writing error of the program. The variant to produce a collected error text is more usefull for debugging.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	ZbnfJavaOutput.DstInstanceAndClass Helper Instance to bundle a class to search methods or fields and the associated instance.

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	bExceptionIfnotFound If it is set, an IllegalArgumentException is thrown, if a matching field or method are not found.
private boolean	bNewFromType True then create a dst instance of a component only from the given type name and the found instance class.
private boolean	bOnlyFields If it is set, only fields are accepted, no methods.
private boolean	bOnlyMethods If it is set, only set_ or add_-methods and new_-methods are accepted, no fields and no inner classes as container.
private java.lang.StringBuffer	errors Buffer to note errors during working.
ZbnfParser	parser
private LogMessage	report
static java.lang.String	sVersion Version, history and license.

Constructor Summary

Constructors

Modifier	Constructor and Description
	ZbnfJavaOutput() Empty constructor.
	ZbnfJavaOutput(LogMessage report) Constructor with given log output.
private	ZbnfJavaOutput(MainCmdLogging_ifc report, boolean strict, boolean methods)

Method Summary

Modifier and Type	Method and Description
private ZbnfJavaOutput.DstInstanceAndClass	getComponentsOutputField(java.lang.String semantic, java.lang.reflect.Field element, java.lang.Object outputInstance) Gets the instance and class to write a components content into.
void	init() Sets the default settings and clears saved errors.
private void	noteError(java.lang.CharSequence problem) Adds an error.
java.lang.String	parseFileAndFillJavaObject(java.lang.Class resultType, java.lang.Object result, java.io.File fInput, java.io.File fSyntax) Parses the given file with given syntax and fills the parsed result into the result object.
static java.lang.String	parseFileAndFillJavaObject(java.lang.Class resultType, java.lang.Object result, java.io.File fInput, java.io.File fSyntax, MainCmdLogging_ifc report, int msgRange) Parses the given file with given syntax and fills the parsed result into the result object.
java.lang.String	parseFileAndFillJavaObject(java.lang.Class resultType, java.lang.Object result, java.io.File fInput, java.lang.String sSyntax) Parses the given file with given syntax and fills the parsed result into the result object.
java.lang.String	parseFileAndFillJavaObject(java.lang.Class resultType, java.lang.Object result, java.io.File fInput, StringPartScan spSyntax)
java.lang.String	parseFileAndFillJavaObject(java.lang.Class resultType, java.lang.Object result, java.io.File fInput, StringPartScan spSyntax, java.io.File fSyntaxDir) Parses the given file with given syntax and fills the parsed result into the result object.
java.lang.String	parseFileAndFillJavaObject(java.lang.Class resultType, java.lang.Object result, StringPartScan spInput, java.lang.String sFileInput)
private java.lang.String	parseFileAndFillJavaObject(java.lang.Class resultType, java.lang.Object result, StringPartScan spInput, java.lang.String sFileInput, StringPartScan spSyntax, java.io.File fSyntaxDir) Parses the given file with given syntax and fills the parsed result into the result object.
java.lang.String	parseFileAndFillJavaObject(java.lang.Class resultType, java.lang.Object result, java.lang.String sInput, java.lang.String sFileInput, java.lang.String syntax, java.io.File fSyntaxDir) Parses the given String with given syntax and fills the parsed result into the result object.
java.lang.String	parseFileAndFillJavaObject(java.lang.Object result, java.io.File fInput) Parses and fills to the result with given Syntax.
java.lang.String	parseFileAndFillJavaObject(java.lang.Object result, java.io.File fInput, java.io.File fSyntax) Parses the given file with given syntax and fills the parsed result into the result object.
java.lang.String	parseFileAndFillJavaObject(java.lang.Object result, java.io.File fInput, java.lang.String sSyntax) Parses the given file with given syntax and fills the parsed result into the result object.
private void	problem(ZbnfJavaOutput.DstInstanceAndClass destComponent, java.lang.String sProblem)
private void	searchAddMethodAndInvoke(java.lang.String semantic, ZbnfJavaOutput.DstInstanceAndClass component, ZbnfJavaOutput.DstInstanceAndClass componentsDestination) Searches the add_semantic(Object)-Method and invokes it.
protected ZbnfJavaOutput.DstInstanceAndClass	searchComponentsDestination(java.lang.String semantic, ZbnfParseResultItem zbnfItem, ZbnfJavaOutput.DstInstanceAndClass parentDst, java.lang.Class<?> mainDstClass) Searches a class and instance appropriate to the given semantic to store a component.
protected ZbnfJavaOutput.DstInstanceAndClass	searchCreateMethod(java.lang.Class<?> inClazz, java.lang.Object instance, java.lang.String semantic, ZbnfJavaOutput.DstInstanceAndClass parent, ZbnfParseResultItem zbnfElement) Searches a method with signature new_().
protected ZbnfJavaOutput.DstInstanceAndClass	searchCreateNew(java.lang.Class<?> mainDstClazz, java.lang.Object instance, java.lang.String semantic, ZbnfJavaOutput.DstInstanceAndClass parent, ZbnfParseResultItem zbnfElement) Searches a method with signature new_().
protected ZbnfJavaOutput.DstInstanceAndClass	searchDestinationAndWriteResult(java.lang.String semanticRaw, ZbnfJavaOutput.DstInstanceAndClass destComponent, java.lang.Class<?> mainDstClass, ZbnfParseResultItem resultItem) searches the method or field matching to the semantic of the leaf resultItem (not a ZBNF-component) and write the given content of resultItem into it,
private java.lang.reflect.Method	searchMethod(int[] retVariant, java.lang.Class<?> outputClass, java.lang.String name, java.lang.Class<?>[][] argTypesVariants) Searches a method with given Name and given argument types in the class or in its super-classes and interfaces.
java.lang.String	setContent(java.lang.Class topLevelClass, java.lang.Object topLevelInstance, ZbnfParseResultItem resultItem) This is the main method to set content (non-static variant).
void	setFieldsOnly(boolean value) Sets the association mode:
void	setMethodsOnly(boolean value) Sets the association mode:
void	setNewFromType(boolean value)
static void	setOutput(java.lang.Object topLevelOutput, ZbnfParseResultItem resultItem, MainCmdLogging_ifc report)
static void	setOutput(java.lang.Object topLevelOutput, ZbnfParseResultItem resultItem, MainCmdLogging_ifc report, boolean strict, boolean bOnlyMethods, boolean bNewFromType) Writes the parsers result into a tree of Java objects using the reflection method.
static void	setOutputFields(java.lang.Object topLevelOutput, ZbnfParseResultItem resultItem, MainCmdLogging_ifc report) Writes the parsers result into a tree of Java objects using the reflection method.
static void	setOutputStrict(java.lang.Object topLevelOutput, ZbnfParseResultItem resultItem, MainCmdLogging_ifc report) Writes the parsers result into a tree of Java objects using the reflection method.
static void	setOutputStrictNewFromType(java.lang.Object topLevelOutput, ZbnfParseResultItem resultItem, MainCmdLogging_ifc report) Writes the parsers result into a tree of Java objects using the reflection method.
void	setWeakErrors(boolean value) Sets the behavior if no appropriate method or field is found for a parser result.
(package private) void	stop() It's a debug helper.
private void	trySetInputColumn(java.lang.String semantic, ZbnfJavaOutput.DstInstanceAndClass destComponent, int column) Tries if an field inputColumn_semantic or a method set_inputColumn_semantic exists and set resp. calls it.
private boolean	trySetInputInfo(ZbnfJavaOutput.DstInstanceAndClass destComponent, int line, int column, java.lang.String sFile) Tries if an field inputLine_ or a method set_inputInfo_ exists and set resp. calls it.
private void	writeInField(java.lang.reflect.Field element, java.lang.Object outputInstance, ZbnfParseResultItem resultItem) Writes a value in a given field.
(package private) ZbnfJavaOutput.DstInstanceAndClass	writeInMap(java.lang.String semantic, ZbnfJavaOutput.DstInstanceAndClass destComponent, ZbnfParseResultItem resultItem)
protected void	writeZbnfResult(ZbnfJavaOutput.DstInstanceAndClass dstArg, ZbnfParseResultItem zbnfComponent, java.lang.Class<?> mainDstClass, int recursion) Writes the content of one parse result component into the given outputInstance.

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.

• 2023-08-02 Hartmut ExceptionMessage improved in searchAddMethodAndInvoke(...)
• 2022-04-28 Hartmut in writeZbnfResult(DstInstanceAndClass, ZbnfParseResultItem, Class, int): Store source of parsing if SetSrcInfo_ifc is given on a destination class.
• 2022-02-28 Hartmut in searchCreateNew(Class, Object, String, DstInstanceAndClass, ZbnfParseResultItem): A construct as {<?*semantic>... is also a syntax component and should be handled as such. Some trouble for getting the name of the component. Solved.
• 2022-02-10 Hartmut: on problem message now the problem starts with a new line, better readable.
• 2022-02-10 Hartmut: some changes:
  • bNewFromType and setOutputStrictNewFromType(Object, ZbnfParseResultItem, MainCmdLogging_ifc)
  • writeZbnfResult(DstInstanceAndClass, ZbnfParseResultItem, Class, int) with mainClass as argument for newfromType approach
  • searchCreateNew(Class, Object, String, DstInstanceAndClass, ZbnfParseResultItem) as worker operation
  • searchAddMethodAndInvoke(String, DstInstanceAndClass, DstInstanceAndClass) now checks also add_ and _set operations with the super types of the argument, to find the correct operation with given super type.
• 2012-02-07 Hartmut: if a boolean result is given, nevertheless an operation set...(String) is searched alternatively. This is because the GenZbnfJavaData generates in some cases String variable instead boolean.
• 2019-05-30 Hartmut: some improvements to store [<<cmpnSemantic/@text> see documentation.
• 2019-05-21 chg: parser is now a class variable and final public. Advantage: Accessible from outer to set some log things.
• 2018-09-11 bugfix: On error reading file: The error was ignored and the parser was started, which returns null as parse result. fix: return sError.
• 2018-08-28 Hartmut new: improve change with . add_semantic is called, it was missing, only ok in the concretely case.
• 2017-04-22 Hartmut new: If a new_xyz method is found for a non syntaxComponent, the return value is a child instance to write into the next result items, till . The last one switches back to the parent again.
• 2017-03-25 Hartmut new It is possible that the user provides a method new_semantic(ZbnfParseResultItem zbnfItem). Then the parse result item is supplied. The application can evaluate both the ZbnfParseResultItem or the ZbnfParseResultItem.syntaxItem() for more informations. Especially the ZbnfSyntaxPrescript.getAttribute(String) can be used.
• 2016-01-17 Hartmut new parseFileAndFillJavaObject(Class, Object, String, String, String, File) with simple string given input an syntax.
• 2015-12-06 Hartmut new parseFileAndFillJavaObject(Class, Object, File, StringPartScan, File) with the directory of scripts to include.
• 2015-05-27 Hartmut improved output on method not found.
• 2015-04-25 Hartmut chg: The class to search the destination is the ZbnfJavaOutput.DstInstanceAndClass.clazz and not the getClass() of the ZbnfJavaOutput.DstInstanceAndClass.instance. except the interface GetTypeToUse is implemented by the returned instance of a new_(). This is documented now. The JZcmdScript (JbatScript) had used the property that the instance.getClass() is the destination for overridden classes from DataAccess, therefore this treatment was used for all instances. But that is a poorly defined concept. It is better to distinguish between the dst instance and the type where the information are searched. Only in special cases, with the marker interface GetTypeToUse an abbreviated type, usual the type of the instance can be used.
• 2015-04-25 Hartmut chg: Restructured to get file and line for the top level parse result. Gardening. Documentation
• 2014-05-23 Hartmut chg: remove invocation of set_inputColumn_ and set_InputInfo_. Instead use interface SetLineColumn_ifc. It is faster, because a method which does not exists often should not be invoked. Only 'instanceof' is checked. This needs adaption of user classes which uses the method set_inputColumn_(int).
• 2014-05-22 Hartmut chg: instead trySetInputLine trySetInputInfo(DstInstanceAndClass, int, int, String). The destination class should provide boolean set_InputInfo_(int, int, String)
• 2014-04-27 Hartmut new: ctor without MainCmdLogging_ifc for simple usage.
• 2014-01-01 Hartmut new: parseFileAndFillJavaObject(Object, File, String)
• 2014-01-01 Hartmut new: #trySetInputLine(DstInstanceAndClass, int). Uses DataAccess first time. there are some parallel functionality of this class and DataAccess. The DataAccess is the more universal one.
• 2013-09-02 Hartmut chg: The ZbnfJavaOutput.DstInstanceAndClass.clazz is build from the instance instead from the given clazz Argument. It means an derived instance can contain other set_, add_method.
• 2012-12-26 Hartmut new: writeInField(Field, Object, ZbnfParseResultItem) supports a char field too, it gets the first char of a parsed string or the numeric value converted in a char (ASCII, UTF-16).
• 2012-10-07 Hartmut bugfix on writing in a public List getParsedString() should be used too.
• 2012-10-07 Hartmut chg: error text output, able to use for MsgDispatchSystemOutErr
• 2011-09-03 Hartmut chg: #writeZbnfResult(DstInstanceAndClass, ZbnfParseResultItem, int): check semantic, if empty, does nothing
• 2010-12-03 Hartmut new: parseFileAndFillJavaObject(...String syntax), better user support for simple tasks
• 2010-12-02 Hartmut fnChg: parseFileAndFillJavaObject(): no report output of sError, because it is supplied in the return value.
• 2010-12-02 Hartmut new: Up to now this version variable, its description contains the version history.
• 2010-01-24: Hartmut docu improved, MainCmdLogging_ifc-output before exception on error in called routine to visit the problem.
• 2009-04-26: Hartmut corr: Now all float or int parse result can set a int, long, float double fields and set_method(value).
• 2009-04-26: Hartmut corr: better Exception text if access a non public field as components output.
• 2009-03-23: Hartmut chg: total new structuring. Functional change is:
  • Now inner classes in the output classes are unnecessary,
  • a destination class is found as type of a new_semantic()-method
  • or as type of field for a component. It should be public, but anywhere in the code.
  • All other functions are compatible.
• 2009-03-08: Hartmut new: setOutputFields. It is strict, but accept fields, not only methods.
• 2008-04-02: Hartmut some changes
• 2006-05-15: Hartmut www.vishia.de creation

• new: new functionality, downward compatibility.
• fnChg: Change of functionality, no changing of formal syntax, it may be influencing the functions of user, but mostly in a positive kind.
• chg: Change of functionality, it should be checked syntactically, re-compilation necessary.
• adap: No changing of own functionality, but adapted to a used changed module.
• corr: correction of a bug, it should be a good thing.
• bug123: correction of a tracked bug.
• nice: Only a nice correction, without changing of functionality, without changing of syntax.
• descr: Change of description of elements.

See Also:

Constant Field Values

report

private final LogMessage report

bOnlyMethods

private boolean bOnlyMethods

If it is set, only set_ or add_-methods and new_-methods are accepted, no fields and no inner classes as container.

bNewFromType

private boolean bNewFromType

True then create a dst instance of a component only from the given type name and the found instance class.

bOnlyFields

private boolean bOnlyFields

If it is set, only fields are accepted, no methods. This option is better to use if fields are used only and the calculation time should be shorten.

bExceptionIfnotFound

private boolean bExceptionIfnotFound

If it is set, an IllegalArgumentException is thrown, if a matching field or method are not found.

parser

public final ZbnfParser parser

errors

private java.lang.StringBuffer errors

Buffer to note errors during working. Its content will be returned as String-return value of setContent(Class, Object, ZbnfParseResultItem).

Constructor Detail

ZbnfJavaOutput

public ZbnfJavaOutput()

Empty constructor. The MainCmdLogging_ifc-output will be build with a MainCmdLoggingStream if the MainCmd is not used.

ZbnfJavaOutput

public ZbnfJavaOutput(LogMessage report)

Constructor with given log output.

Parameters:

report - for logging the process of associated, only LogMessage.fineDebug will be used.

ZbnfJavaOutput

private ZbnfJavaOutput(MainCmdLogging_ifc report,
                       boolean strict,
                       boolean methods)

Method Detail

setNewFromType

public void setNewFromType(boolean value)

setMethodsOnly

public void setMethodsOnly(boolean value)

Sets the association mode:

Parameters:

value - true, than fields aren't searched, only methods.

setFieldsOnly

public void setFieldsOnly(boolean value)

Sets the association mode:

Parameters:

value - true, than methods aren't searched, only fields. It may have some less calculation time.

setWeakErrors

public void setWeakErrors(boolean value)

Sets the behavior if no appropriate method or field is found for a parser result.

Parameters:

value - true, than no exception is thrown in this case. Instead the problem is noted in the returned String. false, than an IllegalArguementException is throw in this case. It is the standard behavior after init().

init

public void init()

Sets the default settings and clears saved errors.

• searches both, fields and methods.
• throws an IllegalArgumentException if a necessary field or method isn't found.

setContent

public java.lang.String setContent(java.lang.Class topLevelClass,
                                   java.lang.Object topLevelInstance,
                                   ZbnfParseResultItem resultItem)
                            throws java.lang.IllegalArgumentException,
                                   java.lang.IllegalAccessException,
                                   java.lang.InstantiationException

This is the main method to set content (non-static variant).

Parameters:

topLevelClass - The top level class, where methods and fields are searched. It is able that it is an interface type.

topLevelIntance - The instance to output. It have to be instanceof topLevelClass.

resultItem - The parsers result.

Returns:

null if no error or an error string.

Throws:

java.lang.IllegalArgumentException - Invoked if setWeakErrors(boolean) is set with true.

java.lang.IllegalAccessException - Especially if fields and methods are non-public.

java.lang.InstantiationException - Especially if problems with methods exists.

setOutputStrictNewFromType

public static void setOutputStrictNewFromType(java.lang.Object topLevelOutput,
                                              ZbnfParseResultItem resultItem,
                                              MainCmdLogging_ifc report)
                                       throws java.lang.IllegalArgumentException,
                                              java.lang.IllegalAccessException,
                                              java.lang.InstantiationException

Writes the parsers result into a tree of Java objects using the reflection method. For syntax component's instances the type class is searched. This is controlled maybe by {.... Invocation of new_semantic() cannot decide about the inner type sometimes if super component designation is used. Then this output approach should be used.

Parameters:

topLevelOutput - The toplevel instance

resultItem - The toplevel parse result

report -

Throws:

java.lang.IllegalAccessException - if the field is found but it is not public.

java.lang.IllegalArgumentException

java.lang.InstantiationException - if a matching class is found but it can't be instanciated.

Since:

2022-02

setOutputStrict

public static void setOutputStrict(java.lang.Object topLevelOutput,
                                   ZbnfParseResultItem resultItem,
                                   MainCmdLogging_ifc report)
                            throws java.lang.IllegalArgumentException,
                                   java.lang.IllegalAccessException,
                                   java.lang.InstantiationException

Writes the parsers result into a tree of Java objects using the reflection method.

Parameters:

topLevelOutput - The toplevel instance

resultItem - The toplevel parse result

report -

Throws:

java.lang.IllegalAccessException - if the field is found but it is not public.

java.lang.IllegalArgumentException

java.lang.InstantiationException - if a matching class is found but it can't be instanciated.

setOutputFields

public static void setOutputFields(java.lang.Object topLevelOutput,
                                   ZbnfParseResultItem resultItem,
                                   MainCmdLogging_ifc report)
                            throws java.lang.IllegalArgumentException,
                                   java.lang.IllegalAccessException,
                                   java.lang.InstantiationException

Writes the parsers result into a tree of Java objects using the reflection method.

Parameters:

topLevelOutput - The toplevel instance

resultItem - The toplevel parse result

report -

Throws:

java.lang.IllegalAccessException - if the field is found but it is not public.

java.lang.IllegalArgumentException

java.lang.InstantiationException - if a matching class is found but it can't be instanciated.

setOutput

public static void setOutput(java.lang.Object topLevelOutput,
                             ZbnfParseResultItem resultItem,
                             MainCmdLogging_ifc report,
                             boolean strict,
                             boolean bOnlyMethods,
                             boolean bNewFromType)
                      throws java.lang.IllegalArgumentException,
                             java.lang.IllegalAccessException,
                             java.lang.InstantiationException

Writes the parsers result into a tree of Java objects using the reflection method.

Parameters:

topLevelOutput - The toplevel instance

resultItem - The toplevel parse result

report -

Throws:

java.lang.IllegalAccessException - if the field is found but it is not public.

java.lang.IllegalArgumentException

java.lang.InstantiationException - if a matching class is found but it can't be instanciated.

setOutput

public static void setOutput(java.lang.Object topLevelOutput,
                             ZbnfParseResultItem resultItem,
                             MainCmdLogging_ifc report)
                      throws java.lang.IllegalArgumentException,
                             java.lang.IllegalAccessException,
                             java.lang.InstantiationException

Parameters:

topLevelOutput -

resultItem -

report -

Throws:

java.lang.IllegalArgumentException

java.lang.IllegalAccessException

java.lang.InstantiationException

writeZbnfResult

protected void writeZbnfResult(ZbnfJavaOutput.DstInstanceAndClass dstArg,
                               ZbnfParseResultItem zbnfComponent,
                               java.lang.Class<?> mainDstClass,
                               int recursion)
                        throws java.lang.IllegalArgumentException,
                               java.lang.IllegalAccessException,
                               java.lang.InstantiationException

Writes the content of one parse result component into the given outputInstance. This is the core method which is invoked for any component of the parsers result starting from the toplevel result, recursively if components are processed.

This routine checks whether the dst instance implements the interface SetLineColumn_ifc. If it does then the column, line and the file or stored with that in the dst instance.

All children of the given component are processed.

• If a child is a component then firstly a destination is searched referred from the given dst. This is done with the method #searchComponentsDestination(String, DstInstanceAndClass) with the given semantic of the child and the given dst (calling argument) for this component. With the child's dst this routine is invoked recursively. If the dst needs an 'add_semantic' method then searchAddMethodAndInvoke(String, DstInstanceAndClass, DstInstanceAndClass) is called after them for the child.
• If a child is not a component then the routine #searchDestinationAndWriteResult(String, DstInstanceAndClass, ZbnfParseResultItem) is invoked for that child to store the content.

Parameters:

dstArg - The class and instance to add children results.

zbnfComponent - The ZBNF parsers's result item which is either the top level result or any component.

mainDstClass - The main class to search instances for bNewFromType

recursion -

Throws:

java.lang.IllegalAccessException - if the field is not public.

java.lang.IllegalArgumentException

java.lang.InstantiationException - if a matching class is found but it can't be instantiated.

searchMethod

private java.lang.reflect.Method searchMethod(int[] retVariant,
                                              java.lang.Class<?> outputClass,
                                              java.lang.String name,
                                              java.lang.Class<?>[][] argTypesVariants)

Searches a method with given Name and given argument types in the class or in its super-classes and interfaces.

Parameters:

retVariant - null or int[]. retVariant[0] will be set with the variant of argTypesVariants.

outputClass -

name -

argTypesVariants - A list (array) of possible arguments. If it contains Class[0] it means no argument.

Returns:

the method or null if it isn't found.

searchCreateNew

protected ZbnfJavaOutput.DstInstanceAndClass searchCreateNew(java.lang.Class<?> mainDstClazz,
                                                             java.lang.Object instance,
                                                             java.lang.String semantic,
                                                             ZbnfJavaOutput.DstInstanceAndClass parent,
                                                             ZbnfParseResultItem zbnfElement)
                                                      throws java.lang.IllegalAccessException

Searches a method with signature new_().

Parameters:

inClazz - class type where the method will be searched. The method won't be searched in super classes here. Searching in super classes is organized in the routine #searchComponentsDestination(String, DstInstanceAndClass) where this method is called.

instance - with them the found method will be invoked.

semantic - name

parent - only used for parent in the return instance.

Returns:

null if the method is not found. Elsewhere the destination for the component to store, which's instance was created by the new_ method. The ZbnfJavaOutput.DstInstanceAndClass.clazz is the return type of the method. That type is used to find out destinations for children of the component. It means the instance may be an derived type, the special properties of the derived type are not used to store the parse result, only the return type is substantial.

Throws:

java.lang.IllegalAccessException - if any error occurs in the found method.

searchCreateMethod

protected ZbnfJavaOutput.DstInstanceAndClass searchCreateMethod(java.lang.Class<?> inClazz,
                                                                java.lang.Object instance,
                                                                java.lang.String semantic,
                                                                ZbnfJavaOutput.DstInstanceAndClass parent,
                                                                ZbnfParseResultItem zbnfElement)
                                                         throws java.lang.IllegalAccessException

Searches a method with signature new_().

Parameters:

inClazz - class type where the method will be searched. The method won't be searched in super classes here. Searching in super classes is organized in the routine #searchComponentsDestination(String, DstInstanceAndClass) where this method is called.

instance - with them the found method will be invoked.

semantic - name

parent - only used for parent in the return instance.

Returns:

null if the method is not found. Elsewhere the destination for the component to store, which's instance was created by the new_ method. The ZbnfJavaOutput.DstInstanceAndClass.clazz is the return type of the method. That type is used to find out destinations for children of the component. It means the instance may be an derived type, the special properties of the derived type are not used to store the parse result, only the return type is substantial.

Throws:

java.lang.IllegalAccessException - if any error occurs in the found method.

searchAddMethodAndInvoke

private void searchAddMethodAndInvoke(java.lang.String semantic,
                                      ZbnfJavaOutput.DstInstanceAndClass component,
                                      ZbnfJavaOutput.DstInstanceAndClass componentsDestination)
                               throws java.lang.IllegalArgumentException,
                                      java.lang.IllegalAccessException

Searches the add_semantic(Object)-Method and invokes it. This routine will be called after a ZBNF-components content is set into the destination Object.

Parameters:

semantic - The semantic from ZBNF.

parentClass - The class where the add_semantic(Object)-Method should be declared -or in its superclasses.

parentInstance - The instance with them the add_semantic(Object)-Method should be called.

componentsDestination - The Object where the content of the component is set.

Throws:

java.lang.IllegalArgumentException - If the method isn't found and bExceptionIfnotFound is true.

java.lang.IllegalAccessException - If the add_semantic(Object)-Method isn't public.

searchComponentsDestination

protected ZbnfJavaOutput.DstInstanceAndClass searchComponentsDestination(java.lang.String semantic,
                                                                         ZbnfParseResultItem zbnfItem,
                                                                         ZbnfJavaOutput.DstInstanceAndClass parentDst,
                                                                         java.lang.Class<?> mainDstClass)
                                                                  throws java.lang.IllegalArgumentException,
                                                                         java.lang.IllegalAccessException,
                                                                         java.lang.InstantiationException

Searches a class and instance appropriate to the given semantic to store a component. Either a new_semantic()-method is found or a field with the given semantic is found.

• If a new_semantic()-method is found, it is invoked. The returned instance is the instance for the component. Note that the new_...() method don't need to create a new instance in any case. It is possible to returns any destination instance which is used temporary till the add_...() method (searchAddMethodAndInvoke(String, DstInstanceAndClass, DstInstanceAndClass)). The return type of the found method is the components class. The method #searchCreateMethod(Class, Object, String) is called for that.
• If a new_-method is not found, a field with the semantic-name is searched. If it is found, and it is not a container type (List), the type of the field is the components type. If the field is null, a new Object with the given type is created and set. The object referenced to the field is returned.
  If the field is a container type, a List, than a new Object with the generic type of the List is created and added. See called method #getComponentsOutputField(Field, Object).

Parameters:

semantic - The name of the new_-method or the field.

parentDst - The destination instance and class where the method or field is searched.

Returns:

The class and the instance for the component. If a new_-method is called, the attribute ZbnfJavaOutput.DstInstanceAndClass.shouldAdd is set true. Because the add_-method should called also.

Throws:

java.lang.IllegalArgumentException - If no method or field is found and bExceptionIfnotFound is set.

java.lang.IllegalAccessException - If a problem with the field or method exists, especially the field or method should be public!

java.lang.InstantiationException - If a problem calling the new_-method exists.

getComponentsOutputField

private ZbnfJavaOutput.DstInstanceAndClass getComponentsOutputField(java.lang.String semantic,
                                                                    java.lang.reflect.Field element,
                                                                    java.lang.Object outputInstance)
                                                             throws java.lang.IllegalArgumentException,
                                                                    java.lang.IllegalAccessException,
                                                                    java.lang.InstantiationException

Gets the instance and class to write a components content into.

• If the given element references is a simple instance, it is returned. The returned class is the type of the reference, not the type of the instance.
• If the given element is a container type for more instances, especially a java.util.List, a new instance of the generic type of a List entry is returned. This instances is added at end of list.

Parameters:

element - The element (field) of the parent, which is matching to the semantic of the component.

outputInstance - The output instance where the element is located.

Returns:

new Wrapper of instance and class.

Throws:

java.lang.IllegalArgumentException

java.lang.IllegalAccessException

java.lang.InstantiationException

searchDestinationAndWriteResult

protected ZbnfJavaOutput.DstInstanceAndClass searchDestinationAndWriteResult(java.lang.String semanticRaw,
                                                                             ZbnfJavaOutput.DstInstanceAndClass destComponent,
                                                                             java.lang.Class<?> mainDstClass,
                                                                             ZbnfParseResultItem resultItem)
                                                                      throws java.lang.IllegalArgumentException,
                                                                             java.lang.IllegalAccessException,
                                                                             java.lang.InstantiationException

searches the method or field matching to the semantic of the leaf resultItem (not a ZBNF-component) and write the given content of resultItem into it,

Parameters:

semanticRaw - The semantic from ZBNF parse result item. It may be a child destination: part1/part2 or may contain an @ to designate attributes if it will be stored in XML. If a child destination is given, that destination is searched adequat to a destination for a component, and than this method is called recursively with that destination and the right rest of semantic. A @ as first char is ignored.

destComponent - The class where to found the method or field. and the instance to write into or invoke methods. It should contain a matching public field or method. A field matches, if its name is equal the semantic, but with lower case at first char. A method matches, if it is named set_SEMANTIC, where SEMANTIC is the semantic of the zbnf item.

resultItem - The semantic is determining the matching field or method. The content is used if childOutputInstance is null.

Returns:

null usual, A child instance if a new_semantic method was found.

Throws:

java.lang.IllegalAccessException - if the element is not writeable especially not public.

java.lang.IllegalArgumentException

java.lang.InstantiationException - if the creation of a child instance fails.

writeInField

private void writeInField(java.lang.reflect.Field element,
                          java.lang.Object outputInstance,
                          ZbnfParseResultItem resultItem)
                   throws java.lang.IllegalAccessException

Writes a value in a given field.

Parameters:

element - The field

outputInstance - the associated instance

resultItem - The ZBNF parser result.

Throws:

java.lang.IllegalAccessException

trySetInputInfo

private boolean trySetInputInfo(ZbnfJavaOutput.DstInstanceAndClass destComponent,
                                int line,
                                int column,
                                java.lang.String sFile)
                         throws java.lang.IllegalAccessException,
                                java.text.ParseException

Tries if an field inputLine_ or a method set_inputInfo_ exists and set resp. calls it. The method set_inputInfo_ have to return any object, not null, to detect whether it is existence. Use boolean as return value. If such a field or method isn't found, nothing is done. It is okay.

Parameters:

semantic - Name, it may be emtpy especially to search inputColumn_ for the component.

destinationClass - Class where searched.

destinationInstance - Associated instance where set or called.

column - The value of column. If it is negative, nothing is done. A negative value may indicate, that no valid column is given to set.

Returns:

true if the method "set_InputInfo(int, int, String)" was found.

Throws:

java.lang.IllegalAccessException - If any problem with the set-method exists.

java.text.ParseException

trySetInputColumn

private void trySetInputColumn(java.lang.String semantic,
                               ZbnfJavaOutput.DstInstanceAndClass destComponent,
                               int column)
                        throws java.lang.IllegalAccessException

Tries if an field inputColumn_semantic or a method set_inputColumn_semantic exists and set resp. calls it. If such a field or method isn't found, nothing is done. It is oksy.

Parameters:

semantic - Name, it may be emtpy especially to search inputColumn_ for the component.

destinationClass - Class where searched.

destinationInstance - Associated instance where set or called.

column - The value of column. If it is negative, nothing is done. A negative value may indicate, that no valid column is given to set.

Throws:

java.lang.IllegalAccessException - If any problem with the set-method exists.

problem

private void problem(ZbnfJavaOutput.DstInstanceAndClass destComponent,
                     java.lang.String sProblem)

writeInMap

ZbnfJavaOutput.DstInstanceAndClass writeInMap(java.lang.String semantic,
                                              ZbnfJavaOutput.DstInstanceAndClass destComponent,
                                              ZbnfParseResultItem resultItem)

stop

void stop()

It's a debug helper. The method is empty, but it is a mark to set a breakpoint.

parseFileAndFillJavaObject

public static java.lang.String parseFileAndFillJavaObject(java.lang.Class resultType,
                                                          java.lang.Object result,
                                                          java.io.File fInput,
                                                          java.io.File fSyntax,
                                                          MainCmdLogging_ifc report,
                                                          int msgRange)

Parses the given file with given syntax and fills the parsed result into the result object. This is a simple common use-able routine to transfer textual content into content of a Java object.
NOTE:This routine is static because it is a recognition to functional programming. No side effects are occurring. This method sets nothing, except the content of result. it returns only anything. An instance of this class is created internally temporary.

Parameters:

resultType - The type or a interface or basic type of result. The fields and methods are searched in this type.

result - The instance, it have to be of type 'resultType', but may be derived.

fInput - The input file to parse.

fSyntax - The syntax file using ZBNF

report - MainCmdLogging_ifc for parsing process and errors

msgRange - A start number of created messages in report.

Returns:

null if no error, else a short error text. The explicitly error text is written in report.

parseFileAndFillJavaObject

public java.lang.String parseFileAndFillJavaObject(java.lang.Object result,
                                                   java.io.File fInput,
                                                   java.io.File fSyntax)

Parses the given file with given syntax and fills the parsed result into the result object. This is a simple common use-able routine to transfer textual content into content of a Java object.
The non static variant allows to set some options using class methods.

Parameters:

resultType - The type or a interface or basic type of result. The fields and methods are searched in this type.

result - The instance, it have to be of type 'resultType', but may be derived.

fInput - The input file to parse.

fSyntax - The syntax file using ZBNF

Returns:

null if no error, else a short error text. The explicitly error text is written in report.

parseFileAndFillJavaObject

public java.lang.String parseFileAndFillJavaObject(java.lang.Class resultType,
                                                   java.lang.Object result,
                                                   java.io.File fInput,
                                                   java.io.File fSyntax)

Parses the given file with given syntax and fills the parsed result into the result object. This is a simple common use-able routine to transfer textual content into content of a Java object.
The non static variant allows to set some options using class methods.

Parameters:

resultType - The type or a interface or basic type of result. The fields and methods are searched in this type.

result - The instance, it have to be of type 'resultType', but may be derived.

fInput - The input file to parse.

fSyntax - The syntax file using ZBNF

Returns:

null if no error, else a short error text. The explicitly error text is written in report.

parseFileAndFillJavaObject

public java.lang.String parseFileAndFillJavaObject(java.lang.Class resultType,
                                                   java.lang.Object result,
                                                   java.io.File fInput,
                                                   java.lang.String sSyntax)

Parses the given file with given syntax and fills the parsed result into the result object. This is a simple common use-able routine to transfer textual content into content of a Java object.
The non static variant allows to set some options using class methods.

Parameters:

resultType - The type or a interface or basic type of result. The fields and methods are searched in this type.

result - The instance, it have to be of type 'resultType', but may be derived.

fInput - The input file to parse.

sSyntax - The syntax using ZBNF

Returns:

null if no error, else a short error text. The explicitly error text is written in report.

parseFileAndFillJavaObject

public java.lang.String parseFileAndFillJavaObject(java.lang.Object result,
                                                   java.io.File fInput,
                                                   java.lang.String sSyntax)

Parses the given file with given syntax and fills the parsed result into the result object. This is a simple common use-able routine to transfer textual content into content of a Java object.
The non static variant allows to set some options using class methods.

Parameters:

result - The instance to store the result.

fInput - The input file to parse.

sSyntax - The syntax using ZBNF

Returns:

null if no error, else a short error text. The explicitly error text is written in report.

parseFileAndFillJavaObject

public java.lang.String parseFileAndFillJavaObject(java.lang.Class resultType,
                                                   java.lang.Object result,
                                                   java.io.File fInput,
                                                   StringPartScan spSyntax)

parseFileAndFillJavaObject

public java.lang.String parseFileAndFillJavaObject(java.lang.Class resultType,
                                                   java.lang.Object result,
                                                   java.io.File fInput,
                                                   StringPartScan spSyntax,
                                                   java.io.File fSyntaxDir)

Parses the given file with given syntax and fills the parsed result into the result object. This is a simple common use-able routine to transfer textual content into content of a Java object.
The non static variant allows to set some options using class methods.

Parameters:

resultType - The type or a interface or basic type of result. The fields and methods are searched in this type.

result - The instance, it have to be of type 'resultType', but may be derived.

fInput - The input file to parse.

spSyntax - The ZBNF-syntax of the fInput, semantic should be proper to the resultType and result.

fSyntaxDir - directory which is used as base for import statements. It is the directory of the syntax file usually. It may be null. The imports are not supported in the syntax.

Returns:

null if no error, else a short error text. The explicitly error text is written in report.

Since:

2018-09-11 bugfix: On error reading file: The error was ignored and the parser was started, which returns null as parse result. fix: return sError.

parseFileAndFillJavaObject

public java.lang.String parseFileAndFillJavaObject(java.lang.Class resultType,
                                                   java.lang.Object result,
                                                   java.lang.String sInput,
                                                   java.lang.String sFileInput,
                                                   java.lang.String syntax,
                                                   java.io.File fSyntaxDir)

Parses the given String with given syntax and fills the parsed result into the result object. This is a simple common use-able routine to transfer textual content into content of a Java object.
The non static variant allows to set some options using class methods.

Parameters:

resultType - The type or a interface or basic type of result. The fields and methods are searched in this type.

result - The instance, it have to be of type 'resultType', but may be derived.

sInput - Textual input may read from a file or given as constant, especially by using JZcmd

sFileInput - This String is used only for output messages on error. It may be ""

syntax - Textual given syntax in ZBNF format.

fSyntaxDir - directory which is used as base for import statements. It is the directory of the syntax file usually. It may be null. The imports are not supported in the syntax.

Returns:

parseFileAndFillJavaObject

private java.lang.String parseFileAndFillJavaObject(java.lang.Class resultType,
                                                    java.lang.Object result,
                                                    StringPartScan spInput,
                                                    java.lang.String sFileInput,
                                                    StringPartScan spSyntax,
                                                    java.io.File fSyntaxDir)

Parses the given file with given syntax and fills the parsed result into the result object. This is a simple common use-able routine to transfer textual content into content of a Java object.
The non static variant allows to set some options using class methods.

Parameters:

resultType - The type or a interface or basic type of result. The fields and methods are searched in this type.

result - The instance, it have to be of type 'resultType', but may be derived.

spInput -

sFileInput -

spSyntax -

fSyntaxDir - directory which is used as base for import statements. It is the directory of the syntax file usually. It may be null. The imports are not supported in the syntax.

Returns:

parseFileAndFillJavaObject

public java.lang.String parseFileAndFillJavaObject(java.lang.Class resultType,
                                                   java.lang.Object result,
                                                   StringPartScan spInput,
                                                   java.lang.String sFileInput)

parseFileAndFillJavaObject

public java.lang.String parseFileAndFillJavaObject(java.lang.Object result,
                                                   java.io.File fInput)

Parses and fills to the result with given Syntax.

The Syntax of the parser should be set maybe for more as one file after Construction of this with

    parserJava = new org.vishia.zbnf.ZbnfJavaOutput(logParser);
    parserJava.parser.setSyntax(sSyntax);
 

Parameters:

result - Instance proper to syntax file for the result. Hint: Use GenZbnfJavaData to create the Java source proper to the syntax.

fInput - The input file

Returns:

null if no error, elsewhere an elaborately error message.

noteError

private void noteError(java.lang.CharSequence problem)

Adds an error. This method is called if bExceptionIfnotFound = false.

Parameters:

problem - The text.