te::fe::ObjectId Class Reference

An object identifier is meant to represent a unique identifier for an object instance within the context of the web service or database that is serving the object. More...

#include <ObjectId.h>

Public Types
enum	OidType { GMLOBJECTID, FEATUREID }
	The type of object identification used. More...

Public Member Functions
Initializer Methods
Methods related to instantiation and destruction.
	ObjectId (const char *id, OidType oidType)
	It initializes a new ObjectId. More...
	~ObjectId ()
	Destructor. More...
Accessor methods
Methods used to get or set properties.
void	setId (const std::string &id)
	It sets the feature identification value. More...
const std::string &	getId () const
	It returns the feature identification value. More...
void	setOidType (OidType t)
	It sets the format type used by the feature identification value. More...
OidType	getOidType () const
	It returns the format type used by the feature identification value. More...

Private Attributes
std::string	m_id
	The id in a string format. More...
OidType	m_oidType
	May be one of: GmlObjectId, FeatureId, ObjectId, RecordId. More...

Detailed Description

An object identifier is meant to represent a unique identifier for an object instance within the context of the web service or database that is serving the object.

The Filter Encoding specification does not define a specific element for identifying objects but instead defines the abstract element Id as the head of an XML substitution group that may be used to define an object identifier element for specific object types.
Remember that:

• GML 3: uses GmlObjectId tag.
• GML 2: uses FeatureId tag.

See also

Filter

Definition at line 58 of file ObjectId.h.

Member Enumeration Documentation

enum te::fe::ObjectId::OidType

The type of object identification used.

Enumerator
GMLOBJECTID	Using GML 3 format for oid (default).
FEATUREID	using GML 2 format for oid.

Definition at line 67 of file ObjectId.h.

Constructor & Destructor Documentation

te::fe::ObjectId::ObjectId	(	const char *	id,
		OidType	oidType
	)

It initializes a new ObjectId.

Parameters

id	The object identification value. Must be a non empty value.
oidType	The type of object identification used.

te::fe::ObjectId::~ObjectId

(

)

Destructor.

Member Function Documentation

const std::string& te::fe::ObjectId::getId

(

)

const

It returns the feature identification value.

Returns

The feature identification value.

OidType te::fe::ObjectId::getOidType

(

)

const

It returns the format type used by the feature identification value.

Returns

The format type used by the feature identification value.

void te::fe::ObjectId::setId

(

const std::string &

id

)

It sets the feature identification value.

Parameters

id	The feature identification value.

void te::fe::ObjectId::setOidType

(

OidType

t

)

It sets the format type used by the feature identification value.

Parameters

t	The format type used by the feature identification value.

Member Data Documentation

std::string te::fe::ObjectId::m_id

private

The id in a string format.

Definition at line 128 of file ObjectId.h.

OidType te::fe::ObjectId::m_oidType

private

May be one of: GmlObjectId, FeatureId, ObjectId, RecordId.

Definition at line 129 of file ObjectId.h.

---

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

• /home/castejon/castejon_files/develop/terralib5/git_master/terralib5/src/terralib/fe/ObjectId.h