rwsf::XmlBindingBody
Library: XML Binding
rwsf::XmlBindingBodyrwsf::BodyBase
Local Index
Members
Non-Members
Header File
#include <rwsf/XmlBinding/XmlBindingBody.h>
Description
These classes implement methods that at one time were generated into all of the generated datatype classes that HydraExpress produces. To simplify the generated classes, they were made to inherit from rwsf::XmlBindingHandle, making all methods available as inherited methods.
All methods in this class are overridden by the generated classes.
The documentation generated for XML bindings includes a topic Inherited Methods that describes these methods. The descriptions are provided below for convenience.
Global Logical Operators
bool
operator==(const rwsf::XmlBindingBody& first,
const rwsf::XmlBindingBody& second)
Returns true if first is equal to second. Equality is determined through the public equals() method described below. This method forwards to the virtual operator==() member operator in each generated datatype class.
bool
operator!=(const rwsf::XmlBindingBody& first,
const rwsf::XmlBindingBody& second)
Returns true if first is not equal to second. Equality is determined through the public equals() method described below. This method forwards to the virtual operator!=() member operator in each generated datatype class.
Public Member Functions
virtual XmlBindingBodyBase* cloneBody() const;
This method provides an interface function to clone the body.
virtual XmlBindingBody* doClone() const;
This method creates a deep copy of the object, meaning that it creates a new instance of the body and the new handle points to this new body. All generated classes override this method.
virtual bool equals(const XmlBindingBody& second) const;
Returns true if the supplied XmlBindingBody object second is equal to this. Equality is determined by a one-to-one comparison of the data members, all of which must be equivalent.
virtual int exists(const rwsf::XmlName& member)
Determines whether member exists. If member contains an array of elements, returns its length. If member contains a single element, returns 1. If member does not exist, returns 0. All generated classes override this method.
virtual std::vector<rwsf::Member> get(const rwsf::XmlName& member);
Returns the values for the member named within member as rwsf::Member instances in a std::vector. All generated classes override this method.
bool
getXsiNil() const;
Returns the value of the nil attribute as an instance of bool. The nil attribute indicates whether the given type is nillable.
std::string
getXsiNoNamespaceSchemaLocation() const;
Returns the value of the noNamespaceSchemaLocation attribute as an instance of std::string.
std::string
getXsiSchemaLocation() const;
Returns the value of the schemaLocation attribute as an instance of std::string.
virtual bool isA(const std::string& xsiType) const;
Returns true if this body's xsi:type attribute is either the same as, or derived, from the xsi:type passed in; otherwise returns false.
bool isMarshalXsiTypeSet() const;
Returns true if the object contains a marshallable value for the xsi:type attribute, false otherwise. When this function returns true, the marshal methods will marshal the xsi:type attribute.
bool
isXsiNilSet() const;
Returns true if the object contains a marshallable value for the nil attribute, false otherwise. When this function returns true, the marshal methods will marshal the nil attribute.
bool isXsiNoNamespaceSchemaLocationSet() const;
Returns true if the object contains a marshallable value for the noNamespaceSchemaLocation attribute, false otherwise. When this function returns true, the marshal methods will marshal the noNamespaceSchemaLocation attribute.
bool
isXsiSchemaLocationSet() const;
Returns true if the object contains a marshallable value for the schemaLocation attribute, false otherwise.
virtual bool isValid() const;
Returns true if all of the validity checks for the simple type data associated with this class return true. If one or more of the validity checks returns false, this method returns false. The validity checks are based on facets specified for the simple types, except for the validation of vectors that represent collections of elements whose minOccurs and maxOccurs attributes permit two or more elements to occur within a given context. In this case, the validity check tests that the vector holds an allowable number of occurrences.
virtual bool isValid(rwsf::XmlValidator& validator) const;
Checks validity exactly the same as the default method, except that the validity checks are through the validator reference passed in the method call. If this method returns false, the provided validator's getErrors() method can be used to retrieve the Standard C++ Library vector that holds instances of rwsf::XmlSchemaException describing the errors found.
virtual void
marshal(rwsf::XmlWriter& writer,
bool includeChildTypeAttributes,
const rwsf::XmlName& elementName,
bool includeSelfTypeAttribute,
bool nilValue) const
Virtual void. In the generated classes, creates an XML element from this object, 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 Section 8.5.6, "nillable Elements," in the HydraExpress XML Binding Development Guide.
Note that this method does not marshal the XML element directly. Rather, it calls a generated external marshaling class, passing all of its input parameters and a reference to this.
Throws a rwsf::Exception message "marshal called on an instance of XmlBindingBody."
virtual void
set(const rwsf::XmlName& member,
const std::vector<rwsf::Member>& vector)
Sets the values of the member named within member, using the values in the supplied vector. The member may represent an element or an attribute, and may have multiple values if it represents a schema element with maxOccurs>1.
void
setMarshalXsiType(bool setValue);
Sets whether the object contains a marshallable value for the xsi:type attribute. Note that calling this function with false does not clear the value of the attribute. The xsi:type attribute is marshalled only when the type is a derived type, or this member function flag is explicitly set.
void
setXsiNil(bool XsiNil);
Sets the value of the nil attribute to the bool provided. After this function is called, the object contains a marshallable value for the nil attribute.
virtual XmlBindingBodyBase::XmlBindingTypeCategory XmlBindingBodyTypeCategory() const
Returns the type category of the body. The type category is the class enumeration with the values simple, complex, message, or soaparray.
void
setXsiNilSet(bool setValue);
Sets whether the object contains a marshallable value for the nil attribute. Note that calling this function with false does not clear the value of the attribute.
void
setXsiNoNamespaceSchemaLocation(const std::string& loc);
Sets the value of the noNamespaceSchemaLocation attribute to the std::string provided. After this function is called, the object contains a marshallable value for the noNamespaceSchemaLocation attribute.
void
setXsiNoNamespaceSchemaLocationSet(bool setValue);
Sets whether the object contains a marshallable value for the noNamespaceSchemaLocation attribute. Note that calling this function with false does not clear the value of the attribute.
void
setXsiSchemaLocation(const std::string& loc);
Sets the value of the schemaLocation attribute to the std::string provided. After this function is called, the object contains a marshallable value for the schemaLocation attribute.
function returns true, the marshal methods will marshal the schemaLocation attribute.
void
setXsiSchemaLocationSet(bool setValue);
Sets whether the object contains a marshallable value for the schemaLocation attribute. Note that calling this function with false does not clear the value of the attribute.
virtual const char* typeIdChar() const
Returns the type ID of the object as a character array. All gen-erated classes override this function.
virtual const char* xsiTypeChar() const
Returns the xsi:type of the object as a character array. All gener-ated classes override this function.
©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.