rwsf::SoapBase

• Local Index
• Header File
• Description
• Public Constructors
• Destructor
• Public Member Functions
• Static Constant Data Members
• Protected Member Functions
• Protected Data Members

Members

getDefaultElementName() getXsiNil() getXsiNoNamespaceSchemaLocation() getXsiSchemaLocation() getXsiType() isXsiNilSet() isXsiNoNamespaceSchemaLocationSet() isXsiSchemaLocationSet() isXsiTypeSet()

populateAttributes() setXsiNil() setXsiNilSet() setXsiNoNamespaceSchemaLocation() setXsiNoNamespaceSchemaLocationSet() setXsiSchemaLocation() setXsiSchemaLocationSet() setXsiType() setXsiTypeSet()

SoapBase() unmarshalAttributes() XsiNilAttributeName_ XsiNilSet_ XsiNil_ XsiNoNamespaceSchemaLocationAttributeName_ XsiNoNamespaceSchemaLocationSet_ XsiNoNamespaceSchemaLocation_ XsiSchemaLocationAttributeName_

XsiSchemaLocationSet_ XsiSchemaLocation_ XsiTypeAttributeName_ XsiTypeSet_ XsiType_ ~SoapBase()

#include <rw/rwsf/soapworx/SoapBase.h>

Class rwsf::SoapBase is the common abstract base class for all SOAP parsing objects, and contains functionality to get and set values for all xsi attributes, including xsi:type, xsi:nil, xsi:schemaLocation, and xsi:noNamespaceSchemaLocation.

For more information, see section "2.6 Schema-Related Markup in Documents Being Validated" in the W3C specification XML Schema Part 1: Structures, at http://www.w3.org/TR/2001/REC-xmlschema-1-20010502/.

The prefix xsi: indicates a schema instance, and is conventionally mapped to the URI http://www.w3.org/2001/XMLSchema-instance.

SoapBase();

Default constructor. Sets the following defaults:

XsiType_()
XsiTypeSet_(false)
XsiNil_(false)
XsiNilSet_(false)
XsiSchemaLocation_()
XsiSchemaLocationSet_(false)
XsiNoNamespaceSchemaLocation_()
XsiNoNamespaceSchemaLocationSet_(false)

SoapBase(const SoapBase& sb);

Copy constructor. Sets the same defaults for all settings as the object sb.

virtual
~SoapBase();

Destructor.

std::string 
getXsiType() const;

Returns the value of xsi:type.

void 
setXsiType(const std::string& XsiType);

Sets the xsi:type value.

bool 
isXsiTypeSet() const;

Returns true if the xsi:type value is set; otherwise, returns false.

void 
setXsiTypeSet(bool setValue);

Sets the bool value of setXsiTypeSet. A value of true means that the xsi:type has been set.

bool 
getXsiNil() const;

Returns the bool value of xsi:nil. If true, this element should be accepted as valid when empty, even if this is a content type which does not allow empty content. If true, this element must be empty, but can carry attributes if permitted by the corresponding complex type.

void 
setXsiNil(bool XsiNil);

Sets the bool value of xsi:nil. A value of true means that this element should be accepted as valid when empty, even if this is a content type which does not allow empty content. If true, this element must be empty, but can carry attributes if permitted by the corresponding complex type.

bool 
isXsiNilSet() const;

Returns true if the xsi:nil value is set; otherwise, returns false.

void 
setXsiNilSet(bool setValue);

Sets the bool value of XsiNilSet_. A value of true means that the xsi:nil has been set.

std::string 
getXsiSchemaLocation() const;

Returns the xsi:schemaLocation value. The xsi:schemaLocation and xsi:noNamespaceSchemaLocation attributes are optional hints to help locate the physical location of schema documents.

void 
setXsiSchemaLocation(const std::string& XsiSchemaLocation);

Sets the value of xsi:schemaLocation.

bool 
isXsiSchemaLocationSet() const;

Returns true if the xsi:schemaLocation value is set; otherwise, returns false.

void 
setXsiSchemaLocationSet(bool setValue);

Sets the bool value of XsiSchemaLocation_. A value of true means that the xsi:schemaLocation has been set.

std::string 
getXsiNoNamespaceSchemaLocation() const;

Returns the value of XsiNoNamespaceSchemaLocation_. The xsi:schemaLocation and xsi:noNamespaceSchemaLocation attributes are optional hints to help locate the physical location of schema documents.

void 
setXsiNoNamespaceSchemaLocation(const std::string& 
                                XsiNoNamespaceSchemaLocation);

Sets the value of xsi:noNamespaceSchemaLocation.

bool 
isXsiNoNamespaceSchemaLocationSet() const;

Returns true if the xsi:noNamespaceSchemaLocation value is set; otherwise, returns false.

void 
setXsiNoNamespaceSchemaLocationSet(bool setValue);

Sets the bool value of XsiNoNamespaceSchemaLocation_. A value of true means that the xsi:noNamespaceSchemaLocation has been set.

static const rwsf::XmlName   XsiTypeAttributeName_;
static const rwsf::XmlName   XsiNilAttributeName_;
static const rwsf::XmlName   XsiSchemaLocationAttributeName_;
static const rwsf::XmlName   XsiNoNamespaceSchemaLocationAttributeName_;

Defines the keyword and namespace for these attributes. Keywords are, in corresponding order:

type
nil
schemaLocation
noNamespaceSchemaLocation

The namespace for all attributes is http://www.w3.org/2001/XMLSchema-instance.

void 
unmarshalAttributes(rwsf::XmlAttributeSet& attrs);

Unmarshals the attributes in object attrs. For all included attributes, sets the corresponding <attribute>set variable to true. For example, if a XsiTypeAttributeName_ attribute exists, this method sets the variable XsiTypeSet_ to true.

virtual void 
populateAttributes(rwsf::XmlAttributeSet& attributes) const;

Populates this element with the attributes attributes.

virtual rwsf::XmlName 
getDefaultElementName() const = 0;

Pure virtual function. In derived classes, returns the DefaultElementName.

std::string   XsiType_;
bool          XsiTypeSet_;
bool          XsiNil_;
bool          XsiNilSet_;
std::string   XsiSchemaLocation_;
bool          XsiSchemaLocationSet_;
std::string   XsiNoNamespaceSchemaLocation_;
bool          XsiNoNamespaceSchemaLocationSet_;

©2004-2007 Copyright Quovadx, Inc. All Rights Reserved.
Quovadx and Rogue Wave are registered trademarks of Quovadx, Inc. in the United States and other countries. All other trademarks are the property of their respective owners.
Contact Rogue Wave about documentation or support issues.