com.novell.application.console.snapin

Class ResultModifier

java.lang.Object

com.novell.application.console.snapin.ResultModifier

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

AdvancedResultModifier, FilterResultModifier, NDSResultModifier

public class ResultModifier
extends java.lang.Object
implements java.io.Serializable

Defines a ResultModifier, which represents a namespace-specific description of how list and search operations are sorted and filtered.

All extensions of ResultModifier must be serializable. Extending classes must consider the implications of adding large data members. Make all data members transient, unless persistence is required.

See Also:

NamespaceSnapin.getChildren(ObjectEntry parent, ResultModifier modifier), NamespaceSnapin.getChildContainers(ObjectEntry parent, ResultModifier modifier), Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	ALLOWFILESYSTEMBROWSE_NCPSERVER
static int	ALLOWFILESYSTEMBROWSE_NONE
static int	ALLOWFILESYSTEMBROWSE_VOLUME
static int	BLOCK_KEY_NORMAL
static int	BLOCK_KEY_SHOW_BLOCKED_OBJECTS
static int	SORTBY_KEY_NAME
static int	SORTBY_KEY_TYPE
static int	SORTBY_KEY_TYPE_NAME
static int	SORTBY_KEY_UNSORTED
static int	SORTORDER_KEY_ASCENDING
static int	SORTORDER_KEY_DECENDING

Constructor Summary

Constructors

Constructor and Description
ResultModifier(int blockKey)
ResultModifier(java.lang.String descriptiveName) Contructs an ResultModifier with the specified descriptive name.
ResultModifier(java.lang.String descriptiveName, int sortByKey, int sortOrderKey, ResultModifierFilterEntry filterEntry) Deprecated. As of ConsoleOne version 1.3, use constructor with new subcontainer search field.
ResultModifier(java.lang.String descriptiveName, int sortByKey, int sortOrderKey, ResultModifierFilterEntry filterEntry, boolean subContainerSearch) Contructs a ResultModifier with the specified descriptive name, sort information, and filters.
ResultModifier(java.lang.String descriptiveName, int sortByKey, int sortOrderKey, ResultModifierFilterEntry filterEntry, boolean subContainerSearch, boolean subClasses) Contructs a ResultModifier with the specified descriptive name, sort information, and filters.

Method Summary

Modifier and Type	Method and Description
void	addFilter(ResultModifierFilterEntry filterEntry) Adds a filter to the ResultModifier.
void	clearFilters() Removes all filters from the ResultModifier.
boolean	equals(java.lang.Object obj) Tests for equivalency of two ResultModifiers.
int	getAllowFileSystemBrowse()
int	getBlockKey()
protected java.lang.String	getComplexFilterString(AdminNamespace namespace) Helper method to build an LDAP search filter string from the complex filter.
java.lang.String	getDescriptiveName() Obtains the descriptive name of the ResultModifier.
boolean	getFiltered() Determines if the ResultModifier can filter.
ResultModifierFilterEntry[]	getFilters() Obtains the array of filters currently in the ResultModifier.
java.lang.String	getFilterString() Deprecated. Use getFilterString(AdminNamespace namespace)
java.lang.String	getFilterString(AdminNamespace namespace) Helper method to build an LDAP search filter string.
boolean	getIncludeAuxClasses()
boolean	getIncludeSubClasses()
protected java.lang.String	getNameFilterString(java.lang.String nameValue, boolean eDir) Converts the name field of a ResultModifierFilterEntry into an LDAP search filter string. To search on the name of an object, we use "(Name=___)" for eDirectory, or "(distinguishedValue=___)" for NVDS.
boolean	getShowGlue()
boolean	getSimpleAndOpAdvanced()
protected java.lang.String	getSimpleFilterString(AdminNamespace namespace) Helper method to build an LDAP search filter string from the simple name and types filter.
int	getSortByKey() Obtains the sort-by key of the ResultModifier.
int	getSortOrderKey() Obtains the sort key of the ResultModifier.
protected java.lang.String	getTypeFilterString(java.lang.String[] typeValues, boolean eDir, AdminNamespace namespace)
boolean	isSubContainerSearch() Determine if result modifier applies to subcontainers.
void	setAllowFileSystemBrowse(int inAllowFileSystemBrowse)
void	setIncludeAuxClasses(boolean inShowAuxAndSubClasses)
void	setIncludeSubClasses(boolean inShowInheritedSubClasses)
void	setShowGlue(boolean showGlue)
void	setSimpleAndOpAdvanced(boolean inUseSimpleAndOpAdvanced)
void	setSortByKey(int sortByKey) Sets the sort-by key in the ResultModifier.
void	setSortOrderKey(int sortOrderKey) Sets the sort-order key in the ResultModifier.
void	setSubContainerSearch(boolean subContainerSearch) Setup the result modifier subcontainers search mode.

Methods inherited from class java.lang.Object

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

Field Detail

ALLOWFILESYSTEMBROWSE_NONE

public static final int ALLOWFILESYSTEMBROWSE_NONE

See Also:

Constant Field Values

ALLOWFILESYSTEMBROWSE_VOLUME

public static final int ALLOWFILESYSTEMBROWSE_VOLUME

See Also:

Constant Field Values

ALLOWFILESYSTEMBROWSE_NCPSERVER

public static final int ALLOWFILESYSTEMBROWSE_NCPSERVER

See Also:

Constant Field Values

SORTBY_KEY_UNSORTED

public static final int SORTBY_KEY_UNSORTED

See Also:

Constant Field Values

SORTBY_KEY_TYPE

public static final int SORTBY_KEY_TYPE

See Also:

Constant Field Values

SORTBY_KEY_NAME

public static final int SORTBY_KEY_NAME

See Also:

Constant Field Values

SORTBY_KEY_TYPE_NAME

public static final int SORTBY_KEY_TYPE_NAME

See Also:

Constant Field Values

SORTORDER_KEY_ASCENDING

public static final int SORTORDER_KEY_ASCENDING

See Also:

Constant Field Values

SORTORDER_KEY_DECENDING

public static final int SORTORDER_KEY_DECENDING

See Also:

Constant Field Values

BLOCK_KEY_NORMAL

public static final int BLOCK_KEY_NORMAL

See Also:

Constant Field Values

BLOCK_KEY_SHOW_BLOCKED_OBJECTS

public static final int BLOCK_KEY_SHOW_BLOCKED_OBJECTS

See Also:

Constant Field Values

Constructor Detail

ResultModifier

public ResultModifier(java.lang.String descriptiveName)

Contructs an ResultModifier with the specified descriptive name.

The default state of the ResultModifier will be: SORTBY_KEY_TYPE_NAME SORTORDER_KEY_ASCENDING no type filter no name filter no subcontainer search

Parameters:

descriptiveName - The descriptive name of the ResultModifier.

ResultModifier

public ResultModifier(java.lang.String descriptiveName,
                      int sortByKey,
                      int sortOrderKey,
                      ResultModifierFilterEntry filterEntry)

Deprecated. As of ConsoleOne version 1.3, use constructor with new subcontainer search field.

Contructs a ResultModifier with the specified descriptive name, sort information, filters and no subcontainer search.

Parameters:

descriptiveName - The descriptive name of the ResultModifier.

sortByKey - The sort-by key (ResultModifier.SORTBY_KEY_*).

sortOrderKey - The sort-order key (ResultModifier.SORTORDER_KEY_*).

filterEntry - A filter entry. Can be null if none is desired.

ResultModifier

public ResultModifier(java.lang.String descriptiveName,
                      int sortByKey,
                      int sortOrderKey,
                      ResultModifierFilterEntry filterEntry,
                      boolean subContainerSearch)

Contructs a ResultModifier with the specified descriptive name, sort information, and filters.

Parameters:

descriptiveName - The descriptive name of the ResultModifier.

sortByKey - The sort-by key (ResultModifier.SORTBY_KEY_*).

sortOrderKey - The sort-order key (ResultModifier.SORTORDER_KEY_*).

filterEntry - A filter entry. Can be null if none is desired.

subContainerSearch - A boolean indicating whether subcontainers are being searched.

ResultModifier

public ResultModifier(java.lang.String descriptiveName,
                      int sortByKey,
                      int sortOrderKey,
                      ResultModifierFilterEntry filterEntry,
                      boolean subContainerSearch,
                      boolean subClasses)

Contructs a ResultModifier with the specified descriptive name, sort information, and filters.

Parameters:

descriptiveName - The descriptive name of the ResultModifier.

sortByKey - The sort-by key (ResultModifier.SORTBY_KEY_*).

sortOrderKey - The sort-order key (ResultModifier.SORTORDER_KEY_*).

filterEntry - A filter entry. Can be null if none is desired.

subContainerSearch - A boolean indicating whether subcontainers are being searched.

subClasses - A boolean indicating whether subclasses are being searched.

ResultModifier

public ResultModifier(int blockKey)

Method Detail

equals

public boolean equals(java.lang.Object obj)

Tests for equivalency of two ResultModifiers.

Overrides:

equals in class java.lang.Object

Parameters:

obj - The ResultModifier to compare against.

Returns:

True if the two ResultModifiers are equal.

getDescriptiveName

public java.lang.String getDescriptiveName()

Obtains the descriptive name of the ResultModifier.

Returns:

The descriptive name of the ResultModifier.

setSortByKey

public void setSortByKey(int sortByKey)

Sets the sort-by key in the ResultModifier.

Parameters:

sortByKey - The sort-by key: ResultModifier.SORTBY_KEY_*.

getSortByKey

public int getSortByKey()

Obtains the sort-by key of the ResultModifier.

Returns:

The sort-by key name.

setSortOrderKey

public void setSortOrderKey(int sortOrderKey)

Sets the sort-order key in the ResultModifier.

Parameters:

sortOrderKey - The sort-order key: ResultModifier.SORTORDER_KEY_*.

getSortOrderKey

public int getSortOrderKey()

Obtains the sort key of the ResultModifier.

Returns:

The sort key name.

isSubContainerSearch

public boolean isSubContainerSearch()

Determine if result modifier applies to subcontainers.

Returns:

True if subcontainers should be searched.

setSubContainerSearch

public void setSubContainerSearch(boolean subContainerSearch)

Setup the result modifier subcontainers search mode.

Parameters:

subContainerSearch - - True if subcontainers should be searched, false otherwise.

getBlockKey

public int getBlockKey()

addFilter

public void addFilter(ResultModifierFilterEntry filterEntry)

Adds a filter to the ResultModifier.

Parameters:

filterEntry - - The filter to add to the ResultModifier.

clearFilters

public void clearFilters()

Removes all filters from the ResultModifier.

setIncludeSubClasses

public void setIncludeSubClasses(boolean inShowInheritedSubClasses)

getIncludeSubClasses

public boolean getIncludeSubClasses()

setIncludeAuxClasses

public void setIncludeAuxClasses(boolean inShowAuxAndSubClasses)

getIncludeAuxClasses

public boolean getIncludeAuxClasses()

setSimpleAndOpAdvanced

public void setSimpleAndOpAdvanced(boolean inUseSimpleAndOpAdvanced)

getSimpleAndOpAdvanced

public boolean getSimpleAndOpAdvanced()

setShowGlue

public void setShowGlue(boolean showGlue)

getShowGlue

public boolean getShowGlue()

setAllowFileSystemBrowse

public void setAllowFileSystemBrowse(int inAllowFileSystemBrowse)

Parameters:

inAllowFileSystemBrowse - bit flag whether to allow browsing into the filesystem through Volume and/or NCP Server objects ALLOWFILESYSTEMBROWSE_VOLUME - allow browsing through Volume objects ALLOWFILESYSTEMBROWSE_NCPSERVER - allow browsing through NCP Server Objects. these flags may be or'ed together

getAllowFileSystemBrowse

public int getAllowFileSystemBrowse()

getFilters

public ResultModifierFilterEntry[] getFilters()

Obtains the array of filters currently in the ResultModifier.

Returns:

An array of ResultModifierFilterEntries that represent the filters currently applied in the ResultModifier. Can return null.

getFiltered

public boolean getFiltered()

Determines if the ResultModifier can filter.

Returns:

True if the ResultModifier has a name or type filter.

getFilterString

public java.lang.String getFilterString()

Deprecated. Use getFilterString(AdminNamespace namespace)

Helper method to build an LDAP search filter. (RFC2254)

Returns:

The LDAP search filter string.

getFilterString

public java.lang.String getFilterString(AdminNamespace namespace)

Helper method to build an LDAP search filter string. (RFC2254) This string combines both the simple filter and, if present, the complex filter. The simple filter consists of the OR of a series of name and class types.

    The type filters are affected by two flags:
       - showInheritedSubClasses=true
          Select objects of this class or subclasses of this class.
          This filter turns into a series of (structuralObjectClass=__) components
       - showAuxAndSubClasses=true
          Selects objects that have this class as an Auxiliary or subclass.
          This filter turns into an (objectClass=__) component.
       - Both flags = false
          Selects only objects with this class as the base class.
          This filter turns into a single (structuralObjectClass=__) component.

    

Because eDirectory/LDAP cannot perform a search on structuralObjectClass, it always uses objectClass. eDirectory and NVDS also differ in how to search for the typeless name of the object. For this reason, we pass in the namespace object as a parameter. If the object is an instance of FilterResultModifier, it contains a complex filter. This complex filter is a combination of (attr op value) FilterItem objects in a FilterItemGroup object, in a FilterItemGroupPair object, in a Filter object. If the object is an instance of AdvancedResultModifier, the complex filter is just an arbitrary LDAP search filter string, but is ignored in eDirectory/NDAP. The simple and complex filters are combined with an OR, unless the 'useSimpleAndOpAdvanced' flag is set, in which case they are combined with an AND.

Parameters:

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

Returns:

The LDAP search filter string. If no simple or complex filter is present, it returns the string "(objectClass=*)".

getSimpleFilterString

protected java.lang.String getSimpleFilterString(AdminNamespace namespace)

Helper method to build an LDAP search filter string from the simple name and types filter. The simple filter consists of the OR of a series of name and class types, stored internally as ResultModifierFilterEntry objects.

    The type filters are affected by two flags:
       - showInheritedSubClasses=true
          Select objects of this class or subclasses of this class.
          This filter turns into a series of (structuralObjectClass=__) components
       - showAuxAndSubClasses=true
          Selects objects that have this class as an Auxiliary or subclass.
          This filter turns into an (objectClass=__) component.
       - Both flags = false
          Selects only objects with this class as the base class.
          This filter turns into a single (structuralObjectClass=__) component.

    

Because eDirectory/LDAP cannot perform a search on structuralObjectClass, it always uses objectClass. eDirectory and NVDS also differ in how to search for the typeless name of the object. For this reason, we pass in the namespace object as a parameter.

Parameters:

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

Returns:

The LDAP search filter string. If no filter is present, it returns an empty string.

getNameFilterString

protected java.lang.String getNameFilterString(java.lang.String nameValue,
                                               boolean eDir)

Converts the name field of a ResultModifierFilterEntry into an LDAP search filter string. To search on the name of an object, we use "(Name=___)" for eDirectory, or "(distinguishedValue=___)" for NVDS. For NVDS, we also allow the name field to be typed, such as "cn=joe", which turns into the filter "(cn=joe)"

Parameters:

nameValue - The name string to use as a filter.

eDir - true for an eDirectory server

Returns:

An LDAP filter string. ie Returns an empty string if nameValue is null or empty.

getTypeFilterString

protected java.lang.String getTypeFilterString(java.lang.String[] typeValues,
                                               boolean eDir,
                                               AdminNamespace namespace)

getComplexFilterString

protected java.lang.String getComplexFilterString(AdminNamespace namespace)

Helper method to build an LDAP search filter string from the complex filter. This method is overridden by the subclasses of ResultModifier, FilterResultModifier or AdvancedResultModifier. The method in this class returns an empty string since there is no complex filter in a plain ResultModifier. If the object is an instance of FilterResultModifier, it contains a complex filter. This complex filter is a combination of "(attr op value)" FilterItem objects in a FilterItemGroup object, in a FilterItemGroupPair object, in a Filter object. If the object is an instance of AdvancedResultModifier, the complex filter is just an arbitrary LDAP search filter string, but is ignored in eDirectory/NDAP.

Parameters:

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

Returns:

The LDAP search filter string.