oracle.dss.util
Class DumpContext

java.lang.Object
  oracle.dss.util.DumpContext

public class DumpContext
extends java.lang.Object

Class to provide a text dump of query contents and cursors.

Constructor Summary

DumpContext()

Method Summary

static void	dumpCrosstabResults(java.io.PrintWriter pw, DataAccess da) Dump the cursor like a crosstab display, including asym
static void	dumpCrosstabResults(java.io.PrintWriter pw, DataAccess da, int colBound, int rowBound, MetadataPrinter mp)
static void	dumpCrosstabResults(java.io.PrintWriter pw, DataAccess da, int colBound, int rowBound, java.lang.String type, boolean outline, MetadataPrinter mp, java.text.DecimalFormat df)
static void	dumpCrosstabResults(java.io.PrintWriter pw, DataAccess da, int colBound, int rowBound, java.lang.String type, MetadataPrinter mp)
static void	dumpCrosstabResults(java.io.PrintWriter pw, DataAccess da, int colBound, int rowBound, java.lang.String type, MetadataPrinter mp, java.text.DecimalFormat df)
static void	dumpCrosstabResults(java.io.PrintWriter pw, DataAccess da, int colBound, int rowBound, java.lang.String type, java.lang.String dataType, boolean outline, MetadataPrinter mp, java.text.DecimalFormat df)
static void	dumpCrosstabResults(java.io.PrintWriter pw, DataAccess da, MetadataPrinter mp)
static void	dumpCurrentIndex(java.io.PrintWriter pw, DataAccess da, int edge, int index, MetadataMap map) Dump the current settings of each of the dims on an edge
static void	dumpCurrentIndex(java.io.PrintWriter pw, DataAccess da, int edge, int index, MetadataMap map, MetadataPrinter mp)
static void	dumpCursor(java.io.PrintWriter pw, DataAccess da) Dump the contents of the cursor in a DataAccess.
static void	dumpCursor(java.io.PrintWriter pw, DataAccess da, MetadataPrinter mp)
static void	dumpCursor(java.io.PrintWriter pw, DataAccess da, java.lang.String dataType) Dump the contents of the cursor in a DataAccess.
static void	dumpCursor(java.io.PrintWriter pw, DataAccess da, java.lang.String dataType, MetadataPrinter mp)
static void	dumpCursor(java.io.PrintWriter pw, DataAccess da, java.lang.String dataType, java.lang.String metadataType, MetadataPrinter mp)
static void	dumpEdge(java.io.PrintWriter pw, DataAccess da, int edge) Dump sets of values for a given edge, taking asymmetry into account
static void	dumpEdge(java.io.PrintWriter pw, DataAccess da, int edge, MetadataPrinter mp)
static void	dumpEdgeCursor(java.io.PrintWriter pw, DataAccess da, int edge) Dump the contents of an edge metadata cursor
static void	dumpEdgeCursor(java.io.PrintWriter pw, DataAccess da, int edge, int count, java.lang.String type, MetadataPrinter mp)
static void	dumpEdgeCursor(java.io.PrintWriter pw, DataAccess da, int edge, MetadataPrinter mp)
static void	dumpMetadata(java.io.PrintWriter pw, DataAccess da, int edge, MetadataMap map) Dump metadata for a given edge
static void	dumpMetadata(java.io.PrintWriter pw, DataAccess da, int edge, MetadataMap map, MetadataPrinter mp)
static void	dumpResults(java.io.PrintWriter pw, DataAccess da, MetadataMap map) Dump the contents of the edges and data body
static void	dumpResults(java.io.PrintWriter pw, DataAccess da, MetadataMap map, MetadataPrinter mp)
static void	dumpResults(java.io.PrintWriter pw, DataAccess da, MetadataMap map, java.lang.String type, MetadataPrinter mp)

Methods inherited from class java.lang.Object

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

Constructor Detail

DumpContext

public DumpContext()

Method Detail

dumpMetadata

public static void dumpMetadata(java.io.PrintWriter pw,
                                DataAccess da,
                                int edge,
                                MetadataMap map)
                         throws EdgeOutOfRangeException,
                                LayerOutOfRangeException,
                                SliceOutOfRangeException

Dump metadata for a given edge

Parameters:

pw - PrintWriter to dump to

da - DataAccess to dump

edge - edge to dump

Throws:

EdgeOutOfRangeException - if the edge is invalid

LayerOutOfRangeException - if the layer is invalid

SliceOutOfRangeException - if the slice is invalid

dumpResults

public static void dumpResults(java.io.PrintWriter pw,
                               DataAccess da,
                               MetadataMap map)
                        throws ColumnOutOfRangeException,
                               RowOutOfRangeException,
                               LayerOutOfRangeException,
                               SliceOutOfRangeException,
                               EdgeOutOfRangeException

Dump the contents of the edges and data body

Parameters:

pw - PrintWriter to dump to

da - DataAccess to dump

map - types of metadata to dump

Throws:

ColumnOutOfRangeException - if the data column is invalid

RowOutOfRangeException - if the data row is invalid

EdgeOutOfRangeException - if the edge is invalid

LayerOutOfRangeException - if the layer is invalid

SliceOutOfRangeException - if the slice is invalid

dumpCurrentIndex

public static void dumpCurrentIndex(java.io.PrintWriter pw,
                                    DataAccess da,
                                    int edge,
                                    int index,
                                    MetadataMap map)
                             throws LayerOutOfRangeException,
                                    SliceOutOfRangeException,
                                    EdgeOutOfRangeException

Dump the current settings of each of the dims on an edge

Parameters:

pw - PrintWriter to dump to

da - DataAccess to dump

edge - edge to dump

absolute - index to dump

Throws:

EdgeOutOfRangeException - if the edge is invalid

LayerOutOfRangeException - if the layer is invalid

SliceOutOfRangeException - if the slice is invalid

dumpEdgeCursor

public static void dumpEdgeCursor(java.io.PrintWriter pw,
                                  DataAccess da,
                                  int edge)
                           throws EdgeOutOfRangeException,
                                  LayerOutOfRangeException,
                                  SliceOutOfRangeException

Dump the contents of an edge metadata cursor

Parameters:

pw - PrintWriter to dump to

da - DataAccess to dump

edge - edge to dump

Throws:

EdgeOutOfRangeException - if the edge is invalid

LayerOutOfRangeException - if the layer is invalid

SliceOutOfRangeException - if the slice is invalid

dumpCursor

public static void dumpCursor(java.io.PrintWriter pw,
                              DataAccess da,
                              java.lang.String dataType)
                       throws ColumnOutOfRangeException,
                              RowOutOfRangeException,
                              LayerOutOfRangeException,
                              SliceOutOfRangeException,
                              EdgeOutOfRangeException

Dump the contents of the cursor in a DataAccess.

Parameters:

pw - PrintWriter to dump to

da - DataAccess to dump

dataType - data type of the cursor data body to dump

Throws:

ColumnOutOfRangeException - if the data column is invalid

RowOutOfRangeException - if the data row is invalid

EdgeOutOfRangeException - if the edge is invalid

LayerOutOfRangeException - if the layer is invalid

SliceOutOfRangeException - if the slice is invalid

dumpEdge

public static void dumpEdge(java.io.PrintWriter pw,
                            DataAccess da,
                            int edge)
                     throws EdgeOutOfRangeException,
                            LayerOutOfRangeException,
                            SliceOutOfRangeException

Dump sets of values for a given edge, taking asymmetry into account

Parameters:

pw - PrintWriter to dump to

da - DataAccess to dump

edge - edge to dump

Throws:

EdgeOutOfRangeException - if the edge is invalid

LayerOutOfRangeException - if the layer is invalid

SliceOutOfRangeException - if the slice is invalid

dumpCrosstabResults

public static void dumpCrosstabResults(java.io.PrintWriter pw,
                                       DataAccess da)
                                throws ColumnOutOfRangeException,
                                       RowOutOfRangeException,
                                       LayerOutOfRangeException,
                                       SliceOutOfRangeException,
                                       EdgeOutOfRangeException

Dump the cursor like a crosstab display, including asym

Parameters:

pw - PrintWriter to dump to

da - DataAccess to dump

Throws:

ColumnOutOfRangeException - if the data column is invalid

RowOutOfRangeException - if the data row is invalid

EdgeOutOfRangeException - if the edge is invalid

LayerOutOfRangeException - if the layer is invalid

SliceOutOfRangeException - if the slice is invalid

dumpResults

public static void dumpResults(java.io.PrintWriter pw,
                               DataAccess da,
                               MetadataMap map,
                               MetadataPrinter mp)
                        throws ColumnOutOfRangeException,
                               RowOutOfRangeException,
                               LayerOutOfRangeException,
                               SliceOutOfRangeException,
                               EdgeOutOfRangeException

Parameters:

pw - PrintWriter to dump to

da - DataAccess to dump

map - types of metadata to dump

mp - MetadataPrinter to use

Throws:

ColumnOutOfRangeException - if the data column is invalid

RowOutOfRangeException - if the data row is invalid

EdgeOutOfRangeException - if the edge is invalid

LayerOutOfRangeException - if the layer is invalid

SliceOutOfRangeException - if the slice is invalid

dumpResults

public static void dumpResults(java.io.PrintWriter pw,
                               DataAccess da,
                               MetadataMap map,
                               java.lang.String type,
                               MetadataPrinter mp)
                        throws ColumnOutOfRangeException,
                               RowOutOfRangeException,
                               LayerOutOfRangeException,
                               SliceOutOfRangeException,
                               EdgeOutOfRangeException

Parameters:

pw - PrintWriter to dump to

da - DataAccess to dump

map - types of metadata to dump

mp - MetadataPrinter to use

Throws:

ColumnOutOfRangeException - if the data column is invalid

RowOutOfRangeException - if the data row is invalid

EdgeOutOfRangeException - if the edge is invalid

LayerOutOfRangeException - if the layer is invalid

SliceOutOfRangeException - if the slice is invalid

dumpMetadata

public static void dumpMetadata(java.io.PrintWriter pw,
                                DataAccess da,
                                int edge,
                                MetadataMap map,
                                MetadataPrinter mp)
                         throws EdgeOutOfRangeException,
                                LayerOutOfRangeException,
                                SliceOutOfRangeException

Parameters:

pw - PrintWriter to dump to

da - DataAccess to dump

edge - edge to dump

mp - MetadataPrinter to use

Throws:

EdgeOutOfRangeException - if the edge is invalid

LayerOutOfRangeException - if the layer is invalid

SliceOutOfRangeException - if the slice is invalid

dumpEdge

public static void dumpEdge(java.io.PrintWriter pw,
                            DataAccess da,
                            int edge,
                            MetadataPrinter mp)
                     throws EdgeOutOfRangeException,
                            LayerOutOfRangeException,
                            SliceOutOfRangeException

Parameters:

pw - PrintWriter to dump to

da - DataAccess to dump

edge - edge to dump

mp - MetadataPrinter to use

Throws:

EdgeOutOfRangeException - if the edge is invalid

LayerOutOfRangeException - if the layer is invalid

SliceOutOfRangeException - if the slice is invalid

dumpCursor

public static void dumpCursor(java.io.PrintWriter pw,
                              DataAccess da,
                              java.lang.String dataType,
                              MetadataPrinter mp)
                       throws ColumnOutOfRangeException,
                              RowOutOfRangeException,
                              LayerOutOfRangeException,
                              SliceOutOfRangeException,
                              EdgeOutOfRangeException

Parameters:

pw - PrintWriter to dump to

da - DataAccess to dump

dataType - data type of the cursor data body to dump

mp - MetadataPrinter to use

Throws:

ColumnOutOfRangeException - if the data column is invalid

RowOutOfRangeException - if the data row is invalid

EdgeOutOfRangeException - if the edge is invalid

LayerOutOfRangeException - if the layer is invalid

SliceOutOfRangeException - if the slice is invalid

dumpCursor

public static void dumpCursor(java.io.PrintWriter pw,
                              DataAccess da,
                              java.lang.String dataType,
                              java.lang.String metadataType,
                              MetadataPrinter mp)
                       throws ColumnOutOfRangeException,
                              RowOutOfRangeException,
                              LayerOutOfRangeException,
                              SliceOutOfRangeException,
                              EdgeOutOfRangeException

Parameters:

pw - PrintWriter to dump to

da - DataAccess to dump

dataType - data type of the cursor data body to dump

metadataType - type of metadata to dump for edges

mp - MetadataPrinter to use

Throws:

ColumnOutOfRangeException - if the data column is invalid

RowOutOfRangeException - if the data row is invalid

EdgeOutOfRangeException - if the edge is invalid

LayerOutOfRangeException - if the layer is invalid

SliceOutOfRangeException - if the slice is invalid

dumpCursor

public static void dumpCursor(java.io.PrintWriter pw,
                              DataAccess da)
                       throws ColumnOutOfRangeException,
                              RowOutOfRangeException,
                              LayerOutOfRangeException,
                              SliceOutOfRangeException,
                              EdgeOutOfRangeException

Dump the contents of the cursor in a DataAccess.

Parameters:

pw - PrintWriter to dump to

da - DataAccess to dump

Throws:

ColumnOutOfRangeException - if the data column is invalid

RowOutOfRangeException - if the data row is invalid

EdgeOutOfRangeException - if the edge is invalid

LayerOutOfRangeException - if the layer is invalid

SliceOutOfRangeException - if the slice is invalid

dumpCursor

public static void dumpCursor(java.io.PrintWriter pw,
                              DataAccess da,
                              MetadataPrinter mp)
                       throws ColumnOutOfRangeException,
                              RowOutOfRangeException,
                              LayerOutOfRangeException,
                              SliceOutOfRangeException,
                              EdgeOutOfRangeException

Parameters:

pw - PrintWriter to dump to

da - DataAccess to dump

Throws:

ColumnOutOfRangeException - if the data column is invalid

RowOutOfRangeException - if the data row is invalid

EdgeOutOfRangeException - if the edge is invalid

LayerOutOfRangeException - if the layer is invalid

SliceOutOfRangeException - if the slice is invalid

dumpEdgeCursor

public static void dumpEdgeCursor(java.io.PrintWriter pw,
                                  DataAccess da,
                                  int edge,
                                  MetadataPrinter mp)
                           throws EdgeOutOfRangeException,
                                  LayerOutOfRangeException,
                                  SliceOutOfRangeException

Parameters:

pw - PrintWriter to dump to

da - DataAccess to dump

edge - edge to dump

mp - MetadataPrinter to use

Throws:

EdgeOutOfRangeException - if the edge is invalid

LayerOutOfRangeException - if the layer is invalid

SliceOutOfRangeException - if the slice is invalid

dumpEdgeCursor

public static void dumpEdgeCursor(java.io.PrintWriter pw,
                                  DataAccess da,
                                  int edge,
                                  int count,
                                  java.lang.String type,
                                  MetadataPrinter mp)
                           throws EdgeOutOfRangeException,
                                  LayerOutOfRangeException,
                                  SliceOutOfRangeException

Parameters:

pw - PrintWriter to dump to

da - DataAccess to dump

edge - edge to dump

count - max slice on edge to dump

type - type of metadata to dump

mp - MetadataPrinter to use

Throws:

EdgeOutOfRangeException - if the edge is invalid

LayerOutOfRangeException - if the layer is invalid

SliceOutOfRangeException - if the slice is invalid

dumpCurrentIndex

public static void dumpCurrentIndex(java.io.PrintWriter pw,
                                    DataAccess da,
                                    int edge,
                                    int index,
                                    MetadataMap map,
                                    MetadataPrinter mp)
                             throws LayerOutOfRangeException,
                                    SliceOutOfRangeException,
                                    EdgeOutOfRangeException

Parameters:

pw - PrintWriter to dump to

da - DataAccess to dump

edge - edge to dump

absolute - index to dump

mp - MetadataPrinter to use

Throws:

EdgeOutOfRangeException - if the edge is invalid

LayerOutOfRangeException - if the layer is invalid

SliceOutOfRangeException - if the slice is invalid

dumpCrosstabResults

public static void dumpCrosstabResults(java.io.PrintWriter pw,
                                       DataAccess da,
                                       MetadataPrinter mp)
                                throws ColumnOutOfRangeException,
                                       RowOutOfRangeException,
                                       LayerOutOfRangeException,
                                       SliceOutOfRangeException,
                                       EdgeOutOfRangeException

Parameters:

pw - PrintWriter to dump to

da - DataAccess to dump

mp - MetadataPrinter to use

Throws:

ColumnOutOfRangeException - if the data column is invalid

RowOutOfRangeException - if the data row is invalid

EdgeOutOfRangeException - if the edge is invalid

LayerOutOfRangeException - if the layer is invalid

SliceOutOfRangeException - if the slice is invalid

dumpCrosstabResults

public static void dumpCrosstabResults(java.io.PrintWriter pw,
                                       DataAccess da,
                                       int colBound,
                                       int rowBound,
                                       MetadataPrinter mp)
                                throws ColumnOutOfRangeException,
                                       RowOutOfRangeException,
                                       LayerOutOfRangeException,
                                       SliceOutOfRangeException,
                                       EdgeOutOfRangeException

Parameters:

pw - PrintWriter to dump to

da - DataAccess to dump

colBound - artificial column extent

rowBound - artificial row extent

mp - MetadataPrinter to use

Throws:

ColumnOutOfRangeException - if the data column is invalid

RowOutOfRangeException - if the data row is invalid

EdgeOutOfRangeException - if the edge is invalid

LayerOutOfRangeException - if the layer is invalid

SliceOutOfRangeException - if the slice is invalid

dumpCrosstabResults

public static void dumpCrosstabResults(java.io.PrintWriter pw,
                                       DataAccess da,
                                       int colBound,
                                       int rowBound,
                                       java.lang.String type,
                                       MetadataPrinter mp)
                                throws ColumnOutOfRangeException,
                                       RowOutOfRangeException,
                                       LayerOutOfRangeException,
                                       SliceOutOfRangeException,
                                       EdgeOutOfRangeException

Parameters:

pw - PrintWriter to dump to

da - DataAccess to dump

colBound - artificial column extent

rowBound - artificial row extent

type - type of labels to dump

mp - MetadataPrinter to use

Throws:

ColumnOutOfRangeException - if the data column is invalid

RowOutOfRangeException - if the data row is invalid

EdgeOutOfRangeException - if the edge is invalid

LayerOutOfRangeException - if the layer is invalid

SliceOutOfRangeException - if the slice is invalid

dumpCrosstabResults

public static void dumpCrosstabResults(java.io.PrintWriter pw,
                                       DataAccess da,
                                       int colBound,
                                       int rowBound,
                                       java.lang.String type,
                                       MetadataPrinter mp,
                                       java.text.DecimalFormat df)
                                throws ColumnOutOfRangeException,
                                       RowOutOfRangeException,
                                       LayerOutOfRangeException,
                                       SliceOutOfRangeException,
                                       EdgeOutOfRangeException

Parameters:

pw - PrintWriter to dump to

da - DataAccess to dump

colBound - artificial column extent

rowBound - artificial row extent

type - type of labels to dump

mp - MetadataPrinter to use

df - DecimalFormat to use for data body output, if numeric

Throws:

ColumnOutOfRangeException - if the data column is invalid

RowOutOfRangeException - if the data row is invalid

EdgeOutOfRangeException - if the edge is invalid

LayerOutOfRangeException - if the layer is invalid

SliceOutOfRangeException - if the slice is invalid

dumpCrosstabResults

public static void dumpCrosstabResults(java.io.PrintWriter pw,
                                       DataAccess da,
                                       int colBound,
                                       int rowBound,
                                       java.lang.String type,
                                       boolean outline,
                                       MetadataPrinter mp,
                                       java.text.DecimalFormat df)
                                throws ColumnOutOfRangeException,
                                       RowOutOfRangeException,
                                       LayerOutOfRangeException,
                                       SliceOutOfRangeException,
                                       EdgeOutOfRangeException

Throws:

ColumnOutOfRangeException

RowOutOfRangeException

LayerOutOfRangeException

SliceOutOfRangeException

EdgeOutOfRangeException

dumpCrosstabResults

public static void dumpCrosstabResults(java.io.PrintWriter pw,
                                       DataAccess da,
                                       int colBound,
                                       int rowBound,
                                       java.lang.String type,
                                       java.lang.String dataType,
                                       boolean outline,
                                       MetadataPrinter mp,
                                       java.text.DecimalFormat df)
                                throws ColumnOutOfRangeException,
                                       RowOutOfRangeException,
                                       LayerOutOfRangeException,
                                       SliceOutOfRangeException,
                                       EdgeOutOfRangeException

Parameters:

pw - PrintWriter to dump to

da - DataAccess to dump

type - type of labels to dump

outline - true if print in outline mode

mp - MetadataPrinter to use

df - DecimalFormat to use for data body output, if numeric

Throws:

ColumnOutOfRangeException - if the data column is invalid

RowOutOfRangeException - if the data row is invalid

EdgeOutOfRangeException - if the edge is invalid

LayerOutOfRangeException - if the layer is invalid

SliceOutOfRangeException - if the slice is invalid