ScDBRangeBase Class Reference

Base class for abstracting range data backends for database functions. More...

#include <doubleref.hxx>

Inheritance diagram for ScDBRangeBase:

Collaboration diagram for ScDBRangeBase:

Public Member Functions
	ScDBRangeBase ()=delete
virtual	~ScDBRangeBase ()=0
bool	fillQueryEntries (ScQueryParamBase *pParam, const ScDBRangeBase *pDBRef) const
virtual SCCOL	getColSize () const =0
virtual SCROW	getRowSize () const =0
virtual SCSIZE	getVisibleDataCellCount () const =0
virtual OUString	getString (SCCOL nCol, SCROW nRow) const =0
	Get a string value of a specified cell position. More...
virtual SCCOL	getFirstFieldColumn () const =0
virtual SCCOL	findFieldColumn (SCCOL nIndex) const =0
	Get a 0-based column index that corresponds with the passed field index. More...
virtual SCCOL	findFieldColumn (const OUString &rStr, FormulaError *pErr=nullptr) const =0
virtual std::unique_ptr< ScDBQueryParamBase >	createQueryParam (const ScDBRangeBase *pQueryRef) const =0
virtual bool	isRangeEqual (const ScRange &rRange) const =0

Protected Member Functions
	ScDBRangeBase (ScDocument *pDoc)
ScDocument *	getDoc () const

Static Protected Member Functions
static void	fillQueryOptions (ScQueryParamBase *pParam)
	Populate query options that are always the same for all database queries. More...

Private Attributes
ScDocument *	mpDoc

Detailed Description

Base class for abstracting range data backends for database functions.

Definition at line 37 of file doubleref.hxx.

Constructor & Destructor Documentation

ScDBRangeBase() [1/2]

ScDBRangeBase::ScDBRangeBase ( )

delete

~ScDBRangeBase()

ScDBRangeBase::~ScDBRangeBase ( )

pure virtual

Definition at line 254 of file doubleref.cxx.

ScDBRangeBase() [2/2]

ScDBRangeBase::ScDBRangeBase ( ScDocument *  pDoc )

protected

Definition at line 249 of file doubleref.cxx.

Member Function Documentation

createQueryParam()

virtual std::unique_ptr< ScDBQueryParamBase > ScDBRangeBase::createQueryParam ( const ScDBRangeBase *  pQueryRef ) const

pure virtual

Implemented in ScDBInternalRange, and ScDBExternalRange.

fillQueryEntries()

bool ScDBRangeBase::fillQueryEntries	(	ScQueryParamBase *	pParam,
		const ScDBRangeBase *	pDBRef
	)		const

Definition at line 258 of file doubleref.cxx.

References getDoc().

Referenced by ScDBInternalRange::createQueryParam(), and ScDBExternalRange::createQueryParam().

fillQueryOptions()

void ScDBRangeBase::fillQueryOptions ( ScQueryParamBase *  pParam )

staticprotected

Populate query options that are always the same for all database queries.

Definition at line 266 of file doubleref.cxx.

References ScQueryParamBase::bByRow, ScQueryParamBase::bCaseSens, ScQueryParamBase::bDuplicate, ScQueryParamBase::bHasHeader, ScQueryParamBase::bInplace, ScQueryParamBase::eSearchType, and utl::SearchParam::Normal.

Referenced by ScDBInternalRange::createQueryParam(), and ScDBExternalRange::createQueryParam().

findFieldColumn() [1/2]

virtual SCCOL ScDBRangeBase::findFieldColumn ( const OUString &  rStr, FormulaError *  pErr = nullptr  ) const

pure virtual

Implemented in ScDBInternalRange, and ScDBExternalRange.

findFieldColumn() [2/2]

virtual SCCOL ScDBRangeBase::findFieldColumn ( SCCOL  nIndex ) const

pure virtual

Get a 0-based column index that corresponds with the passed field index.

Note that the field index passed as the 1st parameter is 1-based.

Parameters

nIndex

1-based field index.

Returns

0-based column index

Implemented in ScDBInternalRange, and ScDBExternalRange.

getColSize()

virtual SCCOL ScDBRangeBase::getColSize ( ) const

pure virtual

Implemented in ScDBInternalRange, and ScDBExternalRange.

getDoc()

ScDocument * ScDBRangeBase::getDoc ( ) const

inlineprotected

Definition at line 79 of file doubleref.hxx.

References mpDoc.

Referenced by fillQueryEntries(), ScDBInternalRange::findFieldColumn(), and ScDBInternalRange::getString().

getFirstFieldColumn()

virtual SCCOL ScDBRangeBase::getFirstFieldColumn ( ) const

pure virtual

Implemented in ScDBInternalRange, and ScDBExternalRange.

getRowSize()

virtual SCROW ScDBRangeBase::getRowSize ( ) const

pure virtual

Implemented in ScDBInternalRange, and ScDBExternalRange.

getString()

virtual OUString ScDBRangeBase::getString ( SCCOL  nCol, SCROW  nRow  ) const

pure virtual

Get a string value of a specified cell position.

Note that the position of the upper left cell of the range is always (0, 0) even if the reference type is of internal range.

Parameters

nCol	column position (0 to column size-1)
nRow	row position (0 to row size-1)

Implemented in ScDBInternalRange, and ScDBExternalRange.

getVisibleDataCellCount()

virtual SCSIZE ScDBRangeBase::getVisibleDataCellCount ( ) const

pure virtual

Implemented in ScDBInternalRange, and ScDBExternalRange.

isRangeEqual()

virtual bool ScDBRangeBase::isRangeEqual ( const ScRange &  rRange ) const

pure virtual

Implemented in ScDBInternalRange, and ScDBExternalRange.

Member Data Documentation

mpDoc

ScDocument* ScDBRangeBase::mpDoc

private

Definition at line 88 of file doubleref.hxx.

Referenced by getDoc().

---

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

• doubleref.hxx
• doubleref.cxx