LibreOffice Module dbaccess (master) 1
Public Member Functions | Protected Member Functions | Protected Attributes | Private Attributes | List of all members
dbaccess::OQueryDescriptor_Base Class Reference

#include <querydescriptor.hxx>

Inheritance diagram for dbaccess::OQueryDescriptor_Base:
[legend]
Collaboration diagram for dbaccess::OQueryDescriptor_Base:
[legend]

Public Member Functions

 OQueryDescriptor_Base (::osl::Mutex &_rMutex,::cppu::OWeakObject &_rMySelf)
 
 OQueryDescriptor_Base (const OQueryDescriptor_Base &_rSource,::cppu::OWeakObject &_rMySelf)
 constructs the object with a UNO QueryDescriptor. More...
 
virtual css::uno::Reference< css::container::XNameAccess > SAL_CALL getColumns () override
 
virtual OUString SAL_CALL getImplementationName () override
 
virtual sal_Bool SAL_CALL supportsService (const OUString &ServiceName) override
 
virtual css::uno::Sequence< OUString > SAL_CALL getSupportedServiceNames () override
 
- Public Member Functions inherited from cppu::ImplHelper2< class Ifc1, class Ifc2 >
virtual css::uno::Any SAL_CALL queryInterface (css::uno::Type const &rType) SAL_OVERRIDE
 
virtual css::uno::Sequence< css::uno::Type > SAL_CALL getTypes () SAL_OVERRIDE
 
virtual css::uno::Sequence< sal_Int8 > SAL_CALL getImplementationId () SAL_OVERRIDE
 
virtual rtl::Reference< OColumncreateColumn (const OUString &_rName) const =0
 creates an OColumn object which should represent the column with a given name More...
 
virtual css::uno::Reference< css::beans::XPropertySetcreateColumnDescriptor ()=0
 creates a column descriptor object. More...
 
virtual void columnAppended (const css::uno::Reference< css::beans::XPropertySet > &_rxSourceDescriptor)=0
 notifies that a column, created from a column descriptor, has been appended More...
 
virtual void columnDropped (const OUString &_sName)=0
 notifies that a column with a given name has been dropped More...
 
virtual void refreshColumns ()=0
 

Protected Member Functions

virtual ~OQueryDescriptor_Base ()
 
void setColumnsOutOfDate (bool _bOutOfDate=true)
 
sal_Int32 getColumnCount () const
 
void clearColumns ()
 
void implAppendColumn (const OUString &_rName, OColumn *_pColumn)
 
virtual rtl::Reference< OColumncreateColumn (const OUString &_rName) const override
 creates an OColumn object which should represent the column with a given name More...
 
virtual css::uno::Reference< css::beans::XPropertySetcreateColumnDescriptor () override
 creates a column descriptor object. More...
 
virtual void columnAppended (const css::uno::Reference< css::beans::XPropertySet > &_rxSourceDescriptor) override
 notifies that a column, created from a column descriptor, has been appended More...
 
virtual void columnDropped (const OUString &_sName) override
 notifies that a column with a given name has been dropped More...
 
virtual void rebuildColumns ()
 rebuild our columns set More...
 
void disposeColumns ()
 
virtual void refreshColumns () override
 
- Protected Member Functions inherited from cppu::ImplHelper2< class Ifc1, class Ifc2 >
 ~ImplHelper2 () SAL_NOEXCEPT
 
- Protected Member Functions inherited from dbaccess::OCommandBase
 OCommandBase ()
 
- Protected Member Functions inherited from dbaccess::IColumnFactory
 ~IColumnFactory ()
 
- Protected Member Functions inherited from connectivity::sdbcx::IRefreshableColumns
 ~IRefreshableColumns ()
 

Protected Attributes

std::unique_ptr< OColumnsm_pColumns
 
OUString m_sElementName
 

Private Attributes

bool m_bColumnsOutOfDate: 1
 
::osl::Mutex & m_rMutex
 

Additional Inherited Members

- Public Attributes inherited from dbaccess::OCommandBase
css::uno::Sequence< css::beans::PropertyValue > m_aLayoutInformation
 
OUString m_sCommand
 
bool m_bEscapeProcessing
 
OUString m_sUpdateTableName
 
OUString m_sUpdateSchemaName
 
OUString m_sUpdateCatalogName
 

Detailed Description

Definition at line 44 of file querydescriptor.hxx.

Constructor & Destructor Documentation

◆ ~OQueryDescriptor_Base()

dbaccess::OQueryDescriptor_Base::~OQueryDescriptor_Base ( )
protectedvirtual

Definition at line 141 of file querydescriptor.cxx.

References m_pColumns.

◆ OQueryDescriptor_Base() [1/2]

dbaccess::OQueryDescriptor_Base::OQueryDescriptor_Base ( ::osl::Mutex &  _rMutex,
::cppu::OWeakObject _rMySelf 
)

Definition at line 120 of file querydescriptor.cxx.

References m_pColumns, and m_rMutex.

◆ OQueryDescriptor_Base() [2/2]

dbaccess::OQueryDescriptor_Base::OQueryDescriptor_Base ( const OQueryDescriptor_Base _rSource,
::cppu::OWeakObject _rMySelf 
)

constructs the object with a UNO QueryDescriptor.

If you use this ctor, the resulting object won't have any column information (the column container will be empty)

Definition at line 127 of file querydescriptor.cxx.

References dbaccess::OCommandBase::m_aLayoutInformation, dbaccess::OCommandBase::m_bEscapeProcessing, m_pColumns, m_rMutex, dbaccess::OCommandBase::m_sCommand, dbaccess::OCommandBase::m_sUpdateCatalogName, dbaccess::OCommandBase::m_sUpdateSchemaName, and dbaccess::OCommandBase::m_sUpdateTableName.

Member Function Documentation

◆ clearColumns()

void dbaccess::OQueryDescriptor_Base::clearColumns ( )
protected

Definition at line 159 of file querydescriptor.cxx.

References m_pColumns, and setColumnsOutOfDate().

Referenced by getColumns(), and refreshColumns().

◆ columnAppended()

void dbaccess::OQueryDescriptor_Base::columnAppended ( const css::uno::Reference< css::beans::XPropertySet > &  _rxSourceDescriptor)
overrideprotectedvirtual

notifies that a column, created from a column descriptor, has been appended

Implements dbaccess::IColumnFactory.

Definition at line 216 of file querydescriptor.cxx.

◆ columnDropped()

void dbaccess::OQueryDescriptor_Base::columnDropped ( const OUString &  _sName)
overrideprotectedvirtual

notifies that a column with a given name has been dropped

Implements dbaccess::IColumnFactory.

Definition at line 221 of file querydescriptor.cxx.

◆ createColumn()

rtl::Reference< OColumn > dbaccess::OQueryDescriptor_Base::createColumn ( const OUString &  _rName) const
overrideprotectedvirtual

creates an OColumn object which should represent the column with a given name

Implements dbaccess::IColumnFactory.

Reimplemented in dbaccess::OQuery.

Definition at line 245 of file querydescriptor.cxx.

◆ createColumnDescriptor()

Reference< XPropertySet > dbaccess::OQueryDescriptor_Base::createColumnDescriptor ( )
overrideprotectedvirtual

creates a column descriptor object.

A column descriptor object is used to append new columns to the collection. If such an append actually happened, columnAppended is called afterwards.

Implements dbaccess::IColumnFactory.

Definition at line 226 of file querydescriptor.cxx.

◆ disposeColumns()

void dbaccess::OQueryDescriptor_Base::disposeColumns ( )
protected

Definition at line 211 of file querydescriptor.cxx.

References m_pColumns.

Referenced by dbaccess::OQuery::disposing().

◆ getColumnCount()

sal_Int32 dbaccess::OQueryDescriptor_Base::getColumnCount ( ) const
inlineprotected

Definition at line 61 of file querydescriptor.hxx.

References m_pColumns.

◆ getColumns()

Reference< XNameAccess > SAL_CALL dbaccess::OQueryDescriptor_Base::getColumns ( )
overridevirtual

◆ getImplementationName()

OUString SAL_CALL dbaccess::OQueryDescriptor_Base::getImplementationName ( )
overridevirtual

Definition at line 196 of file querydescriptor.cxx.

◆ getSupportedServiceNames()

Sequence< OUString > SAL_CALL dbaccess::OQueryDescriptor_Base::getSupportedServiceNames ( )
overridevirtual

Definition at line 206 of file querydescriptor.cxx.

References SERVICE_SDB_DATASETTINGS, and SERVICE_SDB_QUERYDESCRIPTOR.

◆ implAppendColumn()

void dbaccess::OQueryDescriptor_Base::implAppendColumn ( const OUString &  _rName,
OColumn _pColumn 
)
protected

Definition at line 154 of file querydescriptor.cxx.

References m_pColumns.

◆ rebuildColumns()

void dbaccess::OQueryDescriptor_Base::rebuildColumns ( )
protectedvirtual

rebuild our columns set

clearColumns has already been called before, do NOT call it, again

Reimplemented in dbaccess::OQuery.

Definition at line 232 of file querydescriptor.cxx.

Referenced by getColumns(), and refreshColumns().

◆ refreshColumns()

void dbaccess::OQueryDescriptor_Base::refreshColumns ( )
overrideprotectedvirtual

◆ setColumnsOutOfDate()

void dbaccess::OQueryDescriptor_Base::setColumnsOutOfDate ( bool  _bOutOfDate = true)
protected

◆ supportsService()

sal_Bool SAL_CALL dbaccess::OQueryDescriptor_Base::supportsService ( const OUString &  ServiceName)
overridevirtual

Definition at line 201 of file querydescriptor.cxx.

References cppu::supportsService().

Member Data Documentation

◆ m_bColumnsOutOfDate

bool dbaccess::OQueryDescriptor_Base::m_bColumnsOutOfDate
private

Definition at line 51 of file querydescriptor.hxx.

Referenced by getColumns(), and setColumnsOutOfDate().

◆ m_pColumns

std::unique_ptr<OColumns> dbaccess::OQueryDescriptor_Base::m_pColumns
protected

◆ m_rMutex

::osl::Mutex& dbaccess::OQueryDescriptor_Base::m_rMutex
private

Definition at line 52 of file querydescriptor.hxx.

Referenced by getColumns(), OQueryDescriptor_Base(), and refreshColumns().

◆ m_sElementName

OUString dbaccess::OQueryDescriptor_Base::m_sElementName
protected

Definition at line 56 of file querydescriptor.hxx.

Referenced by dbaccess::OQuery::registerProperties().


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