com.novell.admin.ns

Class FilterResultModifier

java.lang.Object

com.novell.application.console.snapin.ResultModifier

com.novell.admin.ns.FilterResultModifier

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

NDSFilterResultModifier

public class FilterResultModifier
extends ResultModifier

Adds additional filters to the ResultModifier class.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FilterResultModifier.Filter Holds a group of ExtendedFilterGroup filters.
static class	FilterResultModifier.FilterItemGroup Holds a group of complex filters.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	AND
static java.lang.String	APPROX
static java.lang.String	EQUAL
static java.lang.String	GREATER_OR_EQUAL
static java.lang.String	LESS_OR_EQUAL
static java.lang.String	NOT_EQUAL
static java.lang.String	NOT_PRESENT
static java.lang.String	OR
static java.lang.String	PRESENT

Fields inherited from class com.novell.application.console.snapin.ResultModifier

ALLOWFILESYSTEMBROWSE_NCPSERVER, ALLOWFILESYSTEMBROWSE_NONE, ALLOWFILESYSTEMBROWSE_VOLUME, BLOCK_KEY_NORMAL, BLOCK_KEY_SHOW_BLOCKED_OBJECTS, SORTBY_KEY_NAME, SORTBY_KEY_TYPE, SORTBY_KEY_TYPE_NAME, SORTBY_KEY_UNSORTED, SORTORDER_KEY_ASCENDING, SORTORDER_KEY_DECENDING

Constructor Summary

Constructors

Constructor and Description
FilterResultModifier(java.lang.String descriptiveName, FilterResultModifier.Filter filter, boolean subContainer) Constructs an extended filter for object search.
FilterResultModifier(java.lang.String descriptiveName, int sortKey, FilterResultModifier.Filter filter, boolean subContainer) Constructs an extended filter for object search.
FilterResultModifier(java.lang.String descriptiveName, int sortKey, FilterResultModifier.Filter filter, boolean subContainer, boolean subClasses) Constructs an extended filter for object search.

Method Summary

Modifier and Type	Method and Description
void	addFilter(FilterResultModifier.Filter filter) Adds a new filter to the result modifier.
boolean	equals(java.lang.Object resMod) Determines whether this ResultModifier is equal to another.
protected java.lang.String	getComplexFilterString(AdminNamespace namespace) Helper method to build an LDAP search filter string from the complex filter.
FilterResultModifier.Filter	getFilter() Retries the group filter.
FilterResultModifier.Filter[]	getFRMFilters() Returns the filters.

Methods inherited from class com.novell.application.console.snapin.ResultModifier

addFilter, clearFilters, getAllowFileSystemBrowse, getBlockKey, getDescriptiveName, getFiltered, getFilters, getFilterString, getFilterString, getIncludeAuxClasses, getIncludeSubClasses, getNameFilterString, getShowGlue, getSimpleAndOpAdvanced, getSimpleFilterString, getSortByKey, getSortOrderKey, getTypeFilterString, isSubContainerSearch, setAllowFileSystemBrowse, setIncludeAuxClasses, setIncludeSubClasses, setShowGlue, setSimpleAndOpAdvanced, setSortByKey, setSortOrderKey, setSubContainerSearch

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

OR

public static final java.lang.String OR

See Also:

Constant Field Values

AND

public static final java.lang.String AND

See Also:

Constant Field Values

EQUAL

public static final java.lang.String EQUAL

See Also:

Constant Field Values

NOT_EQUAL

public static final java.lang.String NOT_EQUAL

See Also:

Constant Field Values

GREATER_OR_EQUAL

public static final java.lang.String GREATER_OR_EQUAL

See Also:

Constant Field Values

LESS_OR_EQUAL

public static final java.lang.String LESS_OR_EQUAL

See Also:

Constant Field Values

APPROX

public static final java.lang.String APPROX

See Also:

Constant Field Values

PRESENT

public static final java.lang.String PRESENT

See Also:

Constant Field Values

NOT_PRESENT

public static final java.lang.String NOT_PRESENT

See Also:

Constant Field Values

Constructor Detail

FilterResultModifier

public FilterResultModifier(java.lang.String descriptiveName,
                            FilterResultModifier.Filter filter,
                            boolean subContainer)

Constructs an extended filter for object search.

Parameters:

descriptiveName - The description of the filter.

subContainer - The search depth.

filter - The grouping of additional filter requirements.

FilterResultModifier

public FilterResultModifier(java.lang.String descriptiveName,
                            int sortKey,
                            FilterResultModifier.Filter filter,
                            boolean subContainer)

Constructs an extended filter for object search.

Parameters:

descriptiveName - The description of the filter.

sortKey - SORTKEY_UNSORTED - No special sorting required. SORTKEY_TYPE - Sort baseclass in accending order. SORTKEY_NAME - Sort name in accending order. SORTKEY_TYPE_NAME - Sort baseclass then by name in accending order.

filter - The grouping of additional filter requirements.

subContainer - The search depth.

FilterResultModifier

public FilterResultModifier(java.lang.String descriptiveName,
                            int sortKey,
                            FilterResultModifier.Filter filter,
                            boolean subContainer,
                            boolean subClasses)

Constructs an extended filter for object search.

Parameters:

descriptiveName - The description of the filter.

sortKey - SORTKEY_UNSORTED - No special sorting required. SORTKEY_TYPE - Sort baseclass in accending order. SORTKEY_NAME - Sort name in accending order. SORTKEY_TYPE_NAME - Sort baseclass then by name in accending order.

filter - The grouping of additional filter requirements.

subContainer - The search depth.

subClasses - Whether subclasses are included.

Method Detail

addFilter

public void addFilter(FilterResultModifier.Filter filter)

Adds a new filter to the result modifier.

Parameters:

filter - the filter to add

getFRMFilters

public FilterResultModifier.Filter[] getFRMFilters()

Returns the filters.

Returns:

The filters.

getFilter

public FilterResultModifier.Filter getFilter()

Retries the group filter.

Returns:

The group filter.

getComplexFilterString

protected java.lang.String getComplexFilterString(AdminNamespace namespace)

Helper method to build an LDAP search filter string from the complex filter. This method is overrides the method in ResultModifier. If the object is an instance of FilterResultModifier, it contains a complex filter. This complex filter is a series of "(attr op value)" FilterItem objects in a series of FilterItemGroupPair objects, in a Filter object.

Overrides:

getComplexFilterString in class ResultModifier

Parameters:

namespace - The namespace object. Used to determine eDirectory vs NVDS. If null, assumes eDirectory.

Returns:

The LDAP search filter string.

equals

public boolean equals(java.lang.Object resMod)

Determines whether this ResultModifier is equal to another.

Overrides:

equals in class ResultModifier

Parameters:

resMod - The ResultModifier to compare against.

Returns:

The group filter.