|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.directory.shared.ldap.subtree.BaseSubtreeSpecification
A simple implementation of the SubtreeSpecification interface.
Field Summary |
Fields inherited from interface org.apache.directory.shared.ldap.subtree.SubtreeSpecification |
UNBOUNDED_MAX |
Constructor Summary | |
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(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. |
|
BaseSubtreeSpecification(javax.naming.Name 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(javax.naming.Name base,
int minBaseDistance,
int maxBaseDistance,
java.util.Set chopAfter,
java.util.Set chopBefore)
Creates a subtree without a refinement filter where all other aspects can be varied. |
|
BaseSubtreeSpecification(javax.naming.Name base,
int minBaseDistance,
int maxBaseDistance,
java.util.Set chopAfter,
java.util.Set chopBefore,
ExprNode refinement)
Creates a subtree which may be a refinement filter where all aspects of the specification can be set. |
Method Summary | |
javax.naming.Name |
getBase()
Gets an RDN relative to the administrative context where the subtree scope begins. |
java.util.Set |
getChopAfterExclusions()
A set of RDNs relative to the base entry representing chopAfter specificExclusions from the subtree. |
java.util.Set |
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. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public BaseSubtreeSpecification()
public BaseSubtreeSpecification(ExprNode refinement)
refinement
- the filter expression only composed of objectClass attribute
value assertionspublic BaseSubtreeSpecification(javax.naming.Name base)
base
- the base of the subtree relative to the administrative pointpublic BaseSubtreeSpecification(javax.naming.Name base, int minBaseDistance, int maxBaseDistance, java.util.Set chopAfter, java.util.Set 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(javax.naming.Name base, int minBaseDistance, int maxBaseDistance, java.util.Set chopAfter, java.util.Set chopBefore, ExprNode refinement)
BaseSubtreeSpecification(Name, 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 assertionsMethod Detail |
public javax.naming.Name getBase()
SubtreeSpecification
getBase
in interface SubtreeSpecification
public java.util.Set getChopBeforeExclusions()
SubtreeSpecification
getChopBeforeExclusions
in interface SubtreeSpecification
Name
s to the subtree base
or the empty setpublic java.util.Set getChopAfterExclusions()
SubtreeSpecification
getChopAfterExclusions
in interface SubtreeSpecification
Name
s to the subtree base
or the empty setpublic 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
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |