com.prosysopc.ua

Class ModelParserBase

java.lang.Object

com.prosysopc.ua.ModelParserBase

Direct Known Subclasses:

ModelParser, ModelParser

public abstract class ModelParserBase
extends Object

An XML parser for UA Information Model files defined according to the respective schema, http://opcfoundation.org/UA/2011/03/UANodeSet.xsd.

Field Summary

Fields

Modifier and Type	Field and Description
static String	UTF8_BOM

Constructor Summary

Constructors

Constructor and Description
ModelParserBase(UaApplication application) Creates a new ModelParser.

Method Summary

Modifier and Type	Method and Description
protected void	addNamespaceUri(String uri)
protected void	addNodes(List<AddNodesItem> nodes, String type) Adds the given nodes.
protected void	addReferences(List<AddReferencesItem> references) Adds the given References.
protected void	afterCreate(AddNodesItem item) This method is called once for each Variable and Object node created.
protected void	characters(char[] ch, int start, int length) Delegation of the SAX parsing characters method.
void	createModel(boolean failOnFirstError) Creates the previously parsed model into the AddressSpaceHandler specified at initialization.
protected NodeId	doAddNode(AddNodesItem item) Add a new node to the address space.
protected void	doAddReference(AddReferencesItem item) Add a new reference to the address space.
protected void	endElement(String uri, String localName, String name) Delegation of the SAX parsing endElement method.
EncoderContext	getEncoderContext()
List<String>	getErrorList() Returns a list of errors that happened during model loading.
Collection<ExpandedNodeId>	getIgnoredNodes() These nodes are ignored when model is loaded.
protected NamespaceTable	getNamespaceTable() Returns the Application-related NamespaceTable, by default uses UaApplication.getNamespaceTable() from the given constructor parameter.
protected abstract UaNode	getNode(NodeId nodeId) Get an existing node in the address space.
List<AddNodesItem>	getNodes() Returns a list of loaded nodes.
List<AddReferencesItem>	getReferences() Returns a list of loaded references.
protected ServerTable	getServerTable() Returns the Application-related ServerTable, by default uses UaApplication.getServerTable() from the given constructor parameter.
boolean	isFailOnFirstError() If true then the model loading is stopped on first error.
protected boolean	isIgnoredReference(AddReferencesItem item)
boolean	isReadingExtensions()
protected boolean	isReadingNamespaces()
static boolean	isSkipValuesOnAndroid() If true the Value tags are skipped when loading models on Android.
void	parseFile(InputStream inputStream) Reads a XML NodeSet file and loads its information into an internal buffer.
void	parseFile(InputStream inputStream, Charset charset) Reads a XML NodeSet file and loads its information into an internal buffer.
void	parseFile(URI uri) Reads a XML NodeSet file and loads its information into an internal buffer.
void	setFailOnFirstError(boolean failOnFirstError) Define whether #createModel() should fail on the first error found in the model.
void	setIgnoredNodes(Collection<ExpandedNodeId> ignoredNodes) Adds the given nodes to the set of ignored nodes.
static void	setSkipValuesOnAndroid(boolean skipValuesOnAndroid) If set to true, skip finalizing value tags from the NodeSet2 xml.
protected void	startElement(String uri, String localName, String name, Attributes attributes) Delegation of the SAX parsing startElement method.
protected ExpandedNodeId	toGlobalExpandedNodeId(NodeId nodeId) Transforms a model-local-NodeId to ExpandedNodeId with the namespaceuri.
protected NodeId	toGlobalNodeId(ExpandedNodeId nodeId) Transforms ExpandedNodeId with the uri to application-indexed NodeId.
protected NodeId	toGlobalNodeId(NodeId nodeId) Transforms a model-local NodeId to application-indexed NodeId.

Methods inherited from class java.lang.Object

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

Field Detail

UTF8_BOM

public static final String UTF8_BOM

See Also:

Constant Field Values

Constructor Detail

ModelParserBase

public ModelParserBase(UaApplication application)

Creates a new ModelParser.

Method Detail

isSkipValuesOnAndroid

public static boolean isSkipValuesOnAndroid()

If true the Value tags are skipped when loading models on Android.

Returns:

the flag value

See Also:

setSkipValuesOnAndroid(boolean)

setSkipValuesOnAndroid

public static void setSkipValuesOnAndroid(boolean skipValuesOnAndroid)

If set to true, skip finalizing value tags from the NodeSet2 xml. This is by default false.

Some older android versions do not have a StAX parser, which would be needed for the value tag parsing.

createModel

public void createModel(boolean failOnFirstError)
                 throws ModelException,
                        ServiceException

Creates the previously parsed model into the AddressSpaceHandler specified at initialization.

Parameters:

failOnFirstError - make the model creation fail for the first error encountered. If false, the model is parsed fully and possible errors are raised only at the end.

Throws:

ModelException - if there is a problem with the model and it cannot be fully created. The exception is thrown for individual nodes only if isFailOnFirstError() is true. Otherwise, it will be filled with and errorList.

ServiceException - if the nodes cannot be added to the server due to a service exception (most likely when done from the client side)

getEncoderContext

public EncoderContext getEncoderContext()

getErrorList

public List<String> getErrorList()

Returns a list of errors that happened during model loading.

getIgnoredNodes

public Collection<ExpandedNodeId> getIgnoredNodes()

These nodes are ignored when model is loaded.

getNodes

public List<AddNodesItem> getNodes()

Returns a list of loaded nodes.

getReferences

public List<AddReferencesItem> getReferences()

Returns a list of loaded references.

isFailOnFirstError

public boolean isFailOnFirstError()

If true then the model loading is stopped on first error. If false the model will be loaded as far as possible and then all errors reported.

isReadingExtensions

public boolean isReadingExtensions()

parseFile

public void parseFile(InputStream inputStream)
               throws IOException,
                      SAXException,
                      ModelException

Reads a XML NodeSet file and loads its information into an internal buffer. Use #createModel() to create the nodes from the buffer.

Parameters:

inputStream - the model file to parse (from stream)

Throws:

SAXException - if the required XMLReaded cannot be created.

IOException - if the model file cannot be read.

ModelException - if the file contains model errors

parseFile

public void parseFile(InputStream inputStream,
                      Charset charset)
               throws IOException,
                      SAXException,
                      ModelException

Reads a XML NodeSet file and loads its information into an internal buffer. Use #createModel() to create the nodes from the buffer.

Parameters:

inputStream - the model file to parse (from stream)

charset - the character set of the model file (stream) default is UTF-8

Throws:

SAXException - if the required XMLReaded cannot be created.

IOException - if the model file cannot be read.

ModelException - if the file contains model errors

parseFile

public void parseFile(URI uri)
               throws SAXException,
                      IOException,
                      ModelException

Reads a XML NodeSet file and loads its information into an internal buffer. Use #createModel() to create the nodes from the buffer.

Parameters:

uri - the model file to parse

Throws:

SAXException - if the required XMLReaded cannot be created.

IOException - if the model file cannot be read.

ModelException - if the file contains model errors

setFailOnFirstError

public void setFailOnFirstError(boolean failOnFirstError)

Define whether #createModel() should fail on the first error found in the model.

Parameters:

failOnFirstError - the failOnFirstError to set

setIgnoredNodes

public void setIgnoredNodes(Collection<ExpandedNodeId> ignoredNodes)

Adds the given nodes to the set of ignored nodes.

addNamespaceUri

protected void addNamespaceUri(String uri)

addNodes

protected void addNodes(List<AddNodesItem> nodes,
                        String type)
                 throws ModelException,
                        ServiceException

Adds the given nodes.

Throws:

ModelException

ServiceException

addReferences

protected void addReferences(List<AddReferencesItem> references)
                      throws ModelException

Adds the given References.

Throws:

ModelException

afterCreate

protected void afterCreate(AddNodesItem item)

This method is called once for each Variable and Object node created. First call is after they all have been added to the address space. The default implementation does nothing.

characters

protected void characters(char[] ch,
                          int start,
                          int length)

Delegation of the SAX parsing characters method.

doAddNode

protected NodeId doAddNode(AddNodesItem item)
                    throws StatusException,
                           ServiceException

Add a new node to the address space.

Parameters:

item - the definition of the new node.

Returns:

the ID of the added node

Throws:

StatusException - on failure

ServiceException - on failure

doAddReference

protected void doAddReference(AddReferencesItem item)
                       throws StatusException,
                              ServiceException

Add a new reference to the address space.

Parameters:

item - definition of the new reference.

Throws:

StatusException - on failure.

ServiceException - on failure.

endElement

protected void endElement(String uri,
                          String localName,
                          String name)
                   throws SAXException

Delegation of the SAX parsing endElement method.

Throws:

SAXException

getNamespaceTable

protected NamespaceTable getNamespaceTable()

Returns the Application-related NamespaceTable, by default uses UaApplication.getNamespaceTable() from the given constructor parameter. IMPORTANT! This is separate from the NodeSet's mappings, as it has it's own model-related-table.

getNode

protected abstract UaNode getNode(NodeId nodeId)
                           throws StatusException

Get an existing node in the address space.

Throws:

StatusException

getServerTable

protected ServerTable getServerTable()

Returns the Application-related ServerTable, by default uses UaApplication.getServerTable() from the given constructor parameter. IMPORTANT! This is separate from the NodeSet's mappings, as it has it's own model-related-table.

isIgnoredReference

protected boolean isIgnoredReference(AddReferencesItem item)

isReadingNamespaces

protected boolean isReadingNamespaces()

startElement

protected void startElement(String uri,
                            String localName,
                            String name,
                            Attributes attributes)
                     throws SAXException

Delegation of the SAX parsing startElement method.

Throws:

SAXException

toGlobalExpandedNodeId

protected ExpandedNodeId toGlobalExpandedNodeId(NodeId nodeId)

Transforms a model-local-NodeId to ExpandedNodeId with the namespaceuri.

toGlobalNodeId

protected NodeId toGlobalNodeId(ExpandedNodeId nodeId)

Transforms ExpandedNodeId with the uri to application-indexed NodeId.

toGlobalNodeId

protected NodeId toGlobalNodeId(NodeId nodeId)

Transforms a model-local NodeId to application-indexed NodeId.