chelp::URLParameter Class Reference

#include <urlparameter.hxx>

Collaboration diagram for chelp::URLParameter:

Public Member Functions
	URLParameter (const OUString &aURL, Databases *pDatabases)
bool	isActive () const
bool	isQuery () const
bool	isFile () const
bool	isModule () const
bool	isRoot () const
bool	isErrorDocument ()
OUString const &	get_id ()
OUString	get_tag ()
OUString const &	get_path ()
const OUString &	get_eid () const
OUString	get_title ()
OUString	get_jar ()
const OUString &	get_ExtensionRegistryPath () const
const OUString &	get_module () const
OUString const &	get_dbpar () const
OUString const &	get_language () const
OUString const &	get_program ()
const OUString &	get_query () const
const OUString &	get_scope () const
const OUString &	get_system () const
sal_Int32	get_hitCount () const
OString	getByName (const char *par)
void	open (const css::uno::Reference< css::io::XActiveDataSink > &xDataSink)
void	open (const css::uno::Reference< css::io::XOutputStream > &xDataSink)

Private Member Functions
void	init ()
OUString	get_the_tag ()
OUString	get_the_title ()
void	readHelpDataFile ()
void	parse ()
bool	scheme ()
bool	module ()
bool	name (bool modulePresent)
bool	query ()

Private Attributes
Databases *	m_pDatabases
bool	m_bHelpDataFileRead
bool	m_bUseDB
OUString	m_aURL
OUString	m_aTag
OUString	m_aId
OUString	m_aPath
OUString	m_aModule
OUString	m_aTitle
OUString	m_aJar
OUString	m_aExtensionRegistryPath
OUString	m_aEid
OUString	m_aDbPar
OUString	m_aLanguage
OUString	m_aPrefix
OUString	m_aProgram
OUString	m_aSystem
OUString	m_aActive
OUString	m_aQuery
OUString	m_aScope
OUString	m_aExpr
sal_Int32	m_nHitCount

Detailed Description

Definition at line 105 of file urlparameter.hxx.

Constructor & Destructor Documentation

URLParameter()

URLParameter::URLParameter	(	const OUString &	aURL,
		Databases *	pDatabases
	)

Exceptions

css::ucb::IllegalIdentifierException

Definition at line 59 of file urlparameter.cxx.

References aURL, init(), m_aURL, and parse().

Member Function Documentation

get_dbpar()

OUString const & chelp::URLParameter::get_dbpar ( ) const

inline

Definition at line 137 of file urlparameter.hxx.

References m_aDbPar, and m_aModule.

Referenced by getByName().

get_eid()

const OUString & chelp::URLParameter::get_eid ( ) const

inline

Definition at line 127 of file urlparameter.hxx.

References m_aEid.

get_ExtensionRegistryPath()

const OUString & chelp::URLParameter::get_ExtensionRegistryPath ( ) const

inline

Definition at line 133 of file urlparameter.hxx.

References m_aExtensionRegistryPath.

get_hitCount()

sal_Int32 chelp::URLParameter::get_hitCount ( ) const

inline

Definition at line 155 of file urlparameter.hxx.

References m_nHitCount.

Referenced by chelp::ResultSetForQuery::ResultSetForQuery().

get_id()

OUString const & URLParameter::get_id

(

)

Definition at line 109 of file urlparameter.cxx.

References chelp::StaticModuleInformation::get_id(), get_language(), get_module(), chelp::Databases::getStaticInformationForModule(), m_aId, and m_pDatabases.

Referenced by get_path(), getByName(), and readHelpDataFile().

get_jar()

OUString URLParameter::get_jar

(

)

Definition at line 222 of file urlparameter.cxx.

References get_module(), m_aJar, m_bHelpDataFileRead, m_bUseDB, and readHelpDataFile().

Referenced by helpOpen(), and isErrorDocument().

get_language()

OUString const & URLParameter::get_language

(

)

const

Definition at line 151 of file urlparameter.cxx.

References m_aLanguage.

Referenced by get_id(), get_program(), get_title(), getByName(), helpOpen(), isErrorDocument(), readHelpDataFile(), chelp::ResultSetForQuery::ResultSetForQuery(), and chelp::ResultSetForRoot::ResultSetForRoot().

get_module()

const OUString & chelp::URLParameter::get_module ( ) const

inline

Definition at line 135 of file urlparameter.hxx.

References m_aModule.

Referenced by get_id(), get_jar(), get_program(), get_title(), getByName(), readHelpDataFile(), and chelp::ResultSetForQuery::ResultSetForQuery().

get_path()

OUString const & URLParameter::get_path

(

)

Definition at line 194 of file urlparameter.cxx.

References get_id(), m_aPath, m_bHelpDataFileRead, m_bUseDB, and readHelpDataFile().

Referenced by getByName(), helpOpen(), and isErrorDocument().

get_program()

OUString const & URLParameter::get_program

(

)

Definition at line 157 of file urlparameter.cxx.

References get_language(), get_module(), chelp::StaticModuleInformation::get_program(), chelp::Databases::getStaticInformationForModule(), m_aProgram, and m_pDatabases.

Referenced by getByName().

get_query()

const OUString & chelp::URLParameter::get_query ( ) const

inline

Definition at line 149 of file urlparameter.hxx.

References m_aQuery.

Referenced by chelp::ResultSetForQuery::ResultSetForQuery().

get_scope()

const OUString & chelp::URLParameter::get_scope ( ) const

inline

Definition at line 151 of file urlparameter.hxx.

References m_aScope.

Referenced by chelp::ResultSetForQuery::ResultSetForQuery().

get_system()

const OUString & chelp::URLParameter::get_system ( ) const

inline

Definition at line 153 of file urlparameter.hxx.

References m_aSystem.

Referenced by getByName(), chelp::ResultSetForQuery::ResultSetForQuery(), and chelp::ResultSetForRoot::ResultSetForRoot().

get_tag()

OUString URLParameter::get_tag

(

)

Definition at line 123 of file urlparameter.cxx.

References get_the_tag(), isFile(), and m_aTag.

get_the_tag()

OUString URLParameter::get_the_tag ( )

private

Definition at line 179 of file urlparameter.cxx.

References m_aTag, m_bHelpDataFileRead, m_bUseDB, and readHelpDataFile().

Referenced by get_tag().

get_the_title()

OUString URLParameter::get_the_title ( )

private

Definition at line 208 of file urlparameter.cxx.

References m_aTitle, m_bHelpDataFileRead, m_bUseDB, and readHelpDataFile().

Referenced by get_title().

get_title()

OUString URLParameter::get_title

(

)

Definition at line 132 of file urlparameter.cxx.

References get_language(), get_module(), get_the_title(), chelp::StaticModuleInformation::get_title(), chelp::Databases::getStaticInformationForModule(), isFile(), m_aModule, m_aTitle, and m_pDatabases.

getByName()

OString URLParameter::getByName

(

const char *

par

)

Definition at line 84 of file urlparameter.cxx.

References get_dbpar(), get_id(), get_language(), get_module(), get_path(), get_program(), get_system(), m_aPrefix, and OUStringToOString().

init()

void URLParameter::init ( )

private

Definition at line 171 of file urlparameter.cxx.

References m_bHelpDataFileRead, m_bUseDB, and m_nHitCount.

Referenced by URLParameter().

isActive()

bool chelp::URLParameter::isActive ( ) const

inline

Definition at line 112 of file urlparameter.hxx.

References m_aActive.

isErrorDocument()

bool URLParameter::isErrorDocument

(

)

Definition at line 69 of file urlparameter.cxx.

References chelp::Databases::findJarFileForPath(), get_jar(), get_language(), get_path(), isFile(), and m_pDatabases.

isFile()

bool chelp::URLParameter::isFile ( ) const

inline

Definition at line 114 of file urlparameter.hxx.

References m_aId.

Referenced by get_tag(), get_title(), and isErrorDocument().

isModule()

bool chelp::URLParameter::isModule ( ) const

inline

Definition at line 115 of file urlparameter.hxx.

References m_aId, and m_aModule.

isQuery()

bool chelp::URLParameter::isQuery ( ) const

inline

Definition at line 113 of file urlparameter.hxx.

References m_aId, and m_aQuery.

isRoot()

bool chelp::URLParameter::isRoot ( ) const

inline

Definition at line 116 of file urlparameter.hxx.

References m_aModule.

module()

bool URLParameter::module ( )

private

Definition at line 406 of file urlparameter.cxx.

References idx, length, m_aExpr, and m_aModule.

Referenced by parse().

name()

bool URLParameter::name ( bool  modulePresent )

private

Definition at line 424 of file urlparameter.cxx.

References idx, length, m_aExpr, and m_aId.

Referenced by parse().

open() [1/2]

void chelp::URLParameter::open

(

const css::uno::Reference< css::io::XActiveDataSink > &

xDataSink

)

open() [2/2]

void chelp::URLParameter::open

(

const css::uno::Reference< css::io::XOutputStream > &

xDataSink

)

parse()

void URLParameter::parse ( )

private

Exceptions

css::ucb::IllegalIdentifierException

Definition at line 359 of file urlparameter.cxx.

References m_aExpr, m_aLanguage, m_aSystem, m_aURL, module(), name(), query(), and scheme().

Referenced by URLParameter().

query()

bool URLParameter::query ( )

private

Definition at line 449 of file urlparameter.cxx.

References m_aActive, m_aDbPar, m_aEid, m_aExpr, m_aLanguage, m_aPrefix, m_aProgram, m_aQuery, m_aScope, m_aSystem, m_bUseDB, m_nHitCount, o3tl::trim(), and value.

Referenced by parse().

readHelpDataFile()

void URLParameter::readHelpDataFile ( )

private

Definition at line 236 of file urlparameter.cxx.

References get_id(), get_language(), get_module(), helpdatafileproxy::HDFData::getData(), chelp::DbtToStringConverter::getDatabase(), chelp::DbtToStringConverter::getFile(), chelp::DbtToStringConverter::getHash(), chelp::DbtToStringConverter::getTitle(), helpdatafileproxy::Hdf::getValueForKey(), m_aExtensionRegistryPath, m_aId, m_aJar, m_aPath, m_aTag, m_aTitle, m_pDatabases, chelp::DataBaseIterator::nextHdf(), OUStringToOString(), pData, and chelp::Databases::replaceName().

Referenced by get_jar(), get_path(), get_the_tag(), and get_the_title().

scheme()

bool URLParameter::scheme ( )

private

Definition at line 376 of file urlparameter.cxx.

References m_aExpr, and u.

Referenced by parse().

Member Data Documentation

m_aActive

OUString chelp::URLParameter::m_aActive

private

Definition at line 187 of file urlparameter.hxx.

Referenced by isActive(), and query().

m_aDbPar

OUString chelp::URLParameter::m_aDbPar

private

Definition at line 180 of file urlparameter.hxx.

Referenced by get_dbpar(), and query().

m_aEid

OUString chelp::URLParameter::m_aEid

private

Definition at line 179 of file urlparameter.hxx.

Referenced by get_eid(), and query().

m_aExpr

OUString chelp::URLParameter::m_aExpr

private

Definition at line 192 of file urlparameter.hxx.

Referenced by module(), name(), parse(), query(), and scheme().

m_aExtensionRegistryPath

OUString chelp::URLParameter::m_aExtensionRegistryPath

private

Definition at line 178 of file urlparameter.hxx.

Referenced by get_ExtensionRegistryPath(), and readHelpDataFile().

m_aId

OUString chelp::URLParameter::m_aId

private

Definition at line 173 of file urlparameter.hxx.

Referenced by get_id(), isFile(), isModule(), isQuery(), name(), and readHelpDataFile().

m_aJar

OUString chelp::URLParameter::m_aJar

private

Definition at line 177 of file urlparameter.hxx.

Referenced by get_jar(), and readHelpDataFile().

m_aLanguage

OUString chelp::URLParameter::m_aLanguage

private

Definition at line 182 of file urlparameter.hxx.

Referenced by get_language(), parse(), and query().

m_aModule

OUString chelp::URLParameter::m_aModule

private

Definition at line 175 of file urlparameter.hxx.

Referenced by get_dbpar(), get_module(), get_title(), isModule(), isRoot(), and module().

m_aPath

OUString chelp::URLParameter::m_aPath

private

Definition at line 174 of file urlparameter.hxx.

Referenced by get_path(), and readHelpDataFile().

m_aPrefix

OUString chelp::URLParameter::m_aPrefix

private

Definition at line 184 of file urlparameter.hxx.

Referenced by getByName(), and query().

m_aProgram

OUString chelp::URLParameter::m_aProgram

private

Definition at line 185 of file urlparameter.hxx.

Referenced by get_program(), and query().

m_aQuery

OUString chelp::URLParameter::m_aQuery

private

Definition at line 189 of file urlparameter.hxx.

Referenced by get_query(), isQuery(), and query().

m_aScope

OUString chelp::URLParameter::m_aScope

private

Definition at line 190 of file urlparameter.hxx.

Referenced by get_scope(), and query().

m_aSystem

OUString chelp::URLParameter::m_aSystem

private

Definition at line 186 of file urlparameter.hxx.

Referenced by get_system(), parse(), and query().

m_aTag

OUString chelp::URLParameter::m_aTag

private

Definition at line 172 of file urlparameter.hxx.

Referenced by get_tag(), get_the_tag(), and readHelpDataFile().

m_aTitle

OUString chelp::URLParameter::m_aTitle

private

Definition at line 176 of file urlparameter.hxx.

Referenced by get_the_title(), get_title(), and readHelpDataFile().

m_aURL

OUString chelp::URLParameter::m_aURL

private

Definition at line 170 of file urlparameter.hxx.

Referenced by parse().

m_bHelpDataFileRead

bool chelp::URLParameter::m_bHelpDataFileRead

private

Definition at line 167 of file urlparameter.hxx.

Referenced by get_jar(), get_path(), get_the_tag(), get_the_title(), and init().

m_bUseDB

bool chelp::URLParameter::m_bUseDB

private

Definition at line 168 of file urlparameter.hxx.

Referenced by get_jar(), get_path(), get_the_tag(), get_the_title(), init(), and query().

m_nHitCount

sal_Int32 chelp::URLParameter::m_nHitCount

private

Definition at line 194 of file urlparameter.hxx.

Referenced by get_hitCount(), init(), and query().

m_pDatabases

Databases* chelp::URLParameter::m_pDatabases

private

Definition at line 165 of file urlparameter.hxx.

Referenced by get_id(), get_program(), get_title(), isErrorDocument(), and readHelpDataFile().

---

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

• urlparameter.hxx
• urlparameter.cxx