oracle.dss.thin.beans.dataView
Class ExportEvent

java.lang.Object
  |
  +--java.util.EventObject
        |
        +--oracle.dss.thin.beans.dataView.ExportEvent

All Implemented Interfaces:

java.io.Serializable

public class ExportEvent

extends java.util.EventObject

Describes an Export operation. A thin presentation bean sends an ExportEvent to ThinViewListener implementations that have been registered with the presentation.

See Also:

ThinViewListener, Serialized Form

Constructor Summary

ExportEvent(java.lang.Object source, java.lang.String format, java.lang.String range, java.util.Vector hPos, QueryParameterProvider provider)
Constructor.

Method Summary

void	consume() Consumes this event.
java.lang.String	getExportFormat() Retrieves the export format.
java.util.Vector	getExportHPos() Retrieves the hPos vector that identifies the pages to export.
java.lang.String	getExportRange() Retrieves the range of pages to export.
QueryParameterProvider	getQueryParameterProvider() Retrieves the QueryParameterProvider for this event.
boolean	isConsumed() Indicates whether this event has been consumed.
boolean	isResponseDone() Indicates whether the exporting method has written to the response stream.
void	responseDone() Specifies that the application should not write to the response.
java.lang.String	toString() Generates a String representation of this event.

Methods inherited from class java.util.EventObject

getSource

Methods inherited from class java.lang.Object

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

Constructor Detail

ExportEvent

public ExportEvent(java.lang.Object source,
                   java.lang.String format,
                   java.lang.String range,
                   java.util.Vector hPos,
QueryParameterProvider provider)

Constructor.

Parameters:

source - The view that generates this ExportEvent.

format - The format to use in exporting.

range - The range of pages to export.

hpos - Identifier of the data to export.

provider - The QueryParameterProvider for the current request.

Method Detail

getExportFormat

public java.lang.String getExportFormat()

Retrieves the export format. This value comes from the EXPORT_FORMAT+ORIGIN parameter of the EXPORT_EVENT.

Returns:

A constant that represents the format for the exported data. Valid constants are listed in the See Also section.

See Also:

ExportOptions.EXPORT_FORMAT_CSV, ExportOptions.EXPORT_FORMAT_TAB_DELIMITED, BIConstants.EXPORT_EVENT

getExportRange

public java.lang.String getExportRange()

Retrieves the range of pages to export. This value comes from the PAGE_RANGE+ORIGIN parameter of the EXPORT_EVENT.

Returns:

A constant that identifies 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, BIConstants.EXPORT_EVENT

getExportHPos

public java.util.Vector getExportHPos()

Retrieves the hPos vector that identifies the pages to export. This data is specified only when the ExportRange is ThinBeanDialog.SELECTED_PAGES.

Returns:

Hierarchical position of each page to export.

See Also:

DataAccess

getQueryParameterProvider

public QueryParameterProvider getQueryParameterProvider()

Retrieves the QueryParameterProvider for this event.

Returns:

The QueryParameterProvider for the current request.

toString

public java.lang.String toString()

Generates a String representation of this event. This method places the source, export format, page range, and HPos information in the returned String.

Overrides:

toString in class java.util.EventObject

Returns:

A String representation of this event.

consume

public void consume()

Consumes this event. After you call this method, no further action is taken by the event source.

isConsumed

public boolean isConsumed()

Indicates whether this event has been consumed. After an event is consumed, no further action should be taken by the event source.

Returns:

boolean true if this event has been consumed, false if it has not.

responseDone

public void responseDone()

Specifies that the application should not write to the response. This method specifies that the exporting method has already exported the data and written to the response stream. After you call this method, the event handler returns ThinBeanUI.EVENT_RESPONSE_DONE.

See Also:

ThinBeanUI.EVENT_RESPONSE_DONE

isResponseDone

public boolean isResponseDone()

Indicates whether the exporting method has written to the response stream. When this method returns true, the event handler assumes that the view has been exported. It then returns ThinBeanUI.EVENT_RESPONSE_DONE.

Returns:

boolean true if this response is done, false if it has not.

See Also:

ThinBeanUI.EVENT_RESPONSE_DONE