rwsf::XmlBindingBody
Group: XML Binding
rwsf::XmlBindingBodyrwsf::XmlBindingBodyBase
Local Index
Members
Header File
#include rwsf/xmlbinding/XmlBindingBody.h
Description
XmlBindingBody defines a variety of methods that are common to all generated datatype classes produced by HydraExpress.
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.
Public Member Functions
XmlBindingBodyBase * cloneBody() const;
Implements method in rwsf::XmlBindingBodyBase
Base class documentation:
This method provides an interface function to clone the body.
Implementation documentation:
This method provides an interface function to clone the body.
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.
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.
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.
std::vector< 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.
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 isSimple() const;
Implements method in rwsf::XmlBindingBodyBase
Base class documentation:
Returns true if the object represents a simple type. All derived classes override this function.
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.
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.
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.
void
marshal(rwsf::XmlWriter & writer,
bool includeChildTypeAttributes,
const rwsf::XmlName & elementName,
bool includeSelfTypeAttribute,
bool nilValue) const;
Reimplements method in rwsf::XmlBindingBodyBase
Base class documentation:
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 the 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."
Implementation documentation:
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."
void
set(const rwsf::XmlName &,
const std::vector< Member > &);
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.
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.
const char * typeIdChar() const;
Reimplements method in rwsf::XmlBindingBodyBase
Base class documentation:
Returns the type ID of the object as a character array. All derived classes override this function.
Implementation documentation:
Returns the type ID of the object as a character array. All erated classes override this function.
XmlBindingBodyBase::XmlOLTypeCategory XmlBindingBodyTypeCategory() const;
Implements method in rwsf::XmlBindingBodyBase
Base class documentation:
Pure virtual.
Implementation documentation:
Returns the type category of the body. The type category is the class enumeration with the values simple, complex, message, or soaparray.
rwsf::XmlName xmlType() const;
Reimplements method in rwsf::XmlBindingBodyBase
Base class documentation:
Returns the qualified name of the object. All generated classes override this function.
const char * xsiTypeChar() const;
Returns the xsi:type of the object as a character array. All generated classes override this function.
© 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.