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.

Definition at line 29 of file Key.cpp.

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

Copy constructor.

Parameters

rhs	Right-hand-side object.

Definition at line 34 of file Key.cpp.

te::xsd::Key::~Key ( )

Destructor.

Definition at line 39 of file Key.cpp.

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.

Definition at line 85 of file IdentityConstraint.cpp.

te::xsd::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.

Definition at line 49 of file Key.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.

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

inherited

It returns the list of Fields elements of this element.

Returns: The list of Fields.

Definition at line 67 of file IdentityConstraint.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.

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

It returns the key name.

Returns: The key name.

Definition at line 54 of file Key.cpp.

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

inherited

It returns the Selector element of this element.

Returns: The Selector element.

Definition at line 62 of file IdentityConstraint.cpp.

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

Assignment operator.

Parameters

rhs	Right-hand-side object.

Returns: A reference to this object.

Definition at line 44 of file Key.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::serialize::ReadAnnotated().

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::serialize::ReadIdentifiable().

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.

Definition at line 59 of file Key.cpp.

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.

Definition at line 79 of file IdentityConstraint.cpp.

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.

Referenced by te::xsd::IdentityConstraint::IdentityConstraint().

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 files:

/home/castejon/castejon_files/develop/terralib5/git/src/terralib/xsd/Key.h
/home/castejon/castejon_files/develop/terralib5/git/src/terralib/xsd/Key.cpp

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation