public class BaseSubtreeSpecification extends Object implements SubtreeSpecification
UNBOUNDED_MAX
Constructor and Description |
---|
BaseSubtreeSpecification()
Creates a simple subtree whose administrative point is necessarily the
base and all subordinates underneath (excluding those that are part of
inner areas) are part of the the subtree.
|
BaseSubtreeSpecification(Dn base)
Creates a simple subtree whose administrative point above the base and
all subordinates underneath the base (excluding those that are part of
inner areas) are part of the the subtree.
|
BaseSubtreeSpecification(Dn base,
int minBaseDistance,
int maxBaseDistance,
Set<Dn> chopAfter,
Set<Dn> chopBefore)
Creates a subtree without a refinement filter where all other aspects can
be varied.
|
BaseSubtreeSpecification(Dn base,
int minBaseDistance,
int maxBaseDistance,
Set<Dn> chopAfter,
Set<Dn> chopBefore,
ExprNode refinement)
Creates a subtree which may be a refinement filter where all aspects of
the specification can be set.
|
BaseSubtreeSpecification(ExprNode refinement)
Creates a simple subtree refinement whose administrative point is
necessarily the base and only those subordinates selected by the
refinement filter are included.
|
Modifier and Type | Method and Description |
---|---|
Dn |
getBase()
Gets an Rdn relative to the administrative context where the subtree
scope begins.
|
Set<Dn> |
getChopAfterExclusions()
A set of RDNs relative to the base entry representing chopAfter
specificExclusions from the subtree.
|
Set<Dn> |
getChopBeforeExclusions()
A set of RDNs relative to the base entry representing chopBefore
specificExclusions from the subtree.
|
int |
getMaxBaseDistance()
Gets the distance after which to start excluding entries in the subtree
or subtree refinement.
|
int |
getMinBaseDistance()
Gets the distance at which to start including entries in the subtree.
|
ExprNode |
getRefinement()
A subtree refinement represents a non-contiguous selection of entries
using a limited filter expression where attribute assertions are based on
the objectClass of the entries.
|
String |
toString() |
void |
toString(StringBuilder buffer)
Converts this item into its string representation as stored
in directory.
|
public BaseSubtreeSpecification()
public BaseSubtreeSpecification(ExprNode refinement)
refinement
- the filter expression only composed of objectClass attribute
value assertionspublic BaseSubtreeSpecification(Dn base)
base
- the base of the subtree relative to the administrative pointpublic BaseSubtreeSpecification(Dn base, int minBaseDistance, int maxBaseDistance, Set<Dn> chopAfter, Set<Dn> chopBefore)
base
- the base of the subtree relative to the administrative pointminBaseDistance
- the minimum distance below base to start including entriesmaxBaseDistance
- the maximum distance from base past which entries are excludedchopAfter
- the set of subordinates entries whose subordinates are to be
excludedchopBefore
- the set of subordinates entries and their subordinates to
excludepublic BaseSubtreeSpecification(Dn base, int minBaseDistance, int maxBaseDistance, Set<Dn> chopAfter, Set<Dn> chopBefore, ExprNode refinement)
BaseSubtreeSpecification(org.apache.directory.api.ldap.model.name.Dn, int, int, Set, Set)
.base
- the base of the subtree relative to the administrative pointminBaseDistance
- the minimum distance below base to start including entriesmaxBaseDistance
- the maximum distance from base past which entries are excludedchopAfter
- the set of subordinates entries whose subordinates are to be
excludedchopBefore
- the set of subordinates entries and their subordinates to
excluderefinement
- the filter expression only composed of objectClass attribute
value assertionspublic Dn getBase()
SubtreeSpecification
getBase
in interface SubtreeSpecification
public Set<Dn> getChopBeforeExclusions()
SubtreeSpecification
getChopBeforeExclusions
in interface SubtreeSpecification
public Set<Dn> getChopAfterExclusions()
SubtreeSpecification
getChopAfterExclusions
in interface SubtreeSpecification
public int getMinBaseDistance()
SubtreeSpecification
getMinBaseDistance
in interface SubtreeSpecification
public int getMaxBaseDistance()
SubtreeSpecification
getMaxBaseDistance
in interface SubtreeSpecification
SubtreeSpecification.UNBOUNDED_MAX
public ExprNode getRefinement()
SubtreeSpecification
getRefinement
in interface SubtreeSpecification
public void toString(StringBuilder buffer)
toString
in interface SubtreeSpecification
buffer
- the string bufferpublic String toString()
toString
in class Object
Object.toString()
Copyright © 2003–2020 The Apache Software Foundation. All rights reserved.