BaseSubtreeSpecification (Apache Directory Protocol Ldap Shared 0.9.15 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

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

java.lang.Object
  org.apache.directory.shared.ldap.subtree.BaseSubtreeSpecification

All Implemented Interfaces:: SubtreeSpecification

public class BaseSubtreeSpecification
extends java.lang.Object
implements SubtreeSpecification
extends java.lang.Object
implements SubtreeSpecification

A simple implementation of the SubtreeSpecification interface.

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

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(LdapDN 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(LdapDN base, int minBaseDistance, int maxBaseDistance, java.util.Set<LdapDN> chopAfter, java.util.Set<LdapDN> chopBefore)` Creates a subtree without a refinement filter where all other aspects can be varied.
`BaseSubtreeSpecification(LdapDN base, int minBaseDistance, int maxBaseDistance, java.util.Set<LdapDN> chopAfter, java.util.Set<LdapDN> chopBefore, ExprNode refinement)` Creates a subtree which may be a refinement filter where all aspects of the specification can be set.

Method Summary
`LdapDN`	`getBase()` Gets an RDN relative to the administrative context where the subtree scope begins.
`java.util.Set<LdapDN>`	`getChopAfterExclusions()` A set of RDNs relative to the base entry representing chopAfter specificExclusions from the subtree.
`java.util.Set<LdapDN>`	`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.
`void`	`printToBuffer(java.lang.StringBuilder buffer)` Converts this item into its string representation as stored in directory.

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

BaseSubtreeSpecification

public 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

public 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.

Parameters:: refinement - the filter expression only composed of objectClass attribute value assertions

BaseSubtreeSpecification

public BaseSubtreeSpecification(LdapDN 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.

Parameters:: base - the base of the subtree relative to the administrative point

BaseSubtreeSpecification

public BaseSubtreeSpecification(LdapDN base,
                                int minBaseDistance,
                                int maxBaseDistance,
                                java.util.Set<LdapDN> chopAfter,
                                java.util.Set<LdapDN> chopBefore)

Creates a subtree without a refinement filter where all other aspects can be varied.

Parameters:: base - the base of the subtree relative to the administrative point; minBaseDistance - the minimum distance below base to start including entries; maxBaseDistance - the maximum distance from base past which entries are excluded; chopAfter - the set of subordinates entries whose subordinates are to be excluded; chopBefore - the set of subordinates entries and their subordinates to exclude

BaseSubtreeSpecification

public BaseSubtreeSpecification(LdapDN base,
                                int minBaseDistance,
                                int maxBaseDistance,
                                java.util.Set<LdapDN> chopAfter,
                                java.util.Set<LdapDN> chopBefore,
                                ExprNode refinement)

Creates a subtree which may be a refinement filter where all aspects of the specification can be set. If the refinement filter is null this defaults to BaseSubtreeSpecification(LdapDN, int, int, Set, Set).

Parameters:: base - the base of the subtree relative to the administrative point; minBaseDistance - the minimum distance below base to start including entries; maxBaseDistance - the maximum distance from base past which entries are excluded; chopAfter - the set of subordinates entries whose subordinates are to be excluded; chopBefore - the set of subordinates entries and their subordinates to exclude; refinement - the filter expression only composed of objectClass attribute value assertions

Method Detail