Package org.xmlet.xsdparser.core

Class XsdParser

java.lang.Object

org.xmlet.xsdparser.core.XsdParser

public class XsdParser
extends Object

XsdParser in the core class of the XsdParser project. It functions as a one shot class, receiving the name of the file to parse in its constructor and storing the parse results in its multiple fields, which can be consulted after the instance is created.

Field Summary

Fields

Modifier and Type	Field	Description
private List<ReferenceBase>	parseElements	A List which contains all the top elements parsed by this class.
private static Map<String,BiFunction<XsdParser,Node,ReferenceBase>>	parseMappers	A Map object that contains a parse function to each XsdAbstractElement concrete type supported by this mapper, this way based on the concrete XsdAbstractElement tag the according parse method can be invoked.
private List<UnsolvedReferenceItem>	parserUnsolvedElementsMap	A List containing all the elements that even after parsing all the elements on the file, don't have a suitable object to replace the reference.
private List<String>	schemaLocations	A List containing the paths of files that were present in either XsdInclude or XsdImport objects that are present in the original or subsequent files.
private List<UnsolvedReference>	unsolvedElements	A List of UnsolvedReference elements that weren't solved.
private static Map<String,String>	xsdTypesToJava	A Map object that contains the all the XSD types and their respective types in the Java language.

Constructor Summary

Constructors

Constructor	Description
XsdParser(String filePath)	The XsdParser constructor will parse the XSD file with the filepath and will also parse all the subsequent XSD files with their path present in xsd:import and xsd:include tags.

Method Summary

Modifier and Type	Method	Description
void	addFileToParse(String schemaLocation)	Adds a new file to the parsing queue.
void	addParsedElement(ReferenceBase wrappedElement)
void	addUnsolvedReference(UnsolvedReference unsolvedReference)	Adds an UnsolvedReference object to the unsolvedElements list which should be solved at a later time in the parsing process.
static Map<String,BiFunction<XsdParser,Node,ReferenceBase>>	getParseMappers()
Stream<XsdElement>	getResultXsdElements()
Stream<XsdSchema>	getResultXsdSchemas()
private Node	getSchemaNode(String filePath)	This function uses DOM to obtain a list of nodes from a XSD file.
List<UnsolvedReferenceItem>	getUnsolvedReferences()
static Map<String,String>	getXsdTypesToJava()
private boolean	isXsdSchema(Node node)	Verifies if a given Node object, i.e.
private void	parseFile(String filePath)	Parses a XSD file and all its containing XSD elements.
private void	replaceUnsolvedReference(Map<String,List<NamedConcreteElement>> concreteElementsMap, UnsolvedReference unsolvedReference)	Replaces a single UnsolvedReference object, with the respective NamedConcreteElement object.
private void	resolveRefs()	This method resolves all the remaining UnsolvedReference objects present after all the elements are parsed.
private void	storeUnsolvedItem(UnsolvedReference unsolvedReference)	Saves an occurrence of an element which couldn't be resolved in the replaceUnsolvedReference(java.util.Map<java.lang.String, java.util.List<org.xmlet.xsdparser.xsdelements.elementswrapper.NamedConcreteElement>>, org.xmlet.xsdparser.xsdelements.elementswrapper.UnsolvedReference) method, which can be accessed at the end of the parsing process in order to verify if were there were any references that couldn't be solved.

Methods inherited from class java.lang.Object

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

Field Detail

parseMappers

private static final Map<String,BiFunction<XsdParser,Node,ReferenceBase>> parseMappers

A Map object that contains a parse function to each XsdAbstractElement concrete type supported by this mapper, this way based on the concrete XsdAbstractElement tag the according parse method can be invoked.

xsdTypesToJava

private static final Map<String,String> xsdTypesToJava

A Map object that contains the all the XSD types and their respective types in the Java language.

parseElements

private List<ReferenceBase> parseElements

A List which contains all the top elements parsed by this class.

unsolvedElements

private List<UnsolvedReference> unsolvedElements

A List of UnsolvedReference elements that weren't solved. This list is consulted after all the elements are parsed in order to find if there is any suitable parsed element to replace the unsolved element.

parserUnsolvedElementsMap

private List<UnsolvedReferenceItem> parserUnsolvedElementsMap

A List containing all the elements that even after parsing all the elements on the file, don't have a suitable object to replace the reference. This list can be consulted after the parsing process to assert if there is any missing information in the XSD file.

schemaLocations

private List<String> schemaLocations

A List containing the paths of files that were present in either XsdInclude or XsdImport objects that are present in the original or subsequent files. These paths are stored to be parsed as well, the parsing process only ends when all the files present in this List are parsed.

Constructor Detail

XsdParser

public XsdParser(String filePath)

The XsdParser constructor will parse the XSD file with the filepath and will also parse all the subsequent XSD files with their path present in xsd:import and xsd:include tags. After parsing all the XSD files present it resolves the references existent in the XSD language, represented by the ref attribute. When this method finishes the parse results and remaining unsolved references are accessible by the getResultXsdSchemas(), getResultXsdElements() and getUnsolvedReferences().

Parameters:

filePath - States the path of the XSD file to be parsed.

Method Detail

parseFile

private void parseFile(String filePath)

Parses a XSD file and all its containing XSD elements. This code iterates on the nodes and parses the supported ones. The supported types are all the XSD types that have their tag present in the parseMappers field.

Parameters:

filePath - The path to the XSD file.

isXsdSchema

private boolean isXsdSchema(Node node)

Verifies if a given Node object, i.e. node is a xsd:schema node.

Parameters:

node - The node to verify.

Returns:

True if the node is a xsd:schema or xs:schema. False otherwise.

getSchemaNode

private Node getSchemaNode(String filePath)
                    throws IOException,
                           SAXException,
                           ParserConfigurationException

This function uses DOM to obtain a list of nodes from a XSD file.

Parameters:

filePath - The path to the XSD file.

Returns:

A list of nodes that represent the node tree of the XSD file with the path received.

Throws:

IOException - If the file parsing throws IOException.

SAXException - if the file parsing throws SAXException.

ParserConfigurationException - If the DocumentBuilderFactory.newDocumentBuilder() throws ParserConfigurationException.

resolveRefs

private void resolveRefs()

This method resolves all the remaining UnsolvedReference objects present after all the elements are parsed. It starts by iterating all parseElements and inserting all the parsed elements with a name attribute in the concreteElementsMap variable. After that it iterates on the unsolvedElements list in order to find if any of the unsolvedReferences can be solved by replacing the unsolvedElement by its matching NamedConcreteElement object, present in the concreteElementsMap. The UnsolvedReference objects matches a NamedConcreteElement object by having its ref attribute with the same value as the name attribute of the NamedConcreteElement.

replaceUnsolvedReference

private void replaceUnsolvedReference(Map<String,List<NamedConcreteElement>> concreteElementsMap,
                                      UnsolvedReference unsolvedReference)

Replaces a single UnsolvedReference object, with the respective NamedConcreteElement object. If there isn't a NamedConcreteElement object to replace the UnsolvedReference object, information is stored informing the user of this Project of the occurrence.

Parameters:

concreteElementsMap - The map containing all named concreteElements.

unsolvedReference - The unsolved reference to solve.

storeUnsolvedItem

private void storeUnsolvedItem(UnsolvedReference unsolvedReference)

Saves an occurrence of an element which couldn't be resolved in the replaceUnsolvedReference(java.util.Map<java.lang.String, java.util.List<org.xmlet.xsdparser.xsdelements.elementswrapper.NamedConcreteElement>>, org.xmlet.xsdparser.xsdelements.elementswrapper.UnsolvedReference) method, which can be accessed at the end of the parsing process in order to verify if were there were any references that couldn't be solved.

Parameters:

unsolvedReference - The unsolved reference which couldn't be resolved.

getUnsolvedReferences

public List<UnsolvedReferenceItem> getUnsolvedReferences()

Returns:

The List of UnsolvedReferenceItem that represent all the objects with a reference that couldn't be solved.

getResultXsdElements

public Stream<XsdElement> getResultXsdElements()

Returns:

A list of all the top level parsed xsd:elements by this class. It doesn't return any other elements apart from xsd:elements. To access the whole element tree use getResultXsdSchemas()

getResultXsdSchemas

public Stream<XsdSchema> getResultXsdSchemas()

Returns:

A List of all the XsdSchema elements parsed by this class. You can use the XsdSchema instances to navigate through the whole element tree.

addUnsolvedReference

public void addUnsolvedReference(UnsolvedReference unsolvedReference)

Adds an UnsolvedReference object to the unsolvedElements list which should be solved at a later time in the parsing process.

Parameters:

unsolvedReference - The unsolvedReference to add to the unsolvedElements list.

addFileToParse

public void addFileToParse(String schemaLocation)

Adds a new file to the parsing queue. This new file appears by having xsd:import or xsd:include tags in the original file to parse.

Parameters:

schemaLocation - A new file path of another XSD file to parse.

getXsdTypesToJava

public static Map<String,String> getXsdTypesToJava()

getParseMappers

public static Map<String,BiFunction<XsdParser,Node,ReferenceBase>> getParseMappers()

addParsedElement

public void addParsedElement(ReferenceBase wrappedElement)