oracle.dss.export
Class TextExport

java.lang.Object
  |
  +--oracle.dss.export.TextExport

All Implemented Interfaces:

DataDirectorListener, java.util.EventListener

public class TextExport

extends java.lang.Object

implements DataDirectorListener

TextExport class. This object exports the data from the specified data access object according to the specified parameters

Field Summary

static java.lang.String	EXPORT_FORMAT_CSV A constant specifying the export format as CSV.
static java.lang.String	EXPORT_FORMAT_TAB_DELIMITED A constant specifying the export format as tab delimited.
static java.lang.String	EXPORT_PAGEDIM_ALL A constant specifying the export range as all combinations of page dimension members
static java.lang.String	EXPORT_PAGEDIM_CURRENT A constant specifying the export range as currently selected page dimension members
static java.lang.String	EXPORT_PAGEDIM_SELECTED A constant specifying the export range as selected combinations of page dimension members.

Constructor Summary

TextExport(DataAccess dataAccess, DataDirector dataDirector, java.io.PrintWriter output)
Constructs a TextExport object.

TextExport(DataAccess dataAccess, DataDirector dataDirector, java.io.PrintWriter output, java.lang.String exportFormat, java.lang.String exportRange)
Constructs a TextExport object.

Method Summary

void	export() Exports the data contained by the specified DataAccess object for the specified range and export format.
DataAccess	getDataAccess() Retrieves the DataAccess object containing to the data to be exported.
DataDirector	getDataDirector() Retrieves the DataDirector object that allows the data contained in the DataAccess to be manipulated.
java.lang.String	getDataType() Retrieves the data type to be exported.
java.lang.String	getExportFootnote() Retrieves the export footnote.
java.lang.String	getExportFormat() Retrieves the export format.
java.lang.String	getExportRange() Retrieves the export range.
java.lang.String	getExportSubtitle() Retrieves the export subtitle.
java.lang.String	getExportTitle() Retrieves the export title.
java.lang.String	getLayerMetadataLabelType() Retrieves the layer metadata label type.
java.lang.String	getMemberMetadataLabelType() Retrieves the member metadata label type.
java.io.PrintWriter	getOutput() Retrieve the output object into which the data is exported to.
ViewFormat	getViewFormat() Retrieve the view format object that allows the number formatting for the data to be exported
static boolean	isSupportedDataType(java.lang.String dataType) Checks if the specified data type is supported by the TextObject.
static boolean	isSupportedExportFormat(java.lang.String exportFormat) Checks if the specified export format is supported by the TextObject.
static boolean	isSupportedExportRange(java.lang.String exportRange) Checks if the specified export range is supported by the TextObject.
static boolean	isSupportedLayerMetadataLabelType(java.lang.String layerMetadataLabelType) Checks if the specified layer metadata label type is supported by the TextObject.
static boolean	isSupportedMemberMetadataLabelType(java.lang.String memberMetadataLabelType) Checks if the specified member metadata label type is supported by the TextObject.
void	setDataAccess(DataAccess dataAccess) Sets the DataAccess object that acts as the data provider.
void	setDataDirector(DataDirector dataDirector) Sets the DataDirector object that allows the data provider to be manipulated.
void	setExportFootnote(java.lang.String exportFootnote) Sets the export footnote.
void	setExportFormat(java.lang.String exportFormat) Sets the export format.
void	setExportHPos(java.util.Vector listExportHPos) Sets the page dimension member HPos's for which the data needs to be exported
void	setExportQDRs(java.util.Vector listExportQDRs) Sets the page dimension member QDR's for which the data needs to be exported
void	setExportRange(java.lang.String exportRange) Sets the export range.
void	setExportSubtitle(java.lang.String exportSubtitle) Sets the export subtitle.
void	setExportTitle(java.lang.String exportTitle) Sets the export title.
void	setLayerMetadataLabelType(java.lang.String layerMetadataLabelType) Sets the layer metadata label type
void	setMemberMetadataLabelType(java.lang.String memberMetadataLabelType) Sets the member metadata label type
void	setOutput(java.io.PrintWriter output) Sets the output object to which the export data is written
void	setViewFormat(ViewFormat viewFormat) Sets the view format object for number formatting of the export data

Methods inherited from class java.lang.Object

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

Methods inherited from interface oracle.dss.util.DataDirectorListener

viewDataAvailable, viewDataChanged, waitDataAvailable

Field Detail

EXPORT_FORMAT_CSV

public static final java.lang.String EXPORT_FORMAT_CSV

A constant specifying the export format as CSV.

EXPORT_FORMAT_TAB_DELIMITED

public static final java.lang.String EXPORT_FORMAT_TAB_DELIMITED

A constant specifying the export format as tab delimited.

EXPORT_PAGEDIM_ALL

public static final java.lang.String EXPORT_PAGEDIM_ALL

A constant specifying the export range as all combinations of page dimension members

EXPORT_PAGEDIM_CURRENT

public static final java.lang.String EXPORT_PAGEDIM_CURRENT

A constant specifying the export range as currently selected page dimension members

EXPORT_PAGEDIM_SELECTED

public static final java.lang.String EXPORT_PAGEDIM_SELECTED

A constant specifying the export range as selected combinations of page dimension members. A list of QDR objects specifying the page dimension members for each combination is needed as a parameter.

Constructor Detail

TextExport

public TextExport(DataAccess dataAccess,
DataDirector dataDirector,
                  java.io.PrintWriter output)
           throws java.lang.IllegalArgumentException

Constructs a TextExport object. The object exports the data for the current page dimension members in a csv format.

Parameters:

dataAccess - The DataAccess object containing the data to be exported

dataDirector - The DataDirector object used to change the current page for the data access.

output - The PrintWriter object to output the export to.

Throws:

java.lang.IllegalArgumentException - If an illegal argument is specified

TextExport

public TextExport(DataAccess dataAccess,
DataDirector dataDirector,
                  java.io.PrintWriter output,
                  java.lang.String exportFormat,
                  java.lang.String exportRange)
           throws java.lang.IllegalArgumentException

Constructs a TextExport object. The object exports the data in the specified format for the specified range

Parameters:

dataAccess - The DataAccess object containing the data to be exported

dataDirector - The DataDirector object used to change the current page for the data access.

output - The PrintWriter object to output the export to.

exportFormat - The format to export the data to. Valid values are constants EXPORT_FORMAT_CSV and EXPORT_FORMAT_TAB_DELIMITED.

exportRange - The range to export the data for. Valid values are constants EXPORT_PAGEDIM_ALL, EXPORT_PAGEDIM_CURRENT and EXPORT_PAGEDIM_SELECTED

Throws:

java.lang.IllegalArgumentException - If an illegal argument is specified

Method Detail

export

public void export()
            throws java.lang.Exception

Exports the data contained by the specified DataAccess object for the specified range and export format.

Throws:

java.lang.Exception - If the export was unsuccessful.

getDataAccess

public DataAccess getDataAccess()

Retrieves the DataAccess object containing to the data to be exported.

Returns:

DataAccess object containing to the data to be exported.

getDataDirector

public DataDirector getDataDirector()

Retrieves the DataDirector object that allows the data contained in the DataAccess to be manipulated.

Returns:

DataDirector object that allows the data contained in the DataAccess to be manipulated.

getDataType

public java.lang.String getDataType()

Retrieves the data type to be exported. Valid values are constants DataMap.DATA_FORMATTED and DataMap.DATA_UNFORMATTED

Returns:

The data type to be exported

getExportFormat

public java.lang.String getExportFormat()

Retrieves the export format. Valid values are constants EXPORT_FORMAT_CSV and EXPORT_FORMAT_TAB_DELIMITED.

Returns:

The export format

getExportRange

public java.lang.String getExportRange()

Retrieves the export range. Valid values are constants EXPORT_PAGEDIM_ALL, EXPORT_PAGEDIM_CURRENT and EXPORT_PAGEDIM_SELECTED

Returns:

The export range

getLayerMetadataLabelType

public java.lang.String getLayerMetadataLabelType()

Retrieves the layer metadata label type. Valid values are constants LayerMetadataMap.LAYER_METADATA_SHORTLABEL, LayerMetadataMap.LAYER_METADATA_MEDIUMLABEL and LayerMetadataMap.LAYER_METADATA_LONGLABEL

Returns:

The layer metadata label type

getMemberMetadataLabelType

public java.lang.String getMemberMetadataLabelType()

Retrieves the member metadata label type. Valid values are constants MetadataMap.METADATA_SHORTLABEL, MetadataMap.METADATA_MEDIUMLABEL and MetadataMap.METADATA_LONGLABEL

Returns:

The member metadata label type

getOutput

public java.io.PrintWriter getOutput()

Retrieve the output object into which the data is exported to.

Returns:

The output object

getViewFormat

public ViewFormat getViewFormat()

Retrieve the view format object that allows the number formatting for the data to be exported

Returns:

The ViewFormat object

getExportTitle

public java.lang.String getExportTitle()

Retrieves the export title.

Returns:

The export title

getExportSubtitle

public java.lang.String getExportSubtitle()

Retrieves the export subtitle.

Returns:

The export subtitle

getExportFootnote

public java.lang.String getExportFootnote()

Retrieves the export footnote.

Returns:

The export footnote

isSupportedDataType

public static boolean isSupportedDataType(java.lang.String dataType)

Checks if the specified data type is supported by the TextObject. Valid values are constants DataMap.DATA_FORMATTED and DataMap.DATA_UNFORMATTED

Parameters:

dataType - The data type to be checked

Returns:

true if the data type is supported, false otherwise

isSupportedExportFormat

public static boolean isSupportedExportFormat(java.lang.String exportFormat)

Checks if the specified export format is supported by the TextObject. Valid values are constants EXPORT_FORMAT_CSV and EXPORT_FORMAT_TAB_DELIMITED

Parameters:

exportFormat - The export format to be checked

Returns:

true if the export format is supported, false otherwise

isSupportedExportRange

public static boolean isSupportedExportRange(java.lang.String exportRange)

Checks if the specified export range is supported by the TextObject. Valid values are constants EXPORT_PAGEDIM_ALL, EXPORT_PAGEDIM_CURRENT and EXPORT_PAGEDIM_SELECTED

Parameters:

exportRange - The export range to be checked

Returns:

true if the export range is supported, false otherwise

isSupportedLayerMetadataLabelType

public static boolean isSupportedLayerMetadataLabelType(java.lang.String layerMetadataLabelType)

Checks if the specified layer metadata label type is supported by the TextObject. Valid values are constants LayerMetadataMap.LAYER_METADATA_SHORTLABEL, LayerMetadataMap.LAYER_METADATA_MEDIUMLABEL and LayerMetadataMap.LAYER_METADATA_LONGLABEL

Parameters:

layerMetadataLabelType - The metadata label type to be checked

Returns:

true if the layer metadata label type is supported, false otherwise

isSupportedMemberMetadataLabelType

public static boolean isSupportedMemberMetadataLabelType(java.lang.String memberMetadataLabelType)

Checks if the specified member metadata label type is supported by the TextObject. Valid values are constants MetadataMap.METADATA_SHORTLABEL, MetadataMap.METADATA_MEDIUMLABEL and MetadataMap.METADATA_LONGLABEL

Parameters:

memberMetadataLabelType - The metadata label type to be checked

Returns:

true if the layer metadata label type is supported, false otherwise

setDataAccess

public void setDataAccess(DataAccess dataAccess)
                   throws java.lang.IllegalArgumentException

Sets the DataAccess object that acts as the data provider.

Parameters:

dataAccess - The DataAccess object

Throws:

java.lang.IllegalArgumentException - If an invalid DataAccess object is specified

setDataDirector

public void setDataDirector(DataDirector dataDirector)
                     throws java.lang.IllegalArgumentException

Sets the DataDirector object that allows the data provider to be manipulated.

Parameters:

dataDirector - The DataDirector object

Throws:

java.lang.IllegalArgumentException - If an invalid DataDirector object is specified

setExportFormat

public void setExportFormat(java.lang.String exportFormat)
                     throws java.lang.IllegalArgumentException

Sets the export format.

Parameters:

exportFormat - The export format. Valid values are constants EXPORT_FORMAT_CSV and EXPORT_FORMAT_TAB_DELIMITED

Throws:

java.lang.IllegalArgumentException - If an invalid export format is specified

setExportQDRs

public void setExportQDRs(java.util.Vector listExportQDRs)

Sets the page dimension member QDR's for which the data needs to be exported

Parameters:

listExportQDRs - The list of QDR's specifying the page dimension members for which the data needs to be exported

setExportHPos

public void setExportHPos(java.util.Vector listExportHPos)

Sets the page dimension member HPos's for which the data needs to be exported

Parameters:

listExportHPos - The list of HPos's specifying the page dimension members for which the data needs to be exported

setExportRange

public void setExportRange(java.lang.String exportRange)
                    throws java.lang.IllegalArgumentException

Sets the export range.

Parameters:

exportRange - The export range. Valid values are constants EXPORT_PAGEDIM_ALL, EXPORT_PAGEDIM_CURRENT and EXPORT_PAGEDIM_SELECTED

Throws:

java.lang.IllegalArgumentException - If an invalid export range is specified

setLayerMetadataLabelType

public void setLayerMetadataLabelType(java.lang.String layerMetadataLabelType)
                               throws java.lang.IllegalArgumentException

Sets the layer metadata label type

Parameters:

layerMetadataLabelType - The layer metadata label type. Valid values are constants LayerMetadataMap.LAYER_METADATA_SHORTLABEL, LayerMetadataMap.LAYER_METADATA_MEDIUMLABEL and LayerMetadataMap.LAYER_METADATA_LONGLABEL

Throws:

java.lang.IllegalArgumentException - If an invalid layer metadata label type is specified

setMemberMetadataLabelType

public void setMemberMetadataLabelType(java.lang.String memberMetadataLabelType)
                                throws java.lang.IllegalArgumentException

Sets the member metadata label type

Parameters:

memberMetadataLabelType - The member metadata label type. Valid values are constants MetadataMap.METADATA_SHORTLABEL, MetadataMap.METADATA_MEDIUMLABEL and MetadataMap.METADATA_LONGLABEL

Throws:

java.lang.IllegalArgumentException - If an invalid member metadata label type is specified

setOutput

public void setOutput(java.io.PrintWriter output)
               throws java.lang.IllegalArgumentException

Sets the output object to which the export data is written

Parameters:

output - The PrintWriter object to which the exported data is written to.

Throws:

java.lang.IllegalArgumentException - If an invalid output object is specified

setViewFormat

public void setViewFormat(ViewFormat viewFormat)

Sets the view format object for number formatting of the export data

Parameters:

viewFormat - The ViewFormat for formatting the number data

setExportTitle

public void setExportTitle(java.lang.String exportTitle)

Sets the export title.

Parameters:

exportTitle - The export title.

setExportSubtitle

public void setExportSubtitle(java.lang.String exportSubtitle)

Sets the export subtitle.

Parameters:

exportSubtitle - The export subtitle.

setExportFootnote

public void setExportFootnote(java.lang.String exportFootnote)

Sets the export footnote.

Parameters:

exportFootnote - The export footnote.