rwsf::XmlMarshaller

rwsf::XmlMarshallerrwsf::Marshaller

• Local Index
• Header File
• Description
• Public Static Member Functions
• Public Member Functions

Members

getFormat() marshal()

unmarshal() unmarshalFromXsiType()

unmarshalXsiAttributes() unmarshalXsiType()

#include rwsf/xmlbinding/XmlMarshaller.h

The base class for the generated marshalling classes that marshal and unmarshal XML documents.

The pure virtual methods dispatch to the static member functions in the generated classes. These methods are used in cases where the schema allows substitutability via sub-typing or substitution groups.

The static methods are used to unmarshal elements whose type is ambiguous because they may be a base type or one of its derived types. Such elements require an xsi:type attribute in the instance document, and the element is unmarshaled into the correct type based on this attribute value.

bool
unmarshalFromXsiType(rwsf::XmlReader & reader,
    rwsf::XmlBindingHandle & aHandle,
    const std::string & marshalNameSuffix,
    const rwsf::XmlName & elementName);

Unmarshals based on an xsi:type value, to handle cases where the true type is ambiguous because it could be a base type or a derived type.

This method first determines the xsi:type value through a call to unmarshalXsiType(). It then acquires instances of the needed datatype and marshaling classes from rwsf::XmlBindingFactory. The actual marshaling is accomplished through a call to the virtual unmarshalInner() method.

Before invocation, this method expects the caller to have prepared the reader with a call to readElementStart() on the target element.

Returns true if the operation was a success, false otherwise.

void
unmarshalXsiAttributes(rwsf::XmlReaderAttributeList & attrs,
    rwsf::XmlAttributeSet & attributes,
    rwsf::XmlBindingHandle & aHandle);

Calls setXsiNil(), setXsiSchemaLocation(), and setXsiNoNamespaceSchemaLocation() on the provided handle with appropriate values for these xsi:type attributes, if they are present in attrs. Any other attributes present in attrs are added to the supplied attribute set attributes.

void
unmarshalXsiType(const rwsf::XmlReader & reader,
    std::string & localName,
    std::string & prefix,
    std::string & namespaceURI);

Parses the xsi:type attribute and populates the input-output parameters localName, prefix, and namespaceURI with the XML element name, XML namespace prefix, and XML namespace URI respectively.

This method is normally called by unmarshalFromXsiType().

Before invocation, this method expects the caller to have prepared the reader with a call to readElementStart() on the target element.

const char *
getFormat() const;

Implements method in rwsf::Marshaller

Base class documentation:

Pure virtual method.

void
marshal(rwsf::XmlWriter & writer,
    const rwsf::XmlBindingHandle & aHandle,
    bool includeChildTypeAttributes,
    const rwsf::XmlName & elementName,
    bool includeSelfTypeAttribute = false,
    bool nilValue = false) = 0;

Dispatches to the implemented method in the generated marshaling class.

Creates an XML element from the handle provided, using writer as the destination for the XML. When includeChildTypeAttributes is true, the element includes type attributes on each contained element. The elementName argument sets the name of the XML element. When includeSelfTypeAttribute is true, the element itself contains a type attribute.

The nilValue parameter controls the marshalling of schema elements with a nillable=true attribute. The nilValue parameter is set by the generated code when calling this method to create correct marshalling behavior. For information on how to control nillable elements in your code, see the discussion of nillable in Section 8.5.6, "nillable Elements," in the HydraExpress XML Binding Development Guide.

void
unmarshal(rwsf::XmlReader & reader,
    rwsf::XmlBindingHandle & aHandle,
    const rwsf::XmlName & elementName) = 0;

Populates the provided handle instance from the reader provided. Uses elementName as the name of the element to unmarshal, or DefaultElementName if no elementName is provided.

rwsf::XmlBindingHandle
unmarshal(rwsf::XmlReader & reader,
    const rwsf::XmlName & elementName) = 0;

Populates and returns a rwsf::XmlBindingHandle instance from the reader provided. Uses elementName as the name of the element to unmarshal, or DefaultElementName if no elementName is provided.

© Copyright Rogue Wave Software, Inc. All Rights Reserved. All Rights Reserved. Rogue Wave is a registered trademark of Rogue Wave Software, Inc. in the United States and other countries. HydraExpress is a trademark of Rogue Wave Software, Inc. All other trademarks are the property of their respective owners.
Contact Rogue Wave about documentation or support issues.