org.apache.directory.ldap.client.api.search

Class MatchingRuleAssertionFilter

java.lang.Object

org.apache.directory.ldap.client.api.search.AbstractFilter

org.apache.directory.ldap.client.api.search.MatchingRuleAssertionFilter

All Implemented Interfaces:

Filter

class MatchingRuleAssertionFilter
extends AbstractFilter

A class to represent the extensible matching filter.

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String	attribute The associated attribute
private java.lang.String	matchingRule The rule to use
private FilterOperator	operator The Filter operator
private boolean	useDnAttributes Whether or not to include dn attributes in the matching
private java.lang.String	value The filter value

Constructor Summary

Constructors

Constructor and Description
MatchingRuleAssertionFilter(java.lang.String attribute, java.lang.String value, FilterOperator operator) Creates a new instance of MatchingRuleAssertionFilter.

Method Summary

Modifier and Type	Method and Description
java.lang.StringBuilder	build(java.lang.StringBuilder builder)
static MatchingRuleAssertionFilter	extensible(java.lang.String value) Creates a new instance of MatchingRuleAssertionFilter without an attribute.
static MatchingRuleAssertionFilter	extensible(java.lang.String attribute, java.lang.String value) Creates an extensible filter
MatchingRuleAssertionFilter	setMatchingRule(java.lang.String matchingRule) Sets the matching rule to use.
MatchingRuleAssertionFilter	useDnAttributes() If set, the dn attributes will be included in the matching.

Methods inherited from class org.apache.directory.ldap.client.api.search.AbstractFilter

build

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

attribute

private java.lang.String attribute

The associated attribute

matchingRule

private java.lang.String matchingRule

The rule to use

operator

private FilterOperator operator

The Filter operator

useDnAttributes

private boolean useDnAttributes

Whether or not to include dn attributes in the matching

value

private java.lang.String value

The filter value

Constructor Detail

MatchingRuleAssertionFilter

MatchingRuleAssertionFilter(java.lang.String attribute,
                            java.lang.String value,
                            FilterOperator operator)

Creates a new instance of MatchingRuleAssertionFilter.

Parameters:

attribute - The attribute to test

value - The value to test for

operator - The FilterOperator

Method Detail

extensible

public static MatchingRuleAssertionFilter extensible(java.lang.String value)

Creates a new instance of MatchingRuleAssertionFilter without an attribute.

Parameters:

value - The value to test for

Returns:

A new MatchingRuleAssertionFilter

extensible

public static MatchingRuleAssertionFilter extensible(java.lang.String attribute,
                                                     java.lang.String value)

Creates an extensible filter

Parameters:

attribute - The attribute to test

value - The value to test for

Returns:

A new MatchingRuleAssertionFilter

setMatchingRule

public MatchingRuleAssertionFilter setMatchingRule(java.lang.String matchingRule)

Sets the matching rule to use. Can be either a name or an OID string.

Parameters:

matchingRule - The matching rule to use

Returns:

This filter

useDnAttributes

public MatchingRuleAssertionFilter useDnAttributes()

If set, the dn attributes will be included in the matching.

Returns:

This filter

build

public java.lang.StringBuilder build(java.lang.StringBuilder builder)