oracle.dss.thin.beans.dataView
Class ExportOptions

java.lang.Object
  |
  +--oracle.dss.thin.beans.BaseThinBeanUI
        |
        +--oracle.dss.thin.beans.ThinBeanDialog
              |
              +--oracle.dss.thin.beans.dataView.ExportOptions

All Implemented Interfaces:

CheckpointState, ErrorHandlerCallback, ThinBean, ThinBeanUI

public class ExportOptions

extends ThinBeanDialog

The ThinBeanUI for the Export Options dialog. The Export Options dialog presents options for exporting a thin presentation bean. This ExportOptions generates a BIConstants.EXPORT_EVENT, which contains the information that the dialog gathers from a user. Set an EventTarget for the event to direct it to the thin presentation bean to export. The thin presentation bean actually performs the export operation.

The ExportOptions generates the following events:

• BIConstants.EXPORT_EVENT -- Pass this event to the generateOnClickSubmit method to get Javascript that generates this event. Set the return value as the ON_CLICK_ATTR of the UIX button or link, to provide OK navigation for this ExportOptions. Set an EventTarget to direct this event to the thin presentation bean whose data is being exported.
• BIConstants.CANCEL_EVENT -- Pass this event to the generateOnClickSubmit method to get Javascript that generates this event. Set the return value as the ON_CLICK_ATTR of the UIX button or link, to provide Cancel navigation for this ExportOptions. Set an EventTarget to direct this event to the application page to navigate to when users choose Cancel.

The ExportOptions handles the following event:

• BIConstants.INIT_EVENT -- This dialog handles this event by sending an InitEvent to any registered listeners. The event is generated by the InitEventDataObject that you set on the button or hyperlink that you create to invoke this ThinDialog.

For more information about using the Export Options dialog, see the "Export Options Dialog" topic in the BI Beans Help system.

See Also:

setView(oracle.dss.thin.beans.dataView.ThinDataviewCommon), BaseThinBeanUI.generateOnClickSubmit(java.lang.String), InitEventDataObject, ThinDataviewCommon

Field Summary

static java.lang.String	EXPORT_FORMAT_CSV Export format: Comma-separated values.
static java.lang.String	EXPORT_FORMAT_TAB_DELIMITED Export format: Tab-delimited.

Fields inherited from class oracle.dss.thin.beans.ThinBeanDialog

ALL_PAGES, CURRENT_PAGE, SELECTED_PAGES

Fields inherited from interface oracle.dss.thin.beans.ThinBeanUI

EVENT_HANDLED, EVENT_NOT_HANDLED, EVENT_RESPONSE_DONE

Constructor Summary

ExportOptions()
Constructor.

Method Summary

java.lang.String	getExportFormat() Retrieves the format for this ExportOptions.
java.lang.String	getExportRange() Retrieves the range of logical pages to export for the ExportOptions.
ThinDataviewCommon	getView() Retrieves the view that will be exported based on options that are set in this ExportOptions.
int	handleEvent(QueryParameterProvider provider) Handles a thin-bean event.
void	setExportFormat(java.lang.String format) Specifies the format for this ExportOptions.
void	setExportRange(java.lang.String exportRange) Specifies the range logical page to export for the ExportOptions.
void	setView(ThinDataviewCommon view) Specifies the view that will be exported, based on the options specified in this ExportOptions.

Methods inherited from class oracle.dss.thin.beans.ThinBeanDialog

addThinBeanDialogListener, removeThinBeanDialogListener

Methods inherited from class oracle.dss.thin.beans.BaseThinBeanUI

addErrorHandler, checkpointState, generateOnClickSubmit, getCheckpointState, getEventTarget, getLocale, getState, getThinBeanName, removeErrorHandler, setBaseState, setCheckpointState, setEventTarget, setLocale, setState, setThinBeanName

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

EXPORT_FORMAT_CSV

public static final java.lang.String EXPORT_FORMAT_CSV

Export format: Comma-separated values.

EXPORT_FORMAT_TAB_DELIMITED

public static final java.lang.String EXPORT_FORMAT_TAB_DELIMITED

Export format: Tab-delimited.

Constructor Detail

ExportOptions

public ExportOptions()

Constructor.

Method Detail

setView

public void setView(ThinDataviewCommon view)

Specifies the view that will be exported, based on the options specified in this ExportOptions. The view actually performs the export operation.

Call this method as you initialize this ExportOptions.

Parameters:

view - The view to export.

getView

public ThinDataviewCommon getView()

Retrieves the view that will be exported based on options that are set in this ExportOptions.

Returns:

The view to export.

handleEvent

public int handleEvent(QueryParameterProvider provider)
                throws ThinException

Description copied from interface: ThinBeanUI

Handles a thin-bean event. This ThinBeanUI handles events where the value of the source query parameter is the ThinBeanName for this thin bean.

You can examine the source query parameter to determine the thin bean whose handleEvent to call. Or you can call the handleEvent for each thin bean, checking the return from this method to discover which thin bean handled the event. Alternately, you can register thin beans with the ServletRequestHandler and call the handleEvent method of the ServletRequestHandler. The ServletRequestHandler will then route the event to the proper thin bean.

For more information about thin-bean events, see the BI Beans Help system.

Overrides:

handleEvent in class ThinBeanDialog

Following copied from interface: oracle.dss.thin.beans.ThinBeanUI

Parameters:

provider - The QueryParameterProvider for the HTTPServletRequest that is being handled.

Returns:

A constant that indicates whether this ThinBeanUI handled any events. Constants are listed in the See Also section.

Throws:

ThinException - If an error occurs that interrupts event handling.

See Also:

ThinBeanUI.EVENT_NOT_HANDLED, ThinBeanUI.EVENT_HANDLED, ThinBeanUI.EVENT_RESPONSE_DONE, ServletRequestHandler

getExportFormat

public java.lang.String getExportFormat()

Retrieves the format for this ExportOptions. The format specifies the format of the exported data.

Returns:

A constant that represents the export format. Valid constants are listed in the See Also section.

See Also:

EXPORT_FORMAT_CSV, EXPORT_FORMAT_TAB_DELIMITED

setExportFormat

public void setExportFormat(java.lang.String format)

Specifies the format for this ExportOptions. The format specifies the format of the exported data. The default format has comma-separated values.

Parameters:

format - A constant that represents the export format. Valid constants are listed in the See Also section.

See Also:

EXPORT_FORMAT_CSV, EXPORT_FORMAT_TAB_DELIMITED

getExportRange

public java.lang.String getExportRange()

Retrieves the range of logical pages to export for the ExportOptions. A logical page is the page of data that is associated with a set of page dimension members.

Returns:

A constant that represents the range of pages to export. Valid constants are listed in the See Also section.

See Also:

ThinBeanDialog.ALL_PAGES, ThinBeanDialog.CURRENT_PAGE, ThinBeanDialog.SELECTED_PAGES

setExportRange

public void setExportRange(java.lang.String exportRange)

Specifies the range logical page to export for the ExportOptions. A logical page is the page of data that is associated with a set of page dimension members. By default, this option is set to the current page.

Parameters:

exportRange - A constant that represents the range of pages to export. Valid constants are listed in the See Also section.

See Also:

ThinBeanDialog.ALL_PAGES, ThinBeanDialog.CURRENT_PAGE, ThinBeanDialog.SELECTED_PAGES