Module gov.nist.secauto.metaschema.databind

Package gov.nist.secauto.metaschema.databind.io.xml

Class MetaschemaXmlReader

java.lang.Object

gov.nist.secauto.metaschema.databind.io.xml.MetaschemaXmlReader

All Implemented Interfaces:

IParsingContext<org.codehaus.stax2.XMLEventReader2,IXmlProblemHandler>, IXmlParsingContext

public class MetaschemaXmlReader
extends Object
implements IXmlParsingContext

Constructor Summary

Constructors

Constructor	Description
MetaschemaXmlReader(org.codehaus.stax2.XMLEventReader2 reader)	Construct a new Module-aware XML parser using the default problem handler.
MetaschemaXmlReader(org.codehaus.stax2.XMLEventReader2 reader, IXmlProblemHandler problemHandler)	Construct a new Module-aware parser.

Method Summary

Modifier and Type	Method	Description
IXmlProblemHandler	getProblemHandler()	A handler that provides callbacks used to resolve parsing issues.
org.codehaus.stax2.XMLEventReader2	getReader()	The parser used for reading data associated with the supported format.
protected boolean	isNextInstance(IBoundNamedModelInstance targetInstance)	Determine if the next data to read corresponds to the next model instance.
<CLASS> CLASS	read(IAssemblyClassBinding targetDefinition)	Parses XML into a bound object based on the provided definition.
<T> T	readDefinitionValue(IClassBinding targetDefinition, Object parentObject, StartElement start)	Reads a XML element storing the associated data in a Java class instance, returning the resulting instance.
protected void	readFieldValue(IFieldClassBinding targetDefinition, Object targetObject)	Read the XML element and text data described by the targetDefinition and apply it to the provided targetObject.
protected void	readFlagInstances(IClassBinding targetDefinition, Object targetObject, StartElement start)	Read the XML attribute data described by the targetDefinition and apply it to the provided targetObject.
protected void	readModelInstances(IAssemblyClassBinding targetDefinition, Object targetObject, StartElement start)	Read the XML element data described by the targetDefinition and apply it to the provided targetObject.
protected Object	readModelInstanceValue(IBoundAssemblyInstance instance, Object parentObject, StartElement start)	Read the XML data associated with the instance and apply it to the provided parentObject.
protected Object	readModelInstanceValue(IBoundFieldInstance instance, Object parentObject, StartElement start)	Revise
<T> T	readModelInstanceValue(IBoundNamedModelInstance instance, Object parentObject, StartElement start)	Read the XML data associated with the targetInstance and apply it to the provided parentObject.
protected boolean	readModelInstanceValues(IBoundNamedModelInstance instance, Object parentObject, StartElement start)	Read the data associated with the instance and apply it to the provided parentObject.

Methods inherited from class java.lang.Object

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

Constructor Detail

MetaschemaXmlReader

public MetaschemaXmlReader(@NonNull
                           org.codehaus.stax2.XMLEventReader2 reader)

Construct a new Module-aware XML parser using the default problem handler.

Parameters:

reader - the XML reader to parse with

See Also:

DefaultXmlProblemHandler

MetaschemaXmlReader

public MetaschemaXmlReader(@NonNull
                           org.codehaus.stax2.XMLEventReader2 reader,
                           @NonNull
                           IXmlProblemHandler problemHandler)

Construct a new Module-aware parser.

Parameters:

reader - the XML reader to parse with

problemHandler - the problem handler implementation to use

Method Detail

getReader

public org.codehaus.stax2.XMLEventReader2 getReader()

Description copied from interface: IParsingContext

The parser used for reading data associated with the supported format.

Specified by:

getReader in interface IParsingContext<org.codehaus.stax2.XMLEventReader2,IXmlProblemHandler>

Returns:

the parser

getProblemHandler

public IXmlProblemHandler getProblemHandler()

Description copied from interface: IParsingContext

A handler that provides callbacks used to resolve parsing issues.

Specified by:

getProblemHandler in interface IParsingContext<org.codehaus.stax2.XMLEventReader2,IXmlProblemHandler>

Returns:

the configured handler

read

@NonNull
public <CLASS> CLASS read(@NonNull
                          IAssemblyClassBinding targetDefinition)
                   throws IOException,
                          XMLStreamException

Parses XML into a bound object based on the provided definition.

Parses the XMLStreamConstants.START_DOCUMENT, the root element, and the XMLStreamConstants.END_DOCUMENT.

Type Parameters:

CLASS - the returned object type

Parameters:

targetDefinition - the definition describing the root element data to read

Returns:

the parsed object

Throws:

XMLStreamException - if an error occurred while parsing XML events

IOException - if an error occurred while parsing the input

readDefinitionValue

public <T> T readDefinitionValue(IClassBinding targetDefinition,
                                 Object parentObject,
                                 StartElement start)
                          throws IOException,
                                 XMLStreamException

Description copied from interface: IXmlParsingContext

Reads a XML element storing the associated data in a Java class instance, returning the resulting instance.

When called the next XMLEvent of the XMLStreamReader2 is expected to be a XMLStreamConstants.START_ELEMENT that is the XML element associated with the Java class.

After returning the next XMLEvent of the XMLStreamReader2 is expected to be a the next event after the XMLStreamConstants.END_ELEMENT for the XML XMLStreamConstants.START_ELEMENT element associated with the Java class.

Specified by:

readDefinitionValue in interface IXmlParsingContext

Type Parameters:

T - the resulting object type

Parameters:

targetDefinition - the Module definition that describes the syntax of the data to read

parentObject - the Java object parent of the target object, which can be null if there is no parent

start - the XML element start and attribute data previously parsed

Returns:

the Java object containing the data parsed by this method

Throws:

IOException - if an error occurred while parsing the input

XMLStreamException - if an error occurred while parsing XML events

readFlagInstances

protected void readFlagInstances(@NonNull
                                 IClassBinding targetDefinition,
                                 @NonNull
                                 Object targetObject,
                                 @NonNull
                                 StartElement start)
                          throws IOException,
                                 XMLStreamException

Read the XML attribute data described by the targetDefinition and apply it to the provided targetObject.

Parameters:

targetDefinition - the Module definition that describes the syntax of the data to read

targetObject - the Java object that data parsed by this method will be stored in

start - the containing XML element that was previously parsed

Throws:

IOException - if an error occurred while parsing the input

XMLStreamException - if an error occurred while parsing XML events

readModelInstances

protected void readModelInstances(@NonNull
                                  IAssemblyClassBinding targetDefinition,
                                  @NonNull
                                  Object targetObject,
                                  @NonNull
                                  StartElement start)
                           throws IOException,
                                  XMLStreamException

Read the XML element data described by the targetDefinition and apply it to the provided targetObject.

Parameters:

targetDefinition - the Module definition that describes the syntax of the data to read

targetObject - the Java object that data parsed by this method will be stored in

start - the XML element start and attribute data previously parsed

Throws:

IOException - if an error occurred while parsing the input

XMLStreamException - if an error occurred while parsing XML events

readFieldValue

protected void readFieldValue(@NonNull
                              IFieldClassBinding targetDefinition,
                              @NonNull
                              Object targetObject)
                       throws IOException

Read the XML element and text data described by the targetDefinition and apply it to the provided targetObject.

Parameters:

targetDefinition - the Module definition that describes the syntax of the data to read

targetObject - the Java object that data parsed by this method will be stored in

Throws:

IOException - if an error occurred while parsing the input

isNextInstance

protected boolean isNextInstance(@NonNull
                                 IBoundNamedModelInstance targetInstance)
                          throws XMLStreamException

Determine if the next data to read corresponds to the next model instance.

Parameters:

targetInstance - the model instance that describes the syntax of the data to read

Returns:

true if the Module instance needs to be parsed, or false otherwise

Throws:

XMLStreamException - if an error occurred while parsing XML events

readModelInstanceValues

protected boolean readModelInstanceValues(@NonNull
                                          IBoundNamedModelInstance instance,
                                          @NonNull
                                          Object parentObject,
                                          @NonNull
                                          StartElement start)
                                   throws IOException,
                                          XMLStreamException

Read the data associated with the instance and apply it to the provided parentObject.

Parameters:

instance - the instance to parse data for

parentObject - the Java object that data parsed by this method will be stored in

start - the XML element start and attribute data previously parsed

Returns:

true if the instance was parsed, or false if the data did not contain information for this instance

Throws:

IOException - if an error occurred while parsing the input

XMLStreamException - if an error occurred while parsing XML events

readModelInstanceValue

public <T> T readModelInstanceValue(IBoundNamedModelInstance instance,
                                    Object parentObject,
                                    StartElement start)
                             throws XMLStreamException,
                                    IOException

Description copied from interface: IXmlParsingContext

Read the XML data associated with the targetInstance and apply it to the provided parentObject.

Specified by:

readModelInstanceValue in interface IXmlParsingContext

Type Parameters:

T - the resulting object type

Parameters:

instance - the instance to parse data for

parentObject - the Java object that data parsed by this method will be stored in

start - the XML element start and attribute data previously parsed

Returns:

the Java object read, or null if no data was read

Throws:

XMLStreamException - if an error occurred while parsing XML events

IOException - if an error occurred while parsing the input

readModelInstanceValue

@Nullable
protected Object readModelInstanceValue(@NonNull
                                        IBoundAssemblyInstance instance,
                                        @NonNull
                                        Object parentObject,
                                        @NonNull
                                        StartElement start)
                                 throws XMLStreamException,
                                        IOException

Read the XML data associated with the instance and apply it to the provided parentObject.

Parameters:

instance - the instance to parse data for

parentObject - the Java object that data parsed by this method will be stored in

start - the XML element start and attribute data previously parsed

Returns:

the Java object read, or null if no data was read

Throws:

IOException - if an error occurred while parsing the input

XMLStreamException - if an error occurred while parsing XML events

readModelInstanceValue

@NonNull
protected Object readModelInstanceValue(@NonNull
                                        IBoundFieldInstance instance,
                                        @NonNull
                                        Object parentObject,
                                        @NonNull
                                        StartElement start)
                                 throws XMLStreamException,
                                        IOException

Revise

Reads an individual XML item from the XML stream.

Parameters:

instance - the instance to parse data for

parentObject - the Java object that data parsed by this method will be stored in

start - the XML element start and attribute data previously parsed

Returns:

the Java object read, or null if no data was read

Throws:

IOException - if an error occurred while parsing the input

XMLStreamException - if an error occurred while parsing XML events