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
-
-
Constructor Summary
Constructors Constructor Description SubtreeSpecificationModifier()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method 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 filtervoid
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.
-
-
-
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
-
-