te::xsd::Field Class Reference

It models the field element of an XML Schema. More...

#include <Field.h>

Inheritance diagram for te::xsd::Field:

Public Member Functions
	Field (std::string *xpath, Annotation *ann=0, std::string *id=0)
	Constructor. More...
	Field (const Field &rhs)
	Copy constructor. More...
Annotation *	getAnnotation () const
	It returns the associated annotation. More...
std::string *	getId () const
	It returns a pointer (may be NULL) to the object id. More...
std::string *	getXPath () const
	It returns the xpath expression of the Field element. More...
Field &	operator= (const Field &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	setXPath (std::string *xpath)
	It sets the xpath expression of the Field element. More...
	~Field ()
	Destructor. More...

Private Attributes
std::string *	m_xpath
	It identifies a single element or attribute whose content or value is used for the constraint. (Required) More...

Detailed Description

It models the field element of an XML Schema.

Note

Parent elements: key, keyref, unique.

Definition at line 47 of file Field.h.

Constructor & Destructor Documentation

te::xsd::Field::Field	(	std::string *	xpath,
		Annotation *	ann = 0,
		std::string *	id = 0
	)

Constructor.

Parameters

id	It specifies a unique ID for the element. It may be a NULL value.
xpath	It identifies a single element or attribute whose content or value is used for the constraint. It is required a non-NULL value.

Note

The Field object will take the ownership of the given pointers.

Definition at line 32 of file Field.cpp.

te::xsd::Field::Field

(

const Field &

rhs

)

Copy constructor.

Parameters

rhs	Right-hand-side object.

Definition at line 39 of file Field.cpp.

te::xsd::Field::~Field

(

)

Destructor.

Definition at line 46 of file Field.cpp.

Member Function Documentation

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.

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::Field::getXPath

(

)

const

It returns the xpath expression of the Field element.

Returns

The xpath expression.

Definition at line 56 of file Field.cpp.

te::xsd::Field & te::xsd::Field::operator=

(

const Field &

rhs

)

Assignment operator.

Parameters

rhs	Right-hand-side object.

Returns

A reference to this object.

Definition at line 51 of file Field.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::Field::setXPath

(

std::string *

xpath

)

It sets the xpath expression of the Field element.

Parameters

xpath

It specifies the xpath expression of the Field element.

Note

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

Definition at line 61 of file Field.cpp.

Member Data Documentation

std::string* te::xsd::Field::m_xpath

private

It identifies a single element or attribute whose content or value is used for the constraint. (Required)

Definition at line 102 of file Field.h.

---

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

• C:/TL5_2015_release/terralib5/src/terralib/xsd/Field.h
• C:/TL5_2015_release/terralib5/src/terralib/xsd/Field.cpp