org.apache.directory.shared.ldap.subtree
Class SubtreeSpecificationModifier

java.lang.Object
  extended byorg.apache.directory.shared.ldap.subtree.SubtreeSpecificationModifier

public class SubtreeSpecificationModifier
extends java.lang.Object

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

Version:
$Rev: 379008 $
Author:
Apache Directory Project

Constructor Summary
SubtreeSpecificationModifier()
           
 
Method Summary
 SubtreeSpecification getSubtreeSpecification()
          Creates a SubtreeSpecification using any of the default paramters that may have been modified from their defaults.
 void setBase(javax.naming.Name base)
          Sets the subtree base relative to the administration point.
 void setChopAfterExclusions(java.util.Set chopAfter)
          Sets the set of subordinates entries whose subordinates are to be excluded.
 void setChopBeforeExclusions(java.util.Set chopBefore)
          Sets the set of subordinates entries and their subordinates to exclude.
 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
 

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(javax.naming.Name base)
Sets the subtree base relative to the administration point.

Parameters:
base - subtree base relative to the administration point

setChopBeforeExclusions

public void setChopBeforeExclusions(java.util.Set chopBefore)
Sets the set of subordinates entries and their subordinates to exclude.

Parameters:
chopBefore - the set of subordinates entries and their subordinates to exclude

setChopAfterExclusions

public void setChopAfterExclusions(java.util.Set chopAfter)
Sets the set of subordinates entries whose subordinates are to be excluded.

Parameters:
chopAfter - 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


Copyright © 2003-2006 . All Rights Reserved.