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

class implementing the IObjectNameCheck interface, and checking given object names against a hierarchical name container More...

#include <defaultobjectnamecheck.hxx>

Inheritance diagram for dbaui::HierarchicalNameCheck:
[legend]
Collaboration diagram for dbaui::HierarchicalNameCheck:
[legend]

Public Member Functions

 HierarchicalNameCheck (const css::uno::Reference< css::container::XHierarchicalNameAccess > &_rxNames, const OUString &_rRelativeRoot)
 constructs a HierarchicalNameCheck instance More...
 
virtual ~HierarchicalNameCheck () override
 
 HierarchicalNameCheck (const HierarchicalNameCheck &)=delete
 
const HierarchicalNameCheckoperator= (const HierarchicalNameCheck &)=delete
 
virtual bool isNameValid (const OUString &_rObjectName, ::dbtools::SQLExceptionInfo &_out_rErrorToDisplay) const override
 determines whether a given object name is valid More...
 
- Public Member Functions inherited from dbaui::IObjectNameCheck
virtual bool isNameValid (const OUString &_rObjectName, ::dbtools::SQLExceptionInfo &_out_rErrorToDisplay) const =0
 determines whether a given object name is valid More...
 
virtual ~IObjectNameCheck ()
 

Private Attributes

css::uno::Reference< css::container::XHierarchicalNameAccess > mxHierarchicalNames
 
OUString msRelativeRoot
 

Detailed Description

class implementing the IObjectNameCheck interface, and checking given object names against a hierarchical name container

Definition at line 37 of file defaultobjectnamecheck.hxx.

Constructor & Destructor Documentation

◆ HierarchicalNameCheck() [1/2]

dbaui::HierarchicalNameCheck::HierarchicalNameCheck ( const css::uno::Reference< css::container::XHierarchicalNameAccess > &  _rxNames,
const OUString &  _rRelativeRoot 
)

constructs a HierarchicalNameCheck instance

Parameters
_rxNamesthe hierarchical container of named objects, against which given names should be checked
_rRelativeRootthe root in the hierarchy against which given names should be checked
Exceptions
css::lang::IllegalArgumentExceptionif the given container is <NULL>

◆ ~HierarchicalNameCheck()

dbaui::HierarchicalNameCheck::~HierarchicalNameCheck ( )
overridevirtual

Definition at line 79 of file defaultobjectnamecheck.cxx.

◆ HierarchicalNameCheck() [2/2]

dbaui::HierarchicalNameCheck::HierarchicalNameCheck ( const HierarchicalNameCheck )
delete

Member Function Documentation

◆ isNameValid()

bool dbaui::HierarchicalNameCheck::isNameValid ( const OUString &  _rObjectName,
::dbtools::SQLExceptionInfo _out_rErrorToDisplay 
) const
overridevirtual

determines whether a given object name is valid

Parameters
_rObjectNamethe name to check
_out_rErrorToDisplayoutput parameter taking an error message describing why the name is not valid, if applicable.
Returns
<TRUE> if and only if the given name is valid.

Implements dbaui::IObjectNameCheck.

Definition at line 83 of file defaultobjectnamecheck.cxx.

References DBG_UNHANDLED_EXCEPTION, Exception, msRelativeRoot, and mxHierarchicalNames.

◆ operator=()

const HierarchicalNameCheck & dbaui::HierarchicalNameCheck::operator= ( const HierarchicalNameCheck )
delete

Member Data Documentation

◆ msRelativeRoot

OUString dbaui::HierarchicalNameCheck::msRelativeRoot
private

Definition at line 41 of file defaultobjectnamecheck.hxx.

Referenced by isNameValid().

◆ mxHierarchicalNames

css::uno::Reference< css::container::XHierarchicalNameAccess > dbaui::HierarchicalNameCheck::mxHierarchicalNames
private

Definition at line 40 of file defaultobjectnamecheck.hxx.

Referenced by isNameValid().


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