|
Oracle™ Business Intelligence Beans Java API Reference | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--oracle.dss.thin.beans.BaseThinBeanUI | +--oracle.dss.thin.beans.persistence.Explorer
The base Explorer thin bean. Explorer thin beans are used to display, browse and search through the contents of the BI Beans Catalog. This class defines methods and fields that are common to all the Explorer thin beans.
Application developers normally work with the concrete subclasses of this class. However, application developers will call some of these methods in the concrete subclasses.
The application developer can add an ExplorerListener to the Explorer subclass. When the Explorer bean handles an event, the ExplorerEvent will be fired to all the registered ExplorerListener objects. For more details, see ExplorerListener
, ExplorerEvent
.
The Explorer beans support state for their currently selected path, and the currently displayed object type.
The Explorer
generates the following events:
BIConstants.GOTO_ROW_EVENT
-- generated by row navigation in ExplorerDetail/ExplorerSearchBIConstants.SELECT_OBJECT_EVENT
-- generated when a BI Beans Catalog item was selected in any of the Explorer beansBIConstants.SELECT_FOLDER_EVENT
-- generated when a BI Beans Catalog folder was selected in any of the Explorer beansBIConstants.FILTER_EVENT
-- generated by filtering the object types displayed by the Explorer beansBIConstants.SEARCH_EVENT
-- generated from the ExplorerTree search area, and from the ExplorerSearchThe Explorer
handles the following events:
BIConstants.GOTO_ROW_EVENT
-- generated by row navigation in ExplorerDetail/ExplorerSearchBIConstants.SELECT_OBJECT_EVENT
-- generated when a BI Beans Catalog item was selected in any of the Explorer beansBIConstants.SELECT_FOLDER_EVENT
-- generated when a BI Beans Catalog folder was selected in any of the Explorer beansBIConstants.FILTER_EVENT
-- generated by filtering the object types displayed by the Explorer beansBIConstants.SEARCH_EVENT
-- generated from the ExplorerTree search area, and from the ExplorerSearchFor more information about using the Explorer Beans, see the BI Beans Help system.
ExplorerTree
, ExplorerDetail
, ExplorerSearch
, ExplorerListener
, ExplorerEvent
Fields inherited from interface oracle.dss.thin.beans.ThinBeanUI |
EVENT_HANDLED, EVENT_NOT_HANDLED, EVENT_RESPONSE_DONE |
Constructor Summary | |
Explorer() Constructor. |
Method Summary | |
void |
addExplorerListener(ExplorerListener l) Registers a listener for the ExplorerEvent s, which are fired when the current directory is changed or a new item is selected. |
void |
checkpointState() Tells the ThinBean to start tracking state changes. |
BIContext |
getBIContext() Retrieves the BIContext for the Explorer . |
java.lang.String |
getCheckpointState() Used to retrieve the state differences from the last time that state was checkpointed. |
java.lang.String |
getLastSelectedPath() Retrieves the last selected path. |
java.lang.String |
getObjectType() Retrieves the type of objects are displayed in the Explorer Valid types are all types registered with the BIBeans Repository If null, all types of objects are displayed |
java.lang.String[] |
getObjectTypeNames() Retrieves the names of types displayed in the object type filter |
java.lang.String[] |
getObjectTypes() Retrieves what types of objects are displayed in the object type filter Valid types are all types registered with the BIBeans Repository |
java.lang.String |
getRootName() Retrieves the root directory name for the Explorer . |
int |
getRowBlockSize() Retrieves the block size for the Explorer . |
SaveAs |
getSaveAs() Retrieves the SaveAs dialog used with the ExplorerTree or the ExplorerDetail . |
BISearchControls |
getSearchControls() Retrieves the SearchControls used for searching the current directory |
javax.naming.directory.Attributes |
getSearchFilters() Returns the search filter used when seraching the contents of the current directory |
int |
getSearchFoldersLimit() Retrieves the number of folders in the current folder which will be searched to determine whether they contain sub folders. |
java.lang.String |
getSelectedObjectType() Retrieves the type of the currently selected object in the Explorer |
java.lang.String |
getSelectedPath() Retrieves the selected path |
int |
getStartRow() Retrieves the start row for the Explorer . |
java.lang.String |
getState() Returns a String that represents the changes in the Explorer , since the Explorer was created or since setBaseState() was called. |
int |
handleEvent(QueryParameterProvider provider) An application's servlet must call handleEvent, when a ThinBean event triggered the servlet request. |
boolean |
isFoldersVisible() Indicates whether the Explorer displays folders |
boolean |
isObjectFilterVisible() Indicates whether the Explorer displays object filter control |
boolean |
isSearchVisible() Indicates whether the Explorer displays a search fields |
void |
refreshModel() Refreshes the model to be renderered by the Tree or TableBean UIX Components |
void |
removeExplorerListener(ExplorerListener l) Unregisters a listener for the ExplorerEvent s, which are fired when the current directory is changed or a new item is selected. |
void |
setBaseState() Establishes a base state for the Explorer from which state changes that go onto the state string are tracked. |
void |
setBIContext(BIContext biContext) Specifies the BIContext for the Explorer . |
void |
setCheckpointState(java.lang.String state) Used to set state differences from the last time that state was checkpointed. |
void |
setFoldersVisible(boolean visible) Specifies whether the Explorer should display folders. |
void |
setObjectFilterVisible(boolean visible) Specifies whether the Explorer displays object filter control |
void |
setObjectType(java.lang.String objectType) Specifies what type of objects are displayed in the Explorer Valid types are all types registered with the BIBeans Repository If set to null, all types of objects are displayed |
void |
setObjectTypeNames(java.lang.String[] objectTypeNames) Specifies the names of types displayed in the object type filter |
void |
setObjectTypes(java.lang.String[] objectTypes) Specifies what types of objects are displayed in the object type filter Valid types are all types registered with the BIBeans Repository |
void |
setRootName(java.lang.String rootName) Specifies the root directory name for the Explorer . |
void |
setRowBlockSize(int blockSize) Specifies the block size for the Explorer . |
void |
setSaveAs(SaveAs saveAs) Sets the SaveAs dialog on the Explorer In the ExplorerTree , the SaveAs dialog gets updated with the information about the currently selected object in the tree. |
void |
setSearchControls(BISearchControls controls) Sets the SearchControls used used for searching the current directory |
void |
setSearchFilters(javax.naming.directory.Attributes matchingAttrs) Sets the search filter to be filter the results of searching the current directory |
void |
setSearchFoldersLimit(int limit) Sets the number of folders in the current folder which will be searched to determine whether they contain sub folders. |
void |
setSearchVisible(boolean visible) Specifies whether the Explorer should display the search fields. |
void |
setSelectedPath(java.lang.String path) Specifies the selected path. |
void |
setStartRow(int row) Specifies the start row for the Explorer . |
void |
setState(java.lang.String state) Sets a state string that represents the changes on the Explorer , since the Explorer was created or since setBaseState() was called. |
Methods inherited from class oracle.dss.thin.beans.BaseThinBeanUI |
addErrorHandler, generateOnClickSubmit, getEventTarget, getLocale, getThinBeanName, removeErrorHandler, setEventTarget, setLocale, setThinBeanName |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public Explorer()
Method Detail |
public void setBaseState()
Explorer
from which state changes that go onto the state string are tracked. This call will effectively clear the thin bean's current state string. Explorer
beans track changes to the selected path, and displayed object typesetBaseState
in class BaseThinBeanUI
public void setState(java.lang.String state)
Explorer
, since the Explorer
was created or since setBaseState() was called. This string placed onto the URLs/Forms that an application generates, so that the application can re-establish the thin bean's state from a request's URL. This placing of an application's state onto the URL supports the ability for the application to support re-establishing application state from a bookmark.setState
in class BaseThinBeanUI
a
- Explorer
statepublic java.lang.String getState()
Explorer
, since the Explorer
was created or since setBaseState() was called. This string placed onto the URLs/Forms that an application generates, so that the application can re-establish the thin bean's state from a request's URL. This placing of an application's state onto the URL supports the ability for the application to support re-establishing application state from a bookmark.getState
in class BaseThinBeanUI
Explorer
's statepublic java.lang.String getCheckpointState()
getCheckpointState
in class BaseThinBeanUI
public void setCheckpointState(java.lang.String state) throws ThinException
setCheckpointState
in class BaseThinBeanUI
state
- the state differences from the last checkpointThinException
- if the state could not be setpublic void checkpointState()
checkpointState
in class BaseThinBeanUI
oracle.dss.thin.beans.CheckpointState
ThinBean.getState()
, BIStateManager
public int handleEvent(QueryParameterProvider provider) throws ThinException
ThinBean
event triggered the servlet request. To determine the correct ThinBean
to call handleEvent() on, the application should check the "source" query parameter, which will be the ThinBeanName of the ThinBean
that rendered the URL/Form in HTML and which also needs to handle the event. The application can also choose to call handleEvent on all of its ThinBeanUI components and check the return value of handleEvent() to determine which component has handled the event. Each ThinBeanUI component needs to check the source parameter to make sure that it matches their ThinBeanName. If it does not match, then the event should not be processed.provider
- An instance of a QueryParameterProvider that returns decoded and unescaped query parameter values from HTTPServletRequestsThinBeanUI.EVENT_NOT_HANDLED
, ThinBeanUI.EVENT_HANDLED
, ThinBeanUI.EVENT_RESPONSE_DONE
public BIContext getBIContext()
Explorer
.oracle.dss.bicontext.BIContext
interfacepublic void setBIContext(BIContext biContext)
Explorer
.biContext
- an implementation of the oracle.dss.bicontext.BIContext
interfacepublic java.lang.String getRootName()
Explorer
.public void setRootName(java.lang.String rootName)
Explorer
.root
- directory String namepublic int getStartRow()
Explorer
.public void setStartRow(int row)
Explorer
.the
- index of the row from which the current folder contents are going to be displayedpublic int getRowBlockSize()
Explorer
.public void setRowBlockSize(int blockSize)
Explorer
.the
- number of rows to be displayed when browsing the repositorypublic boolean isObjectFilterVisible()
Explorer
displays object filter controlpublic void setObjectFilterVisible(boolean visible)
Explorer
displays object filter controltrue
- if the object filter should be displayedpublic boolean isSearchVisible()
Explorer
displays a search fieldspublic void setSearchVisible(boolean visible)
Explorer
should display the search fields.true
- if the search fields should be displayedpublic int getSearchFoldersLimit()
public void setSearchFoldersLimit(int limit)
the
- maximum number of folders which will be searched to determine whether they have sub folderspublic void refreshModel() throws javax.naming.NamingException
javax.naming.NamingException
- if the model could not be refreshedpublic java.lang.String getSelectedObjectType()
Explorer
public java.lang.String getSelectedPath()
public void setSelectedPath(java.lang.String path) throws javax.naming.NamingException
path
- javax.naming.NamingException
- if the path could not be selectedpublic javax.naming.directory.Attributes getSearchFilters()
public void setSearchFilters(javax.naming.directory.Attributes matchingAttrs)
the
- search filter used to populate the modelpublic BISearchControls getSearchControls()
SearchControls
used for searching the current directorySearchControls
used for searching the current directorypublic void setSearchControls(BISearchControls controls)
SearchControls
used used for searching the current directorythe
- SearchControls
used for searching the current directorypublic void setObjectType(java.lang.String objectType) throws javax.naming.NamingException
Explorer
Valid types are all types registered with the BIBeans Repository If set to null, all types of objects are displayedthe
- name of the type, as registered with the BIBeans Repositorypublic java.lang.String getLastSelectedPath()
public java.lang.String getObjectType()
Explorer
Valid types are all types registered with the BIBeans Repository If null, all types of objects are displayedpublic void setObjectTypes(java.lang.String[] objectTypes)
the
- String array of type names, as registered with the BIBeans Repositorypublic java.lang.String[] getObjectTypes()
public void setObjectTypeNames(java.lang.String[] objectTypeNames)
the
- String array of type names to be displayed in the UIpublic java.lang.String[] getObjectTypeNames()
public boolean isFoldersVisible()
Explorer
displays folderspublic void setFoldersVisible(boolean visible)
Explorer
should display folders.true
- if the folders should be displayedpublic void addExplorerListener(ExplorerListener l)
ExplorerEvent
s, which are fired when the current directory is changed or a new item is selected.l
- The listener to add.ExplorerEvent
public void removeExplorerListener(ExplorerListener l)
ExplorerEvent
s, which are fired when the current directory is changed or a new item is selected.l
- The listener to remove.ExplorerEvent
public void setSaveAs(SaveAs saveAs)
ExplorerTree
, the SaveAs
dialog gets updated with the information about the currently selected object in the tree. In the ExplorerDetail
, the SaveAs
dialog gets updated with the information about the currently selected folder.saveAs
- the SaveAs thin beanpublic SaveAs getSaveAs()
ExplorerTree
or the ExplorerDetail
. In the ExplorerTree
, the SaveAs
dialog gets updated with the information about the currently selected object in the tree. In the ExplorerDetail
, the SaveAs
dialog gets updated with the information about the currently selected folder.
|
Oracle™ Business Intelligence Beans Java API Reference | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |