LibreOffice Module ucbhelper (master) 1
Public Member Functions | Private Attributes | List of all members
ucbhelper::ResultSet Class Referencefinal

This is an implementation of the service com.sun.star.ucb.ContentResultSet. More...

#include <resultset.hxx>

Inheritance diagram for ucbhelper::ResultSet:
[legend]
Collaboration diagram for ucbhelper::ResultSet:
[legend]

Public Member Functions

 ResultSet (const css::uno::Reference< css::uno::XComponentContext > &rxContext, const css::uno::Sequence< css::beans::Property > &rProperties, const rtl::Reference< ResultSetDataSupplier > &rDataSupplier)
 Construction. More...
 
 ResultSet (const css::uno::Reference< css::uno::XComponentContext > &rxContext, const css::uno::Sequence< css::beans::Property > &rProperties, const rtl::Reference< ResultSetDataSupplier > &rDataSupplier, const css::uno::Reference< css::ucb::XCommandEnvironment > &rxEnv)
 Construction. More...
 
virtual ~ResultSet () 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
 
virtual void SAL_CALL dispose () override
 
virtual void SAL_CALL addEventListener (const css::uno::Reference< css::lang::XEventListener > &Listener) override
 
virtual void SAL_CALL removeEventListener (const css::uno::Reference< css::lang::XEventListener > &Listener) override
 
virtual OUString SAL_CALL queryContentIdentifierString () override
 
virtual css::uno::Reference< css::ucb::XContentIdentifier > SAL_CALL queryContentIdentifier () override
 
virtual css::uno::Reference< css::ucb::XContent > SAL_CALL queryContent () override
 
virtual css::uno::Reference< css::sdbc::XResultSetMetaData > SAL_CALL getMetaData () override
 
virtual sal_Bool SAL_CALL next () override
 
virtual sal_Bool SAL_CALL isBeforeFirst () override
 
virtual sal_Bool SAL_CALL isAfterLast () override
 
virtual sal_Bool SAL_CALL isFirst () override
 
virtual sal_Bool SAL_CALL isLast () override
 
virtual void SAL_CALL beforeFirst () override
 
virtual void SAL_CALL afterLast () override
 
virtual sal_Bool SAL_CALL first () override
 
virtual sal_Bool SAL_CALL last () override
 
virtual sal_Int32 SAL_CALL getRow () override
 
virtual sal_Bool SAL_CALL absolute (sal_Int32 row) override
 
virtual sal_Bool SAL_CALL relative (sal_Int32 rows) override
 
virtual sal_Bool SAL_CALL previous () override
 
virtual void SAL_CALL refreshRow () override
 
virtual sal_Bool SAL_CALL rowUpdated () override
 
virtual sal_Bool SAL_CALL rowInserted () override
 
virtual sal_Bool SAL_CALL rowDeleted () override
 
virtual css::uno::Reference< css::uno::XInterface > SAL_CALL getStatement () override
 
virtual sal_Bool SAL_CALL wasNull () override
 
virtual OUString SAL_CALL getString (sal_Int32 columnIndex) override
 
virtual sal_Bool SAL_CALL getBoolean (sal_Int32 columnIndex) override
 
virtual sal_Int8 SAL_CALL getByte (sal_Int32 columnIndex) override
 
virtual sal_Int16 SAL_CALL getShort (sal_Int32 columnIndex) override
 
virtual sal_Int32 SAL_CALL getInt (sal_Int32 columnIndex) override
 
virtual sal_Int64 SAL_CALL getLong (sal_Int32 columnIndex) override
 
virtual float SAL_CALL getFloat (sal_Int32 columnIndex) override
 
virtual double SAL_CALL getDouble (sal_Int32 columnIndex) override
 
virtual css::uno::Sequence< sal_Int8 > SAL_CALL getBytes (sal_Int32 columnIndex) override
 
virtual css::util::Date SAL_CALL getDate (sal_Int32 columnIndex) override
 
virtual css::util::Time SAL_CALL getTime (sal_Int32 columnIndex) override
 
virtual css::util::DateTime SAL_CALL getTimestamp (sal_Int32 columnIndex) override
 
virtual css::uno::Reference< css::io::XInputStream > SAL_CALL getBinaryStream (sal_Int32 columnIndex) override
 
virtual css::uno::Reference< css::io::XInputStream > SAL_CALL getCharacterStream (sal_Int32 columnIndex) override
 
virtual css::uno::Any SAL_CALL getObject (sal_Int32 columnIndex, const css::uno::Reference< css::container::XNameAccess > &typeMap) override
 
virtual css::uno::Reference< css::sdbc::XRef > SAL_CALL getRef (sal_Int32 columnIndex) override
 
virtual css::uno::Reference< css::sdbc::XBlob > SAL_CALL getBlob (sal_Int32 columnIndex) override
 
virtual css::uno::Reference< css::sdbc::XClob > SAL_CALL getClob (sal_Int32 columnIndex) override
 
virtual css::uno::Reference< css::sdbc::XArray > SAL_CALL getArray (sal_Int32 columnIndex) override
 
virtual void SAL_CALL close () override
 
virtual css::uno::Reference< css::beans::XPropertySetInfo > SAL_CALL getPropertySetInfo () override
 
virtual void SAL_CALL setPropertyValue (const OUString &aPropertyName, const css::uno::Any &aValue) override
 
virtual css::uno::Any SAL_CALL getPropertyValue (const OUString &PropertyName) override
 
virtual void SAL_CALL addPropertyChangeListener (const OUString &aPropertyName, const css::uno::Reference< css::beans::XPropertyChangeListener > &xListener) override
 
virtual void SAL_CALL removePropertyChangeListener (const OUString &aPropertyName, const css::uno::Reference< css::beans::XPropertyChangeListener > &aListener) override
 
virtual void SAL_CALL addVetoableChangeListener (const OUString &PropertyName, const css::uno::Reference< css::beans::XVetoableChangeListener > &aListener) override
 
virtual void SAL_CALL removeVetoableChangeListener (const OUString &PropertyName, const css::uno::Reference< css::beans::XVetoableChangeListener > &aListener) override
 
void propertyChanged (const css::beans::PropertyChangeEvent &rEvt) const
 This method propagates property value changes to all registered listeners. More...
 
void rowCountChanged (sal_uInt32 nOld, sal_uInt32 nNew)
 This method should be called by the data supplier for the result set to indicate that there were new data obtained from the data source. More...
 
void rowCountFinal ()
 This method should be called by the data supplier for the result set to indicate that there were all rows obtained from the data source. More...
 
const css::uno::Sequence< css::beans::Property > & getProperties () const
 This method returns a sequence containing all properties ( not the values! ) of the result set. More...
 
const css::uno::Reference< css::ucb::XCommandEnvironment > & getEnvironment () const
 This method returns the environment to use for interactions, progress propagation, ... It can by empty. More...
 

Private Attributes

std::unique_ptr< ResultSet_Implm_pImpl
 

Detailed Description

This is an implementation of the service com.sun.star.ucb.ContentResultSet.

It can be used to implement the method XDynamicResultSet::getStaticResultSet, which needs to be implemented for instance to implement the command "open" at folder objects. This class uses a user supplied ResultSetDataSupplier object to request data on demand.

See also
ResultSetDataSupplier

Definition at line 59 of file resultset.hxx.

Constructor & Destructor Documentation

◆ ResultSet() [1/2]

ucbhelper::ResultSet::ResultSet ( const css::uno::Reference< css::uno::XComponentContext > &  rxContext,
const css::uno::Sequence< css::beans::Property > &  rProperties,
const rtl::Reference< ResultSetDataSupplier > &  rDataSupplier 
)

Construction.

Parameters
rxSMgris a Service Manager.
rPropertiesis a sequence of properties for that the resultset shall be able to obtain the values.
rDataSupplieris a supplier for the resultset data.

◆ ResultSet() [2/2]

ucbhelper::ResultSet::ResultSet ( const css::uno::Reference< css::uno::XComponentContext > &  rxContext,
const css::uno::Sequence< css::beans::Property > &  rProperties,
const rtl::Reference< ResultSetDataSupplier > &  rDataSupplier,
const css::uno::Reference< css::ucb::XCommandEnvironment > &  rxEnv 
)

Construction.

Parameters
rxSMgris a Service Manager.
rPropertiesis a sequence of properties for that the resultset shall be able to obtain the values.
rDataSupplieris a supplier for the resultset data.
rxEnvis the environment for interactions, progress propagation, ...

References absolute(), close, dispose(), first, getDouble(), getEnvironment(), getFloat(), getImplementationName(), getPropertyValue(), getString(), getSupportedServiceNames(), last, setPropertyValue(), and supportsService().

◆ ~ResultSet()

ucbhelper::ResultSet::~ResultSet ( )
overridevirtual

Definition at line 203 of file resultset.cxx.

Member Function Documentation

◆ absolute()

sal_Bool SAL_CALL ucbhelper::ResultSet::absolute ( sal_Int32  row)
overridevirtual

Definition at line 453 of file resultset.cxx.

References m_pImpl, and nCount.

◆ addEventListener()

void SAL_CALL ucbhelper::ResultSet::addEventListener ( const css::uno::Reference< css::lang::XEventListener > &  Listener)
overridevirtual

Definition at line 253 of file resultset.cxx.

References m_pImpl.

◆ addPropertyChangeListener()

void SAL_CALL ucbhelper::ResultSet::addPropertyChangeListener ( const OUString &  aPropertyName,
const css::uno::Reference< css::beans::XPropertyChangeListener > &  xListener 
)
overridevirtual

Definition at line 1235 of file resultset.cxx.

References m_pImpl.

◆ addVetoableChangeListener()

void SAL_CALL ucbhelper::ResultSet::addVetoableChangeListener ( const OUString &  PropertyName,
const css::uno::Reference< css::beans::XVetoableChangeListener > &  aListener 
)
overridevirtual

Definition at line 1277 of file resultset.cxx.

◆ afterLast()

void SAL_CALL ucbhelper::ResultSet::afterLast ( )
overridevirtual

Definition at line 394 of file resultset.cxx.

References m_pImpl.

◆ beforeFirst()

void SAL_CALL ucbhelper::ResultSet::beforeFirst ( )
overridevirtual

Definition at line 384 of file resultset.cxx.

References m_pImpl.

◆ close()

void SAL_CALL ucbhelper::ResultSet::close ( )
overridevirtual

Definition at line 1129 of file resultset.cxx.

References m_pImpl.

◆ dispose()

void SAL_CALL ucbhelper::ResultSet::dispose ( void  )
overridevirtual

Definition at line 230 of file resultset.cxx.

References m_pImpl.

◆ first()

sal_Bool SAL_CALL ucbhelper::ResultSet::first ( )
overridevirtual

Definition at line 403 of file resultset.cxx.

References m_pImpl.

◆ getArray()

uno::Reference< sdbc::XArray > SAL_CALL ucbhelper::ResultSet::getArray ( sal_Int32  columnIndex)
overridevirtual

Definition at line 1104 of file resultset.cxx.

References m_pImpl.

◆ getBinaryStream()

uno::Reference< io::XInputStream > SAL_CALL ucbhelper::ResultSet::getBinaryStream ( sal_Int32  columnIndex)
overridevirtual

Definition at line 965 of file resultset.cxx.

References m_pImpl.

◆ getBlob()

uno::Reference< sdbc::XBlob > SAL_CALL ucbhelper::ResultSet::getBlob ( sal_Int32  columnIndex)
overridevirtual

Definition at line 1058 of file resultset.cxx.

References m_pImpl.

◆ getBoolean()

sal_Bool SAL_CALL ucbhelper::ResultSet::getBoolean ( sal_Int32  columnIndex)
overridevirtual

Definition at line 720 of file resultset.cxx.

References m_pImpl.

◆ getByte()

sal_Int8 SAL_CALL ucbhelper::ResultSet::getByte ( sal_Int32  columnIndex)
overridevirtual

Definition at line 742 of file resultset.cxx.

References m_pImpl.

◆ getBytes()

uno::Sequence< sal_Int8 > SAL_CALL ucbhelper::ResultSet::getBytes ( sal_Int32  columnIndex)
overridevirtual

Definition at line 875 of file resultset.cxx.

References m_pImpl.

◆ getCharacterStream()

uno::Reference< io::XInputStream > SAL_CALL ucbhelper::ResultSet::getCharacterStream ( sal_Int32  columnIndex)
overridevirtual

Definition at line 988 of file resultset.cxx.

References m_pImpl.

◆ getClob()

uno::Reference< sdbc::XClob > SAL_CALL ucbhelper::ResultSet::getClob ( sal_Int32  columnIndex)
overridevirtual

Definition at line 1081 of file resultset.cxx.

References m_pImpl.

◆ getDate()

util::Date SAL_CALL ucbhelper::ResultSet::getDate ( sal_Int32  columnIndex)
overridevirtual

Definition at line 897 of file resultset.cxx.

References m_pImpl.

◆ getDouble()

double SAL_CALL ucbhelper::ResultSet::getDouble ( sal_Int32  columnIndex)
overridevirtual

Definition at line 852 of file resultset.cxx.

References m_pImpl.

◆ getEnvironment()

const uno::Reference< css::ucb::XCommandEnvironment > & ucbhelper::ResultSet::getEnvironment ( ) const

This method returns the environment to use for interactions, progress propagation, ... It can by empty.

Returns
an environment or an empty reference.

Definition at line 1364 of file resultset.cxx.

◆ getFloat()

float SAL_CALL ucbhelper::ResultSet::getFloat ( sal_Int32  columnIndex)
overridevirtual

Definition at line 830 of file resultset.cxx.

References m_pImpl.

◆ getImplementationName()

OUString SAL_CALL ucbhelper::ResultSet::getImplementationName ( )
overridevirtual

Definition at line 210 of file resultset.cxx.

◆ getInt()

sal_Int32 SAL_CALL ucbhelper::ResultSet::getInt ( sal_Int32  columnIndex)
overridevirtual

Definition at line 786 of file resultset.cxx.

References m_pImpl.

◆ getLong()

sal_Int64 SAL_CALL ucbhelper::ResultSet::getLong ( sal_Int32  columnIndex)
overridevirtual

Definition at line 808 of file resultset.cxx.

References m_pImpl.

◆ getMetaData()

uno::Reference< sdbc::XResultSetMetaData > SAL_CALL ucbhelper::ResultSet::getMetaData ( )
overridevirtual

Definition at line 276 of file resultset.cxx.

References m_pImpl.

◆ getObject()

uno::Any SAL_CALL ucbhelper::ResultSet::getObject ( sal_Int32  columnIndex,
const css::uno::Reference< css::container::XNameAccess > &  typeMap 
)
overridevirtual

Definition at line 1010 of file resultset.cxx.

References m_pImpl.

◆ getProperties()

const uno::Sequence< beans::Property > & ucbhelper::ResultSet::getProperties ( ) const

This method returns a sequence containing all properties ( not the values! ) of the result set.

Returns
a sequence of properties.

Definition at line 1357 of file resultset.cxx.

◆ getPropertySetInfo()

uno::Reference< beans::XPropertySetInfo > SAL_CALL ucbhelper::ResultSet::getPropertySetInfo ( )
overridevirtual

Definition at line 1178 of file resultset.cxx.

References ucbhelper_impl::aPropertyTable, m_pImpl, and RESULTSET_PROPERTY_COUNT.

◆ getPropertyValue()

uno::Any SAL_CALL ucbhelper::ResultSet::getPropertyValue ( const OUString &  PropertyName)
overridevirtual

Definition at line 1212 of file resultset.cxx.

References m_pImpl.

◆ getRef()

uno::Reference< sdbc::XRef > SAL_CALL ucbhelper::ResultSet::getRef ( sal_Int32  columnIndex)
overridevirtual

Definition at line 1035 of file resultset.cxx.

References m_pImpl.

◆ getRow()

sal_Int32 SAL_CALL ucbhelper::ResultSet::getRow ( )
overridevirtual

Definition at line 439 of file resultset.cxx.

References m_pImpl.

◆ getShort()

sal_Int16 SAL_CALL ucbhelper::ResultSet::getShort ( sal_Int32  columnIndex)
overridevirtual

Definition at line 764 of file resultset.cxx.

References m_pImpl.

◆ getStatement()

uno::Reference< uno::XInterface > SAL_CALL ucbhelper::ResultSet::getStatement ( )
overridevirtual

Definition at line 659 of file resultset.cxx.

References m_pImpl.

◆ getString()

OUString SAL_CALL ucbhelper::ResultSet::getString ( sal_Int32  columnIndex)
overridevirtual

Definition at line 698 of file resultset.cxx.

References m_pImpl.

◆ getSupportedServiceNames()

css::uno::Sequence< OUString > SAL_CALL ucbhelper::ResultSet::getSupportedServiceNames ( )
overridevirtual

Definition at line 220 of file resultset.cxx.

References ucbhelper::RESULTSET_SERVICE_NAME.

◆ getTime()

util::Time SAL_CALL ucbhelper::ResultSet::getTime ( sal_Int32  columnIndex)
overridevirtual

Definition at line 919 of file resultset.cxx.

References m_pImpl.

◆ getTimestamp()

util::DateTime SAL_CALL ucbhelper::ResultSet::getTimestamp ( sal_Int32  columnIndex)
overridevirtual

Definition at line 942 of file resultset.cxx.

References m_pImpl.

◆ isAfterLast()

sal_Bool SAL_CALL ucbhelper::ResultSet::isAfterLast ( )
overridevirtual

Definition at line 341 of file resultset.cxx.

References m_pImpl.

◆ isBeforeFirst()

sal_Bool SAL_CALL ucbhelper::ResultSet::isBeforeFirst ( )
overridevirtual

Definition at line 320 of file resultset.cxx.

References m_pImpl.

◆ isFirst()

sal_Bool SAL_CALL ucbhelper::ResultSet::isFirst ( )
overridevirtual

Definition at line 349 of file resultset.cxx.

References m_pImpl.

◆ isLast()

sal_Bool SAL_CALL ucbhelper::ResultSet::isLast ( )
overridevirtual

Definition at line 363 of file resultset.cxx.

References m_pImpl, and nCount.

◆ last()

sal_Bool SAL_CALL ucbhelper::ResultSet::last ( )
overridevirtual

Definition at line 421 of file resultset.cxx.

References m_pImpl, and nCount.

◆ next()

sal_Bool SAL_CALL ucbhelper::ResultSet::next ( )
overridevirtual

Definition at line 292 of file resultset.cxx.

References m_pImpl.

◆ previous()

sal_Bool SAL_CALL ucbhelper::ResultSet::previous ( )
overridevirtual

Definition at line 594 of file resultset.cxx.

References m_pImpl, and nCount.

◆ propertyChanged()

void ucbhelper::ResultSet::propertyChanged ( const css::beans::PropertyChangeEvent &  rEvt) const

This method propagates property value changes to all registered listeners.

Parameters
rEvtis a property change event.

Definition at line 1297 of file resultset.cxx.

References m_pImpl, and comphelper::OInterfaceContainerHelper4< class ListenerT >::notifyEach().

◆ queryContent()

uno::Reference< css::ucb::XContent > SAL_CALL ucbhelper::ResultSet::queryContent ( )
overridevirtual

Definition at line 1164 of file resultset.cxx.

References m_pImpl.

◆ queryContentIdentifier()

uno::Reference< css::ucb::XContentIdentifier > SAL_CALL ucbhelper::ResultSet::queryContentIdentifier ( )
overridevirtual

Definition at line 1152 of file resultset.cxx.

References m_pImpl.

◆ queryContentIdentifierString()

OUString SAL_CALL ucbhelper::ResultSet::queryContentIdentifierString ( )
overridevirtual

Definition at line 1140 of file resultset.cxx.

References m_pImpl.

◆ refreshRow()

void SAL_CALL ucbhelper::ResultSet::refreshRow ( )
overridevirtual

Definition at line 623 of file resultset.cxx.

References m_pImpl.

◆ relative()

sal_Bool SAL_CALL ucbhelper::ResultSet::relative ( sal_Int32  rows)
overridevirtual

Definition at line 525 of file resultset.cxx.

References m_pImpl, and nCount.

◆ removeEventListener()

void SAL_CALL ucbhelper::ResultSet::removeEventListener ( const css::uno::Reference< css::lang::XEventListener > &  Listener)
overridevirtual

Definition at line 263 of file resultset.cxx.

References m_pImpl.

◆ removePropertyChangeListener()

void SAL_CALL ucbhelper::ResultSet::removePropertyChangeListener ( const OUString &  aPropertyName,
const css::uno::Reference< css::beans::XPropertyChangeListener > &  aListener 
)
overridevirtual

Definition at line 1258 of file resultset.cxx.

References m_pImpl.

◆ removeVetoableChangeListener()

void SAL_CALL ucbhelper::ResultSet::removeVetoableChangeListener ( const OUString &  PropertyName,
const css::uno::Reference< css::beans::XVetoableChangeListener > &  aListener 
)
overridevirtual

Definition at line 1286 of file resultset.cxx.

◆ rowCountChanged()

void ucbhelper::ResultSet::rowCountChanged ( sal_uInt32  nOld,
sal_uInt32  nNew 
)

This method should be called by the data supplier for the result set to indicate that there were new data obtained from the data source.

Parameters
nOldis the old count of rows; must be non-negative.
nnewis the new count of rows; must be non-negative.

Definition at line 1323 of file resultset.cxx.

References RowCount.

◆ rowCountFinal()

void ucbhelper::ResultSet::rowCountFinal ( )

This method should be called by the data supplier for the result set to indicate that there were all rows obtained from the data source.

Definition at line 1341 of file resultset.cxx.

◆ rowDeleted()

sal_Bool SAL_CALL ucbhelper::ResultSet::rowDeleted ( )
overridevirtual

Definition at line 651 of file resultset.cxx.

References m_pImpl.

◆ rowInserted()

sal_Bool SAL_CALL ucbhelper::ResultSet::rowInserted ( )
overridevirtual

Definition at line 643 of file resultset.cxx.

References m_pImpl.

◆ rowUpdated()

sal_Bool SAL_CALL ucbhelper::ResultSet::rowUpdated ( )
overridevirtual

Definition at line 635 of file resultset.cxx.

References m_pImpl.

◆ setPropertyValue()

void SAL_CALL ucbhelper::ResultSet::setPropertyValue ( const OUString &  aPropertyName,
const css::uno::Any &  aValue 
)
overridevirtual

Definition at line 1191 of file resultset.cxx.

◆ supportsService()

sal_Bool SAL_CALL ucbhelper::ResultSet::supportsService ( const OUString &  ServiceName)
overridevirtual

Definition at line 215 of file resultset.cxx.

References ServiceName, and cppu::supportsService().

◆ wasNull()

sal_Bool SAL_CALL ucbhelper::ResultSet::wasNull ( )
overridevirtual

Definition at line 674 of file resultset.cxx.

References m_pImpl.

Member Data Documentation

◆ m_pImpl

std::unique_ptr<ResultSet_Impl> ucbhelper::ResultSet::m_pImpl
private

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