glo::Record::IndexStrNameTuple Class Reference

IndexStrNameTuples hold an index as a sortable string, its name and the class ID of the class being indexed (can be a superclass of the class with the record) and whether the index is unique. More...

#include <GloRecord.h>

Public Member Functions
	IndexStrNameTuple ()
	IndexStrNameTuple (const IndexStrNameTuple &rT)
	IndexStrNameTuple (const std::string &rsIndex, const std::string &rsIndexName, bool bUnique, unsigned long ulClassID)
virtual	~IndexStrNameTuple ()
unsigned long	getClassID () const
std::string	getIndex () const
std::string	getIndexName () const
bool	isUnique () const
Record::IndexStrNameTuple &	operator= (const IndexStrNameTuple &rT)
void	setClassID (unsigned long ulClassID)
void	setIndex (const std::string &rsIndex)
void	setIndexName (const std::string &rsIndexName)
void	setUnique (bool bUnique)
bool	operator== (const IndexStrNameTuple &rT) const
	Comparison operator.
bool	operator!= (const IndexStrNameTuple &rT) const
	Comparison operator.

Private Attributes
bool	m_bUnique
std::string	m_sIndex
std::string	m_sIndexName
unsigned long	m_ulClassID

Detailed Description

IndexStrNameTuples hold an index as a sortable string, its name and the class ID of the class being indexed (can be a superclass of the class with the record) and whether the index is unique.

Copyright

© 2010 Helmut Jakoby

Author

Helmut Jakoby

Constructor & Destructor Documentation

IndexStrNameTuple() [1/3]

glo::Record::IndexStrNameTuple::IndexStrNameTuple

(

)

Standard- constructor.

IndexStrNameTuple() [2/3]

glo::Record::IndexStrNameTuple::IndexStrNameTuple	(	const std::string &	rsIndex,
		const std::string &	rsIndexName,
		bool	bUnique,
		unsigned long	ulClassID )

Constructor with parameter passing.

Parameters

[in]	rsIndex	The index (e.g., "MUELLER KARL-THEOD").
[in]	rsIndexName	The index name (e.g., "IDX_MyIndexName").
[in]	bUnique	If true, the compound index entry may only occur once.
[in]	ulClassID	The class ID of the class to be indexed.

IndexStrNameTuple() [3/3]

glo::Record::IndexStrNameTuple::IndexStrNameTuple

(

const IndexStrNameTuple &

rT

)

Copy constructor.

Parameters

[in]

rT

The data is copied from this object.

~IndexStrNameTuple()

virtual glo::Record::IndexStrNameTuple::~IndexStrNameTuple ( )

virtual

Destructor.

Member Function Documentation

getClassID()

unsigned long glo::Record::IndexStrNameTuple::getClassID

(

)

const

Returns the class ID.

Returns

See above.

getIndex()

std::string glo::Record::IndexStrNameTuple::getIndex

(

)

const

Rerturns the index.

Returns

The index (e.g. "MUELLER KARL-THEOD").

getIndexName()

std::string glo::Record::IndexStrNameTuple::getIndexName

(

)

const

Returns the index name.

Returns

The index name (e.g. "IDX_MyIndexName").

isUnique()

bool glo::Record::IndexStrNameTuple::isUnique

(

)

const

Returns whether the index is a unique index.

Returns

If true, a compound index entry may only occur once.

operator!=()

bool glo::Record::IndexStrNameTuple::operator!=

(

const IndexStrNameTuple &

rT

)

const

Comparison operator.

Parameters

[in]

rT

The object to be compared with this one.

operator=()

Record::IndexStrNameTuple & glo::Record::IndexStrNameTuple::operator=

(

const IndexStrNameTuple &

rT

)

Assignment operator.

Parameters

[in]

rT

The data is transferred from this object.

operator==()

bool glo::Record::IndexStrNameTuple::operator==

(

const IndexStrNameTuple &

rT

)

const

Comparison operator.

Parameters

[in]

rT

The object to be compared with this one.

setClassID()

void glo::Record::IndexStrNameTuple::setClassID

(

unsigned long

ulClassID

)

Sets the class ID.

Parameters

[in]

ulClassID

The class ID of the class which is indexed.

setIndex()

void glo::Record::IndexStrNameTuple::setIndex

(

const std::string &

rsIndex

)

Sets the index.

Parameters

[in]

rsIndex

The index (e.g. "MUELLER KARL-THEOD").

setIndexName()

void glo::Record::IndexStrNameTuple::setIndexName

(

const std::string &

rsIndexName

)

Sets the index name.

Parameters

[in]

rsIndexName

The index name (e.g. "IDX_MyIndexName").

setUnique()

void glo::Record::IndexStrNameTuple::setUnique

(

bool

bUnique

)

Marks the index as a unique index.

Parameters

[in]

bUnique

If true, a compound index entry may only occur once.

Member Data Documentation

m_bUnique

bool glo::Record::IndexStrNameTuple::m_bUnique

private

If true, the compound index entry may occur only once.

m_sIndex

std::string glo::Record::IndexStrNameTuple::m_sIndex

private

A possible compound index (e.g., if index in the schema: 'Index=Person.m_sName[20]|NaturalPerson.m_sFirstname[10]|',and the language 'de', then name "Müller" and first name "Karl-Theodor" become the index "MUELLER KARL-THEOD".

m_sIndexName

std::string glo::Record::IndexStrNameTuple::m_sIndexName

private

The index name. For example, if in the schema "[MyClassName.Index.IDX_MyIndexName]", then "IDX_MyIndexName".

m_ulClassID

unsigned long glo::Record::IndexStrNameTuple::m_ulClassID

private

The class ID of the class being indexed (can be a superclass of the class with the record).

---

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

• GloRecord.h