This class models a group element in a XML Schema. More...

#include <Group.h>

Inheritance diagram for te::xsd::Group:

Public Member Functions
Content *	clone () const

Annotation *	getAnnotation () const
	It returns the associated annotation. More...

Content *	getContent () const
	It returns the content of this group. More...

std::string *	getId () const
	It returns a pointer (may be NULL) to the object id. More...

const unsigned int	getMaxOccurs () const
	It returns the maxOccurs values. More...

const unsigned int	getMinOccurs () const
	It returns the minOccurs values. More...

std::string *	getName () const
	It returns the name of the group. More...

QName *	getRef () const
	It returns the reference to a name of another group. More...

	Group (unsigned int minOccurs=1, unsigned int maxOccurs=1, Annotation ann=0, std::string id=0)
	Constructor. More...

	Group (const Group &rhs)
	Copy constructor. More...

Group &	operator= (const Group &rhs)
	Assignment operator. More...

void	setAnnotation (Annotation *ann)
	It sets the associated annotation. More...

void	setContent (Content *c)
	It sets the group content. It can be one of: all \| choice \| sequence. More...

void	setId (std::string *id)
	it sets the id. More...

void	setMaxOccurs (unsigned int maxOccurs)
	It sets the maxOccurs value. More...

void	setMinOccurs (unsigned int minOccurs)
	It sets the minOccurs value. More...

void	setName (std::string *name)
	It sets a name for the group. More...

void	setRef (QName *ref)
	It sets a reference to a name of another group. More...

	~Group ()
	Destructor. More...

Static Public Attributes
static const unsigned int	unbounded = std::numeric_limits<unsigned int>::max()
	Identifer for "unbounded" max values. More...

Protected Attributes
unsigned int	m_maxOccurs
	It specifies the maximum number of times the any element can occur in the parent element. The value can be any number >= 0, or if you want to set no limit on the maximum number, use the value "unbounded". Default value is 1. (Optional) More...

unsigned int	m_minOccurs
	It specifies the minimum number of times the any element can occur in the parent element. The value can be any number >= 0. Default value is 1. (Optional) More...

Private Attributes
Content *	m_content
	It can be one of: all \| choice \| sequence. (Optional) More...

std::string *	m_name
	It specifies a name for the group. (Optional) More...

QName *	m_ref
	It refers to the name of another group. Name and ref attributes cannot both be present. More...

Detailed Description

This class models a group element in a XML Schema.

The group element is used to define a group of elements to be used in complex type definitions.

Note: Parent elements: schema, choice, sequence, complexType, restriction (both simpleContent and complexContent), extension (both simpleContent and complexContent).

Definition at line 52 of file Group.h.

Constructor & Destructor Documentation

te::xsd::Group::Group	(	unsigned int	minOccurs = `1`,
		unsigned int	maxOccurs = `1`,
		Annotation *	ann = `0`,
		std::string *	id = `0`
	)

Constructor.

Parameters

id	It specifies a unique ID for the element. It can be a NULL value.
minOccurs	The minimum number of times the element can occur.
maxOccurs	The maximum number of times the element can occur.

Definition at line 31 of file Group.cpp.

te::xsd::Group::Group ( const Group & rhs )

Copy constructor.

Parameters

rhs	Right-hand-side object.

Definition at line 41 of file Group.cpp.

te::xsd::Group::~Group ( )

Destructor.

Definition at line 51 of file Group.cpp.

Member Function Documentation

te::xsd::Content * te::xsd::Group::clone ( ) const

virtual

Implements te::xsd::Content.

Definition at line 102 of file Group.cpp.

te::xsd::Annotation * te::xsd::Annotated::getAnnotation ( ) const

inherited

It returns the associated annotation.

Returns: The associated annotation.

Definition at line 30 of file Annotated.cpp.

References te::xsd::Annotated::m_annotation.

te::xsd::Content * te::xsd::Group::getContent ( ) const

It returns the content of this group.

Returns: The content of this group.

Definition at line 73 of file Group.cpp.

std::string * te::xsd::Identifiable::getId ( ) const

inherited

It returns a pointer (may be NULL) to the object id.

Definition at line 35 of file Identifiable.cpp.

const unsigned int te::xsd::Occurs::getMaxOccurs ( ) const

inherited

It returns the maxOccurs values.

Returns: The maxOccurs value.

Definition at line 40 of file Occurs.cpp.

const unsigned int te::xsd::Occurs::getMinOccurs ( ) const

inherited

It returns the minOccurs values.

Returns: The minOccurs value.

Definition at line 35 of file Occurs.cpp.

References te::xsd::Occurs::m_minOccurs.

std::string * te::xsd::Group::getName ( ) const

It returns the name of the group.

Returns: The name of the group.

Definition at line 63 of file Group.cpp.

te::xsd::QName * te::xsd::Group::getRef ( ) const

It returns the reference to a name of another group.

Returns: The reference to a name of another group.

Definition at line 68 of file Group.cpp.

te::xsd::Group & te::xsd::Group::operator= ( const Group & rhs )

Assignment operator.

Parameters

rhs	Right-hand-side object.

Returns: A reference to this object.

Definition at line 58 of file Group.cpp.

void te::xsd::Annotated::setAnnotation ( Annotation * ann )

inherited

It sets the associated annotation.

Parameters

ann	The annotation to be associated to the object. The annotated class will take the ownership of the given pointer.

Definition at line 35 of file Annotated.cpp.

Referenced by te::xsd::serialize::ReadAnnotated().

void te::xsd::Group::setContent ( Content * c )

It sets the group content. It can be one of: all | choice | sequence.

Parameters

c	The appropriate content to group.

Note: The Group object will take the ownership of the given pointer.

Definition at line 96 of file Group.cpp.

void te::xsd::Identifiable::setId ( std::string * id )

inherited

it sets the id.

Parameters

id	The id to be associated to the object. It will take the ownership of the given string.

Definition at line 29 of file Identifiable.cpp.

References te::xsd::Identifiable::m_id.

Referenced by te::xsd::serialize::ReadIdentifiable().

void te::xsd::Occurs::setMaxOccurs ( unsigned int maxOccurs )

inherited

It sets the maxOccurs value.

Parameters

maxOccurs The maxOccurs value. The value can be any number >= 0.

Note: If you want to set no limit on the maximum number, use the value "unbounded" defined as te::xsd::Occurs::unbounded.

Definition at line 50 of file Occurs.cpp.

Referenced by te::xsd::serialize::ReadOccurs().

void te::xsd::Occurs::setMinOccurs ( unsigned int minOccurs )

inherited

It sets the minOccurs value.

Parameters

minOccurs The minOccurs value. The value can be any number >= 0.

Definition at line 45 of file Occurs.cpp.

Referenced by te::xsd::serialize::ReadOccurs().

void te::xsd::Group::setName ( std::string * name )

It sets a name for the group.

Parameters

name	The group name.

Note: Setting a name will turn to NULL the reference property.; The Group object will take the ownership of the given pointer.

Definition at line 78 of file Group.cpp.

void te::xsd::Group::setRef ( QName * ref )

It sets a reference to a name of another group.

Parameters

ref	A reference to a name of another group.

Note: Setting a reference property will turn to NULL the name.; The Group object will take the ownership of the given pointer.

Definition at line 87 of file Group.cpp.

Member Data Documentation

Content* te::xsd::Group::m_content

private

It can be one of: all | choice | sequence. (Optional)

Definition at line 144 of file Group.h.

unsigned int te::xsd::Occurs::m_maxOccurs

protectedinherited

It specifies the maximum number of times the any element can occur in the parent element. The value can be any number >= 0, or if you want to set no limit on the maximum number, use the value "unbounded". Default value is 1. (Optional)

Definition at line 113 of file Occurs.h.

Referenced by te::xsd::Occurs::operator=().

unsigned int te::xsd::Occurs::m_minOccurs

protectedinherited

It specifies the minimum number of times the any element can occur in the parent element. The value can be any number >= 0. Default value is 1. (Optional)

Definition at line 112 of file Occurs.h.

Referenced by te::xsd::Occurs::getMinOccurs(), and te::xsd::Occurs::operator=().

std::string* te::xsd::Group::m_name

private

It specifies a name for the group. (Optional)

Definition at line 142 of file Group.h.

QName* te::xsd::Group::m_ref

private

It refers to the name of another group. Name and ref attributes cannot both be present.

Definition at line 143 of file Group.h.

const unsigned int te::xsd::Occurs::unbounded = std::numeric_limits<unsigned int>::max()

staticinherited

Identifer for "unbounded" max values.

Definition at line 108 of file Occurs.h.

Referenced by te::xsd::serialize::ReadOccurs().

The documentation for this class was generated from the following files:

/home/castejon/castejon_files/develop/terralib5/git_master/terralib5/src/terralib/xsd/Group.h
/home/castejon/castejon_files/develop/terralib5/git_master/terralib5/src/terralib/xsd/Group.cpp

Public Member Functions

Static Public Attributes

Protected Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation