te::xsd::Key Class Reference

This class models a key element from an XML Schema. More...

#include <Key.h>

Inheritance diagram for te::xsd::Key:

Public Member Functions
void	addField (Field *f)
	Adds a new field to this element. More...
IdentityConstraint *	clone () const
	It clones the object. More...
Annotation *	getAnnotation () const
	It returns the associated annotation. More...
const boost::ptr_vector< Field > &	getFields () const
	It returns the list of Fields elements of this element. More...
std::string *	getId () const
	It returns a pointer (may be NULL) to the object id. More...
std::string *	getName () const
	It returns the key name. More...
Selector *	getSelector () const
	It returns the Selector element of this element. More...
	Key (std::string *name, Annotation *ann=0, std::string *id=0)
	Constructor. More...
	Key (const Key &rhs)
	Copy constructor. More...
Key &	operator= (const Key &rhs)
	Assignment operator. More...
void	setAnnotation (Annotation *ann)
	It sets the associated annotation. More...
void	setId (std::string *id)
	it sets the id. More...
void	setName (std::string *name)
	It sets the key name. More...
void	setSelector (Selector *s)
	It sets the Selector element of this element. More...
	~Key ()
	Destructor. More...

Protected Attributes
boost::ptr_vector< Field >	m_fieldVec
	The list of fields. (Required at least one) More...
std::string *	m_name
	It specifies the name of this element. (Required) More...
Selector *	m_selector
	It specified the selector element of this. (Required) More...

Detailed Description

This class models a key element from an XML Schema.

Note

Parent elements: element.

Definition at line 43 of file Key.h.

Constructor & Destructor Documentation

te::xsd::Key::Key	(	std::string *	name,
		Annotation *	ann = 0,
		std::string *	id = 0
	)

Constructor.

Parameters

id	It specifies a unique ID for the element. It may be a NULL value.
name	It specifies the name of the key element. It is required a non-NULL value.

Note

The Key object will take the ownership of the id and name pointers.

te::xsd::Key::Key

(

const Key &

rhs

)

Copy constructor.

Parameters

rhs	Right-hand-side object.

te::xsd::Key::~Key

(

)

Destructor.

Member Function Documentation

void te::xsd::IdentityConstraint::addField ( Field *  f )

inherited

Adds a new field to this element.

Parameters

f	The field that will be added.

Note

The IdentityConstraint object will take the ownership of the given pointer.

IdentityConstraint* te::xsd::Key::clone ( ) const

virtual

It clones the object.

Returns

A clone of the object. The caller will take the ownership.

Implements te::xsd::IdentityConstraint.

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

inherited

It returns the associated annotation.

Returns

The associated annotation.

const boost::ptr_vector<Field>& te::xsd::IdentityConstraint::getFields ( ) const

inherited

It returns the list of Fields elements of this element.

Returns

The list of Fields.

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

inherited

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

std::string* te::xsd::Key::getName

(

)

const

It returns the key name.

Returns

The key name.

Selector* te::xsd::IdentityConstraint::getSelector ( ) const

inherited

It returns the Selector element of this element.

Returns

The Selector element.

Key& te::xsd::Key::operator=

(

const Key &

rhs

)

Assignment operator.

Parameters

rhs	Right-hand-side object.

Returns

A reference to this object.

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.

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.

void te::xsd::Key::setName

(

std::string *

name

)

It sets the key name.

Parameters

name	The key name.

Note

The key will take the ownership of the given name.

void te::xsd::IdentityConstraint::setSelector ( Selector *  s )

inherited

It sets the Selector element of this element.

Parameters

s	It specifies the Selector element.

Note

The IdentityConstraint object will take the ownership of the given pointer.

Member Data Documentation

boost::ptr_vector<Field> te::xsd::IdentityConstraint::m_fieldVec

protectedinherited

The list of fields. (Required at least one)

Definition at line 147 of file IdentityConstraint.h.

std::string* te::xsd::IdentityConstraint::m_name

protectedinherited

It specifies the name of this element. (Required)

Definition at line 145 of file IdentityConstraint.h.

Selector* te::xsd::IdentityConstraint::m_selector

protectedinherited

It specified the selector element of this. (Required)

Definition at line 146 of file IdentityConstraint.h.

---

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

• /home/castejon/castejon_files/develop/terralib5/git_master/terralib5/src/terralib/xsd/Key.h