com.prosysopc.ua.stack.encoding.xml

Class XmlDecoder

java.lang.Object

com.prosysopc.ua.stack.encoding.AbstractDecoder

com.prosysopc.ua.stack.encoding.xml.XmlDecoder

All Implemented Interfaces:

IDecoder

public class XmlDecoder
extends AbstractDecoder
implements IDecoder

XmlDecoder class.

Field Summary

Fields inherited from class com.prosysopc.ua.stack.encoding.AbstractDecoder

ctx

Constructor Summary

Constructors

Constructor and Description
XmlDecoder(XmlElement element, EncoderContext encoderContext) Constructor for XmlDecoder.
XmlDecoder(XMLStreamReader reader, EncoderContext encoderContext) Constructor for XmlDecoder.

Method Summary

Modifier and Type	Method and Description
void	close() close.
void	close(boolean checkEof) close.
<T> T	get(String fieldName, UaNodeId dataTypeId, int dimensions)
Boolean[]	getBooleanArray(String fieldName) getBooleanArray.
UnsignedByte[]	getByteArray(String fieldName) getByteArray.
ByteString[]	getByteStringArray(String fieldName) getByteStringArray.
DataValue[]	getDataValueArray(String fieldName) getDataValueArray.
DateTime[]	getDateTimeArray(String fieldName) getDateTimeArray.
DiagnosticInfo	getDiagnosticInfo() getDiagnosticInfo.
DiagnosticInfo[]	getDiagnosticInfoArray(String fieldName) getDiagnosticInfoArray.
Double[]	getDoubleArray(String fieldName) getDoubleArray.
void	getEndElement() getEndElement.
ExpandedNodeId[]	getExpandedNodeIdArray(String fieldName) getExpandedNodeIdArray.
ExtensionObject[]	getExtensionObjectArray(String fieldName) getExtensionObjectArray.
Object	getExtensionObjectBody(ExpandedNodeId typeId) getExtensionObjectBody.
Float[]	getFloatArray(String fieldName) getFloatArray.
UUID[]	getGuidArray(String fieldName) getGuidArray.
Short[]	getInt16Array(String fieldName) getInt16Array.
int[]	getInt32Array_(String fieldName) getInt32Array_.
Integer[]	getInt32Array(String fieldName) getInt32Array.
Long[]	getInt64Array(String fieldName) getInt64Array.
LocalizedText[]	getLocalizedTextArray(String fieldName) getLocalizedTextArray.
Object	getMatrix(String fieldName)
NamespaceTable	getNamespaceTable() Getter for the field namespaceTable.
NodeId[]	getNodeIdArray(String fieldName) getNodeIdArray.
QualifiedName[]	getQualifiedNameArray(String fieldName) getQualifiedNameArray.
Byte[]	getSByteArray(String fieldName) getSByteArray.
ServerTable	getServerTable() Getter for the field serverTable.
void	getStartElement() getStartElement.
StatusCode[]	getStatusCodeArray(String fieldName) getStatusCodeArray.
String[]	getStringArray(String fieldName) getStringArray.
UnsignedShort[]	getUInt16Array(String fieldName) getUInt16Array.
UnsignedInteger[]	getUInt32Array(String fieldName) getUInt32Array.
UnsignedLong[]	getUInt64Array(String fieldName) getUInt64Array.
Variant[]	getVariantArray(String fieldName) getVariantArray.
Object	getVariantContents() getVariantContents.
XmlElement[]	getXmlElementArray(String fieldName) getXmlElementArray.
boolean	loadStringTable(String tableName, String elementName, List<String> stringTable) loadStringTable.
QName	peek(int nodeType) peek.
boolean	peek(String fieldName) peek.
void	setNamespaceTable(NamespaceTable namespaceTable) Define the namespace table to use for mapping the namespace indexes of the XML data to the application data.
void	setServerTable(ServerTable serverTable) Define the server table to use for mapping the server indexes of the XML data to the application data.

Methods inherited from class com.prosysopc.ua.stack.encoding.AbstractDecoder

assertArrayLength, assertByteStringLength, assertStringLength, emptyArrayForClass, getEncoderContext

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.prosysopc.ua.stack.encoding.IDecoder

getBoolean, getByte, getByteString, getDataValue, getDateTime, getDiagnosticInfo, getDouble, getEncoderContext, getExpandedNodeId, getExtensionObject, getFloat, getGuid, getInt16, getInt32, getInt64, getLocalizedText, getNodeId, getQualifiedName, getSByte, getStatusCode, getString, getUInt16, getUInt32, getUInt64, getVariant, getXmlElement

Constructor Detail

XmlDecoder

public XmlDecoder(XmlElement element,
                  EncoderContext encoderContext)
           throws DecodingException

Constructor for XmlDecoder.

Parameters:

element - a XmlElement object.

context - a EncoderContext object.

Throws:

DecodingException - if any.

XmlDecoder

public XmlDecoder(XMLStreamReader reader,
                  EncoderContext encoderContext)
           throws DecodingException

Constructor for XmlDecoder.

Parameters:

reader - a XMLStreamReader object.

context - a EncoderContext object.

Throws:

DecodingException - if any.

Method Detail

close

public void close()
           throws DecodingException

close.

Throws:

DecodingException - if any.

close

public void close(boolean checkEof)
           throws DecodingException

close.

Parameters:

checkEof - a boolean.

Throws:

DecodingException - if any.

get

public <T> T get(String fieldName,
                 UaNodeId dataTypeId,
                 int dimensions)
          throws DecodingException

Specified by:

get in interface IDecoder

Throws:

DecodingException

getBooleanArray

public Boolean[] getBooleanArray(String fieldName)
                          throws DecodingException

Description copied from interface: IDecoder

getBooleanArray.

Specified by:

getBooleanArray in interface IDecoder

Parameters:

fieldName - a String object.

Returns:

an array of Boolean objects.

Throws:

DecodingException - if any.

getByteArray

public UnsignedByte[] getByteArray(String fieldName)
                            throws DecodingException

Description copied from interface: IDecoder

getByteArray.

Specified by:

getByteArray in interface IDecoder

Parameters:

fieldName - a String object.

Returns:

an array of UnsignedByte objects.

Throws:

DecodingException - if any.

getByteStringArray

public ByteString[] getByteStringArray(String fieldName)
                                throws DecodingException

Description copied from interface: IDecoder

getByteStringArray.

Specified by:

getByteStringArray in interface IDecoder

Parameters:

fieldName - a String object.

Returns:

an array of byte.

Throws:

DecodingException - if any.

getDataValueArray

public DataValue[] getDataValueArray(String fieldName)
                              throws DecodingException

Description copied from interface: IDecoder

getDataValueArray.

Specified by:

getDataValueArray in interface IDecoder

Parameters:

fieldName - a String object.

Returns:

an array of DataValue objects.

Throws:

DecodingException - if any.

getDateTimeArray

public DateTime[] getDateTimeArray(String fieldName)
                            throws DecodingException

Description copied from interface: IDecoder

getDateTimeArray.

Specified by:

getDateTimeArray in interface IDecoder

Parameters:

fieldName - a String object.

Returns:

an array of DateTime objects.

Throws:

DecodingException - if any.

getDiagnosticInfo

public DiagnosticInfo getDiagnosticInfo()
                                 throws DecodingException

getDiagnosticInfo.

Returns:

a DiagnosticInfo object.

Throws:

DecodingException - if any.

getDiagnosticInfoArray

public DiagnosticInfo[] getDiagnosticInfoArray(String fieldName)
                                        throws DecodingException

Description copied from interface: IDecoder

getDiagnosticInfoArray.

Specified by:

getDiagnosticInfoArray in interface IDecoder

Parameters:

fieldName - a String object.

Returns:

an array of DiagnosticInfo objects.

Throws:

DecodingException - if any.

getDoubleArray

public Double[] getDoubleArray(String fieldName)
                        throws DecodingException

Description copied from interface: IDecoder

getDoubleArray.

Specified by:

getDoubleArray in interface IDecoder

Parameters:

fieldName - a String object.

Returns:

an array of Double objects.

Throws:

DecodingException - if any.

getEndElement

public void getEndElement()
                   throws DecodingException

getEndElement.

Throws:

DecodingException - if any.

getExpandedNodeIdArray

public ExpandedNodeId[] getExpandedNodeIdArray(String fieldName)
                                        throws DecodingException

Description copied from interface: IDecoder

getExpandedNodeIdArray.

Specified by:

getExpandedNodeIdArray in interface IDecoder

Parameters:

fieldName - a String object.

Returns:

an array of ExpandedNodeId objects.

Throws:

DecodingException - if any.

getExtensionObjectArray

public ExtensionObject[] getExtensionObjectArray(String fieldName)
                                          throws DecodingException

Description copied from interface: IDecoder

getExtensionObjectArray.

Specified by:

getExtensionObjectArray in interface IDecoder

Parameters:

fieldName - a String object.

Returns:

an array of ExtensionObject objects.

Throws:

DecodingException - if any.

getExtensionObjectBody

public Object getExtensionObjectBody(ExpandedNodeId typeId)
                              throws DecodingException

getExtensionObjectBody.

Parameters:

typeId - a ExpandedNodeId object.

Returns:

a Object object.

Throws:

DecodingException - if any.

getFloatArray

public Float[] getFloatArray(String fieldName)
                      throws DecodingException

getFloatArray.

Specified by:

getFloatArray in interface IDecoder

Parameters:

fieldName - a String object.

Returns:

an array of Float objects.

Throws:

DecodingException - if any.

getGuidArray

public UUID[] getGuidArray(String fieldName)
                    throws DecodingException

Description copied from interface: IDecoder

getGuidArray.

Specified by:

getGuidArray in interface IDecoder

Parameters:

fieldName - a String object.

Returns:

an array of UUID objects.

Throws:

DecodingException - if any.

getInt16Array

public Short[] getInt16Array(String fieldName)
                      throws DecodingException

Description copied from interface: IDecoder

getInt16Array.

Specified by:

getInt16Array in interface IDecoder

Parameters:

fieldName - a String object.

Returns:

an array of Short objects.

Throws:

DecodingException - if any.

getInt32Array

public Integer[] getInt32Array(String fieldName)
                        throws DecodingException

Description copied from interface: IDecoder

getInt32Array.

Specified by:

getInt32Array in interface IDecoder

Parameters:

fieldName - a String object.

Returns:

an array of Integer objects.

Throws:

DecodingException - if any.

getInt32Array_

public int[] getInt32Array_(String fieldName)
                     throws DecodingException

Description copied from interface: IDecoder

getInt32Array_.

Specified by:

getInt32Array_ in interface IDecoder

Parameters:

fieldName - a String object.

Returns:

an array of int.

Throws:

DecodingException - if any.

getInt64Array

public Long[] getInt64Array(String fieldName)
                     throws DecodingException

Description copied from interface: IDecoder

getInt64Array.

Specified by:

getInt64Array in interface IDecoder

Parameters:

fieldName - a String object.

Returns:

an array of Long objects.

Throws:

DecodingException - if any.

getLocalizedTextArray

public LocalizedText[] getLocalizedTextArray(String fieldName)
                                      throws DecodingException

Description copied from interface: IDecoder

getLocalizedTextArray.

Specified by:

getLocalizedTextArray in interface IDecoder

Parameters:

fieldName - a String object.

Returns:

an array of LocalizedText objects.

Throws:

DecodingException - if any.

getMatrix

public Object getMatrix(String fieldName)
                 throws DecodingException

Throws:

DecodingException

getNamespaceTable

public NamespaceTable getNamespaceTable()

Getter for the field namespaceTable.

Returns:

the namespaceTable

getNodeIdArray

public NodeId[] getNodeIdArray(String fieldName)
                        throws DecodingException

Description copied from interface: IDecoder

getNodeIdArray.

Specified by:

getNodeIdArray in interface IDecoder

Parameters:

fieldName - a String object.

Returns:

an array of NodeId objects.

Throws:

DecodingException - if any.

getQualifiedNameArray

public QualifiedName[] getQualifiedNameArray(String fieldName)
                                      throws DecodingException

Description copied from interface: IDecoder

getQualifiedNameArray.

Specified by:

getQualifiedNameArray in interface IDecoder

Parameters:

fieldName - a String object.

Returns:

an array of QualifiedName objects.

Throws:

DecodingException - if any.

getSByteArray

public Byte[] getSByteArray(String fieldName)
                     throws DecodingException

Description copied from interface: IDecoder

getSByteArray.

Specified by:

getSByteArray in interface IDecoder

Parameters:

fieldName - a String object.

Returns:

an array of Byte objects.

Throws:

DecodingException - if any.

getServerTable

public ServerTable getServerTable()

Getter for the field serverTable.

Returns:

the serverTable

getStartElement

public void getStartElement()
                     throws DecodingException

getStartElement.

Throws:

DecodingException - if any.

getStatusCodeArray

public StatusCode[] getStatusCodeArray(String fieldName)
                                throws DecodingException

Description copied from interface: IDecoder

getStatusCodeArray.

Specified by:

getStatusCodeArray in interface IDecoder

Parameters:

fieldName - a String object.

Returns:

an array of StatusCode objects.

Throws:

DecodingException - if any.

getStringArray

public String[] getStringArray(String fieldName)
                        throws DecodingException

getStringArray.

Specified by:

getStringArray in interface IDecoder

Parameters:

fieldName - a String object.

Returns:

an array of String objects.

Throws:

DecodingException - if any.

getUInt16Array

public UnsignedShort[] getUInt16Array(String fieldName)
                               throws DecodingException

Description copied from interface: IDecoder

getUInt16Array.

Specified by:

getUInt16Array in interface IDecoder

Parameters:

fieldName - a String object.

Returns:

an array of UnsignedShort objects.

Throws:

DecodingException - if any.

getUInt32Array

public UnsignedInteger[] getUInt32Array(String fieldName)
                                 throws DecodingException

Description copied from interface: IDecoder

getUInt32Array.

Specified by:

getUInt32Array in interface IDecoder

Parameters:

fieldName - a String object.

Returns:

an array of UnsignedInteger objects.

Throws:

DecodingException - if any.

getUInt64Array

public UnsignedLong[] getUInt64Array(String fieldName)
                              throws DecodingException

Description copied from interface: IDecoder

getUInt64Array.

Specified by:

getUInt64Array in interface IDecoder

Parameters:

fieldName - a String object.

Returns:

an array of UnsignedLong objects.

Throws:

DecodingException - if any.

getVariantArray

public Variant[] getVariantArray(String fieldName)
                          throws DecodingException

Description copied from interface: IDecoder

getVariantArray.

Specified by:

getVariantArray in interface IDecoder

Parameters:

fieldName - a String object.

Returns:

an array of Variant objects.

Throws:

DecodingException - if any.

getVariantContents

public Object getVariantContents()
                          throws DecodingException

getVariantContents.

Returns:

a Object object.

Throws:

DecodingException - if any.

getXmlElementArray

public XmlElement[] getXmlElementArray(String fieldName)
                                throws DecodingException

Description copied from interface: IDecoder

getXmlElementArray.

Specified by:

getXmlElementArray in interface IDecoder

Parameters:

fieldName - a String object.

Returns:

an array of XmlElement objects.

Throws:

DecodingException - if any.

loadStringTable

public boolean loadStringTable(String tableName,
                               String elementName,
                               List<String> stringTable)
                        throws DecodingException

loadStringTable.

Parameters:

tableName - a String object.

elementName - a String object.

stringTable - a List object.

Returns:

a boolean.

Throws:

DecodingException - if any.

peek

public QName peek(int nodeType)

peek.

Parameters:

nodeType - a int.

Returns:

a QName object.

peek

public boolean peek(String fieldName)

peek.

Parameters:

fieldName - a String object.

Returns:

a boolean.

setNamespaceTable

public void setNamespaceTable(NamespaceTable namespaceTable)

Define the namespace table to use for mapping the namespace indexes of the XML data to the application data.

Parameters:

namespaceTable - a NamespaceTable object.

setServerTable

public void setServerTable(ServerTable serverTable)

Define the server table to use for mapping the server indexes of the XML data to the application data.

Parameters:

serverTable - a ServerTable object.