Oracle™ Business Intelligence Beans Java API Reference
Release 10
g (9.0.4)
Part number B12159_01


oracle.dss.persistence.gui
Class BasicPersistenceObjectFilter

java.lang.Object
  |
  +--oracle.dss.persistence.gui.BasicPersistenceObjectFilter
All Implemented Interfaces:
PersistenceObjectFilter

public class BasicPersistenceObjectFilter
extends java.lang.Object
implements PersistenceObjectFilter

Filter for choosing the type of object to display.

See Also:
PersistenceObjectChooser.addPersistenceObjectFilter(oracle.dss.persistence.gui.PersistenceObjectFilter)

Constructor Summary
BasicPersistenceObjectFilter(java.lang.String objType, java.lang.String displayName)
          Constructor.

 

Method Summary
 javax.swing.Icon getDisplayIcon()
          Retrieves any icon that has been specified for this filter.
 java.lang.String getDisplayText()
          Retrieves the text that is displayed in this filter.
 javax.naming.directory.Attributes getMatchingAttributes()
          The attributes that identify the objects to choose from.
 javax.naming.directory.SearchControls getSearchControls()
          The search control that provides user with a fine grain control of what results should be filtered.

 

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

 

Constructor Detail

BasicPersistenceObjectFilter

public BasicPersistenceObjectFilter(java.lang.String objType,
                                    java.lang.String displayName)
Constructor.
Parameters:
objType - The type of object that you want to display. Valid types of objects are defined in the PersistableConstants interface. For example, one valid constant is PersistableConstants.GRAPH.
displayName - The text to display in the UI for objType, For example, "Graph".
See Also:
PersistableConstants
Method Detail

getDisplayText

public java.lang.String getDisplayText()
Retrieves the text that is displayed in this filter.
Specified by:
getDisplayText in interface PersistenceObjectFilter
Returns:
The text that this filter displays.

getDisplayIcon

public javax.swing.Icon getDisplayIcon()
Retrieves any icon that has been specified for this filter. If no icon has been set, then this method returns null.
Specified by:
getDisplayIcon in interface PersistenceObjectFilter
Returns:
The icon that has been specified for this filter, or null.

getMatchingAttributes

public javax.naming.directory.Attributes getMatchingAttributes()
The attributes that identify the objects to choose from.
Specified by:
getMatchingAttributes in interface PersistenceObjectFilter
Returns:
The attributes that identify the objects to choose from.
See Also:
PSRConstants.Attributes, PersistableConstants.Attributes

getSearchControls

public javax.naming.directory.SearchControls getSearchControls()
The search control that provides user with a fine grain control of what results should be filtered.

This is an optional method.

Note that the search control is used in conjunction with the matching attributes. The objects identified by the matching attributes are further filtered by the search control.

Specified by:
getSearchControls in interface PersistenceObjectFilter
Returns:
The search control that identifies the objects to choose from.
See Also:
SearchControls, BISearchControls

Oracle™ Business Intelligence Beans Java API Reference
Release 10
g (9.0.4)
Part number B12159_01


Copyright © 2003, Oracle. All Rights Reserved.