com.highqsoft.ods

Class XMLConverter

java.lang.Object

com.highqsoft.ods.XMLConverter

public class XMLConverter
extends java.lang.Object

This is a class to write XML files into a AoParameter AoParameterSet structure and vice versa.

Since:

$Date: 2017/04/06 13:29:36 $

Version:

$Revision: 1.10 $

Author:

Andreas Hofmann

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	MIME_DOCUMENT
static java.lang.String	MIME_NODE

Constructor Summary

Constructors

Constructor and Description
XMLConverter()

Method Summary

Methods

Modifier and Type	Method and Description
org.w3c.dom.Document	convert(AoSession aoSession, ElemId elemId) Convert the given root element to a document.
InstanceElement	convert(org.w3c.dom.Document doc, AoSession aoSession, ApplicationElement aeObj)
InstanceElement	convert(org.w3c.dom.Document doc, AoSession aoSession, java.lang.String aeElement)
AIDNameValueSeqUnitId[]	createNVUs(java.util.Map<java.lang.String,java.util.List> listMap, T_LONGLONG aeId, java.lang.String aeName) Create the array of attribute to create the instances.
void	createParameter(java.util.Map<java.lang.String,java.util.List> listMap, java.lang.String name, java.lang.String value, T_LONGLONG parIdx) Create a parameter instance entry.
int	createParameterSet(java.util.Map<java.lang.String,java.util.List> listMap, java.lang.String name, java.lang.String mimetype) Create the paraemter set.
boolean	isShorten() The parameter value will be shorten, when this value is set to true.
void	setXMLParentIds(java.util.Map<java.lang.String,java.util.List> parMap, ElemId[] ids) Replace the #root values with the real id of the root.
void	shorten(boolean shorten) The parameter value will be shorten, when this value is set to true.
void	writeChildren(java.util.Map<java.lang.String,java.util.List> setMap, java.util.Map<java.lang.String,java.util.List> parMap, org.w3c.dom.NodeList children) Write the children of an element.

Methods inherited from class java.lang.Object

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

Field Detail

MIME_DOCUMENT

public static final java.lang.String MIME_DOCUMENT

See Also:

Constant Field Values

MIME_NODE

public static final java.lang.String MIME_NODE

See Also:

Constant Field Values

Constructor Detail

XMLConverter

public XMLConverter()

Method Detail

convert

public InstanceElement convert(org.w3c.dom.Document doc,
                      AoSession aoSession,
                      java.lang.String aeElement)
                        throws AoException,
                               java.lang.Exception

Throws:

AoException

java.lang.Exception

convert

public InstanceElement convert(org.w3c.dom.Document doc,
                      AoSession aoSession,
                      ApplicationElement aeObj)
                        throws AoException,
                               java.lang.Exception

Throws:

AoException

java.lang.Exception

writeChildren

public void writeChildren(java.util.Map<java.lang.String,java.util.List> setMap,
                 java.util.Map<java.lang.String,java.util.List> parMap,
                 org.w3c.dom.NodeList children)
                   throws AoException

Write the children of an element.

Parameters:

setMap - The map holding the attributes of the parameter sets.

parMap - the amp holding the attributes of the parameters.

children - The children to be written.

Throws:

AoException

createParameterSet

public int createParameterSet(java.util.Map<java.lang.String,java.util.List> listMap,
                     java.lang.String name,
                     java.lang.String mimetype)
                       throws AoException

Create the paraemter set.

Parameters:

listMap - the map that hold all parameter sets.

name - the name of the parameter set.

mimetype - the mimetype.

Returns:

the index into the reusltant array.

Throws:

AoException

createParameter

public void createParameter(java.util.Map<java.lang.String,java.util.List> listMap,
                   java.lang.String name,
                   java.lang.String value,
                   T_LONGLONG parIdx)
                     throws AoException

Create a parameter instance entry.

Parameters:

listMap - the list holding all entries.

name - the name of the parameter.

value - the value of the parameter.

parIdx - the parent index.

Throws:

AoException

createNVUs

public AIDNameValueSeqUnitId[] createNVUs(java.util.Map<java.lang.String,java.util.List> listMap,
                                 T_LONGLONG aeId,
                                 java.lang.String aeName)

Create the array of attribute to create the instances.

Parameters:

listMap - the map of all attributes.

aeId - the application element id.

aeName - the application element name.

Returns:

the sequence

setXMLParentIds

public void setXMLParentIds(java.util.Map<java.lang.String,java.util.List> parMap,
                   ElemId[] ids)

Replace the #root values with the real id of the root.

Parameters:

parMap - the map with parameter attributes.

ids - the parameter set ids.

shorten

public void shorten(boolean shorten)

The parameter value will be shorten, when this value is set to true. By default it is set to false;

Parameters:

shorten -

isShorten

public boolean isShorten()

The parameter value will be shorten, when this value is set to true. By default it is set to false;

convert

public org.w3c.dom.Document convert(AoSession aoSession,
                           ElemId elemId)
                             throws AoException,
                                    java.lang.Exception

Convert the given root element to a document.

Parameters:

aoSession - the session.

elemId - the root element.

Returns:

the new document.

Throws:

AoException

java.lang.Exception