![]() |
CTK
0.1.0
The Common Toolkit is a community effort to provide support code for medical image analysis, surgical navigation, and related projects.
|
#include <Libs/PluginFramework/ctkLDAPSearchFilter.h>
Public Member Functions | |
ctkLDAPSearchFilter () | |
ctkLDAPSearchFilter (const ctkLDAPSearchFilter &other) | |
ctkLDAPSearchFilter (const QString &filter) | |
bool | match (const ctkDictionary &dictionary) const |
bool | match (const ctkServiceReference &reference) const |
bool | matchCase (const ctkDictionary &dictionary) const |
operator bool () const | |
ctkLDAPSearchFilter & | operator= (const ctkLDAPSearchFilter &filter) |
bool | operator== (const ctkLDAPSearchFilter &other) const |
QString | toString () const |
~ctkLDAPSearchFilter () | |
Protected Attributes | |
QSharedDataPointer< ctkLDAPSearchFilterData > | d |
An RFC 1960-based Filter.
A ctkLDAPSearchFilter
can be used numerous times to determine if the match argument matches the filter string that was used to create the ctkLDAPSearchFilter
.
Some examples of LDAP filters are:
* "(cn=Babs Jensen)" * "(!(cn=Tim Howes))" * "(&(" + ctkPluginConstants::OBJECTCLASS + "=Person)(|(sn=Jensen)(cn=Babs J*)))" * "(o=univ*of*mich*)" *
Definition at line 56 of file ctkLDAPSearchFilter.h.
ctkLDAPSearchFilter::ctkLDAPSearchFilter | ( | ) |
Creates in invalid ctkLDAPSearchFilter
object. Test the validity by using the boolean conversion operator.
Calling methods on an invalid ctkLDAPSearchFilter
will result in undefined behavior.
ctkLDAPSearchFilter::ctkLDAPSearchFilter | ( | const QString & | filter | ) |
Creates a ctkLDAPSearchFilter
object. This ctkLDAPSearchFilter
object may be used to match a ctkServiceReference
object or a ctkDictionary
object.
If the filter cannot be parsed, an ctkInvalidArgumentException will be thrown with a human readable message where the filter became unparsable.
filter | The filter string. |
ctkLDAPSearchFilter
object encapsulating the filter string. ctkInvalidArgumentException | If filter contains an invalid filter string that cannot be parsed. |
ctkLDAPSearchFilter::ctkLDAPSearchFilter | ( | const ctkLDAPSearchFilter & | other | ) |
ctkLDAPSearchFilter::~ctkLDAPSearchFilter | ( | ) |
bool ctkLDAPSearchFilter::match | ( | const ctkDictionary & | dictionary | ) | const |
Filter using a ctkDictionary
with case insensitive key lookup. This ctkLDAPSearchFilter
is executed using the specified ctkDictionary
's keys and values. The keys are looked up in a case insensitive manner.
dictionary | The ctkDictionary whose key/value pairs are used in the match. |
true
if the ctkDictionary
's values match this filter; false
otherwise. bool ctkLDAPSearchFilter::match | ( | const ctkServiceReference & | reference | ) | const |
Filter using a service's properties.
This ctkLDAPSearchFilter
is executed using the keys and values of the referenced service's properties. The keys are looked up in a case insensitive manner.
reference | The reference to the service whose properties are used in the match. |
true
if the service's properties match this ctkLDAPSearchFilter
false
otherwise. bool ctkLDAPSearchFilter::matchCase | ( | const ctkDictionary & | dictionary | ) | const |
Filter using a ctkDictionary
. This ctkLDAPSearchFilter
is executed using the specified ctkDictionary
's keys and values. The keys are looked up in a normal manner respecting case.
dictionary | The ctkDictionary whose key/value pairs are used in the match. |
true
if the ctkDictionary
's values match this filter; false
otherwise. ctkLDAPSearchFilter::operator bool | ( | ) | const |
ctkLDAPSearchFilter& ctkLDAPSearchFilter::operator= | ( | const ctkLDAPSearchFilter & | filter | ) |
bool ctkLDAPSearchFilter::operator== | ( | const ctkLDAPSearchFilter & | other | ) | const |
Compares this ctkLDAPSearchFilter
to another ctkLDAPSearchFilter
.
This implementation returns the result of calling this->toString() == other.toString()
.
other | The object to compare against this ctkLDAPSearchFilter . |
this->toString() == other.toString()
. QString ctkLDAPSearchFilter::toString | ( | ) | const |
Returns this ctkLDAPSearchFilter
's filter string.
The filter string is normalized by removing whitespace which does not affect the meaning of the filter.
ctkLDAPSearchFilter
's filter string.
|
protected |
Definition at line 158 of file ctkLDAPSearchFilter.h.