This class models a keyref element from a XML Schema element. More...

#include <KeyRef.h>

Inheritance diagram for te::xsd::KeyRef:

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 name of this element. More...

QName *	getRef () const
	It returns the reference to a named element. More...

Selector *	getSelector () const
	It returns the Selector element of this element. More...

	KeyRef (QName refer, std::string name, Annotation ann=0, std::string id=0)
	Constructor. More...

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

KeyRef &	operator= (const KeyRef &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 a name for this element. More...

void	setRef (QName *ref)
	It sets a reference to a named attribute. More...

void	setSelector (Selector *s)
	It sets the Selector element of this element. More...

	~KeyRef ()
	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...

Private Attributes
QName *	m_ref
	It specifies the name of a key or unique element defined in this or another schema. (Required) More...

Detailed Description

This class models a keyref element from a XML Schema element.

Note: Parent elements: element.

Definition at line 46 of file KeyRef.h.

Constructor & Destructor Documentation

te::xsd::KeyRef::KeyRef	(	QName *	refer,
		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 keyref element. It is required a non-NULL value.
ref	It specifies the name of a key or unique element defined in this or another schema. It is required a non-NULL value.

Note: The KeyRef object will take the ownership of the given pointers.

Definition at line 33 of file KeyRef.cpp.

References m_ref.

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

Copy constructor.

Parameters

rhs	Right-hand-side object.

Definition at line 40 of file KeyRef.cpp.

te::xsd::KeyRef::~KeyRef ( )

Destructor.

Definition at line 45 of file KeyRef.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::KeyRef::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 67 of file KeyRef.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::IdentityConstraint::getName ( ) const

inherited

It returns the name of this element.

Returns: The name of this element.

Definition at line 57 of file IdentityConstraint.cpp.

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

It returns the reference to a named element.

Returns: The reference to a named element.

Definition at line 55 of file KeyRef.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::KeyRef & te::xsd::KeyRef::operator= ( const KeyRef & rhs )

Assignment operator.

Parameters

rhs	Right-hand-side object.

Returns: A reference to this object.

Definition at line 50 of file KeyRef.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::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::IdentityConstraint::setName ( std::string * name )

inherited

It sets a name for this element.

Parameters

name	A name for this element. Required a non-NULL value.

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

Definition at line 72 of file IdentityConstraint.cpp.

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

It sets a reference to a named attribute.

Parameters

ref	A reference to a named attribute. Required a non-NULL value.

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

Definition at line 60 of file KeyRef.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().

QName* te::xsd::KeyRef::m_ref

private

It specifies the name of a key or unique element defined in this or another schema. (Required)

Definition at line 104 of file KeyRef.h.

Referenced by KeyRef().

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:

C:/TL5_2015_release/terralib5/src/terralib/xsd/KeyRef.h
C:/TL5_2015_release/terralib5/src/terralib/xsd/KeyRef.cpp

Public Member Functions

Protected Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation