org.apache.directory.api.ldap.model.subtree

Class SubtreeSpecificationModifier

java.lang.Object

org.apache.directory.api.ldap.model.subtree.SubtreeSpecificationModifier

public class SubtreeSpecificationModifier
extends Object

SubtreeSpecification contains no setters so they must be built by a modifiable object containing all the necessary parameters to build the base object.

Author:

Apache Directory Project

Field Summary

Fields

Modifier and Type	Field and Description
private Dn	base the subtree base relative to the administration point
private Set<Dn>	chopAfter the set of subordinates entries whose subordinates are to be excluded
private Set<Dn>	chopBefore the set of subordinates entries and their subordinates to exclude
private ExprNode	filter a filter using only assertions on objectClass attributes for subtree refinement
private int	maxBaseDistance the maximum distance from base past which entries are excluded
private int	minBaseDistance the minimum distance below base to start including entries

Constructor Summary

Constructors

Constructor and Description
SubtreeSpecificationModifier()

Method Summary

Modifier and Type	Method and Description
SubtreeSpecification	getSubtreeSpecification() Creates a SubtreeSpecification using any of the default paramters that may have been modified from their defaults.
void	setBase(Dn base) Sets the subtree base relative to the administration point.
void	setChopAfterExclusions(Set<Dn> chopAfterExclusions) Sets the set of subordinates entries whose subordinates are to be excluded.
void	setChopBeforeExclusions(Set<Dn> chopBeforeExclusions) Sets the set of subordinates entries and their subordinates to exclude.
void	setFilter(ExprNode filter) Sets a filter
void	setMaxBaseDistance(int maxBaseDistance) Sets the maximum distance from base past which entries are excluded.
void	setMinBaseDistance(int minBaseDistance) Sets the minimum distance below base to start including entries.
void	setRefinement(ExprNode refinement) Sets a filter using only assertions on objectClass attributes for subtree refinement.

Methods inherited from class java.lang.Object

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

Field Detail

base

private Dn base

the subtree base relative to the administration point

chopBefore

private Set<Dn> chopBefore

the set of subordinates entries and their subordinates to exclude

chopAfter

private Set<Dn> chopAfter

the set of subordinates entries whose subordinates are to be excluded

minBaseDistance

private int minBaseDistance

the minimum distance below base to start including entries

maxBaseDistance

private int maxBaseDistance

the maximum distance from base past which entries are excluded

filter

private ExprNode filter

a filter using only assertions on objectClass attributes for subtree refinement

Constructor Detail

SubtreeSpecificationModifier

public SubtreeSpecificationModifier()

Method Detail

getSubtreeSpecification

public SubtreeSpecification getSubtreeSpecification()

Creates a SubtreeSpecification using any of the default paramters that may have been modified from their defaults.

Returns:

the newly created subtree specification

setBase

public void setBase(Dn base)

Sets the subtree base relative to the administration point.

Parameters:

base - subtree base relative to the administration point

setChopBeforeExclusions

public void setChopBeforeExclusions(Set<Dn> chopBeforeExclusions)

Sets the set of subordinates entries and their subordinates to exclude.

Parameters:

chopBeforeExclusions - the set of subordinates entries and their subordinates to exclude

setChopAfterExclusions

public void setChopAfterExclusions(Set<Dn> chopAfterExclusions)

Sets the set of subordinates entries whose subordinates are to be excluded.

Parameters:

chopAfterExclusions - the set of subordinates entries whose subordinates are to be excluded

setMinBaseDistance

public void setMinBaseDistance(int minBaseDistance)

Sets the minimum distance below base to start including entries.

Parameters:

minBaseDistance - the minimum distance below base to start including entries

setMaxBaseDistance

public void setMaxBaseDistance(int maxBaseDistance)

Sets the maximum distance from base past which entries are excluded.

Parameters:

maxBaseDistance - the maximum distance from base past which entries are excluded

setRefinement

public void setRefinement(ExprNode refinement)

Sets a filter using only assertions on objectClass attributes for subtree refinement.

Parameters:

refinement - a filter using only assertions on objectClass attributes for subtree refinement

setFilter

public void setFilter(ExprNode filter)

Sets a filter

Parameters:

filter - a filter