com.businessobjects.rebean.wi
Interface XMLView

All Superinterfaces:
CharacterView

public interface XMLView
extends CharacterView

The XMLView interface provides an XML output format encapsulation.

The XML view helps the user parse a XML style sheet and transformation parameters to the internal XSLT engine or retrieve the XML stream without any transformation.


Field Summary
static int ALL
          Return all the elements
static int CONTENT
          Return the report output content (binary graph - default)
static int DATACENTRIC
          Returns the raw data for every report element
static int GRAPH_AS_BINARY
          Return the graph as binary
static int GRAPH_AS_DESCRIPTION
          Return a description of the graph
static int META_DATA
          Return the metadata of the report
static int QUERIES
          Return the document queries
 
Method Summary
 void clearParameters()
          Clear all transformation parameters.
 java.lang.Object getParameter(java.lang.String name)
          Return the value of transformation parameter "name".
 java.io.Reader getReader()
          Return the XML report output as an XML stream.
 java.io.Reader getReader(java.net.URL xsl)
          Return the result of the XSL transformation applied to the XML report output stream.
 void getUTF8Content(java.io.OutputStream out)
          Gets the UTF8 content.
 void setParameter(java.lang.String name, java.lang.Object value)
          Set a parameter for any XSLT transformation.
 
Methods inherited from interface com.businessobjects.rebean.wi.CharacterView
getContent, getEncoding, getStream
 

Field Detail

ALL

static final int ALL
Return all the elements

See Also:
Constant Field Values

META_DATA

static final int META_DATA
Return the metadata of the report

See Also:
Constant Field Values

QUERIES

static final int QUERIES
Return the document queries

See Also:
Constant Field Values

CONTENT

static final int CONTENT
Return the report output content (binary graph - default)

See Also:
Constant Field Values

GRAPH_AS_BINARY

static final int GRAPH_AS_BINARY
Return the graph as binary

See Also:
Constant Field Values

GRAPH_AS_DESCRIPTION

static final int GRAPH_AS_DESCRIPTION
Return a description of the graph

See Also:
Constant Field Values

DATACENTRIC

static final int DATACENTRIC
Returns the raw data for every report element

See Also:
Constant Field Values
Method Detail

setParameter

void setParameter(java.lang.String name,
                  java.lang.Object value)
Set a parameter for any XSLT transformation.

parameters are used to configure an internal XSLT engine, see OutputKeys class to know wich value can be set.

Parameters:
name - Name of the parameter to be set
value - parameter value
See Also:
section 16 of the XSL Transformations (XSLT) W3C Recommendation

getParameter

java.lang.Object getParameter(java.lang.String name)
Return the value of transformation parameter "name".

Parameters:
name - The name of the parameter whose value is to be retrieved
See Also:
XMLView.setParameter(String, Object)

clearParameters

void clearParameters()
Clear all transformation parameters.

See Also:
XMLView.setParameter(String, Object)

getUTF8Content

void getUTF8Content(java.io.OutputStream out)
Gets the UTF8 content.

Parameters:
out - The OutputStream

getReader

java.io.Reader getReader()
                         throws REException
Return the XML report output as an XML stream.

Throws:
REException
Since:
11.5

getReader

java.io.Reader getReader(java.net.URL xsl)
                         throws REException
Return the result of the XSL transformation applied to the XML report output stream.

Parameters:
xsl - URL to an XSL file used to transform report XML.
Throws:
REException
Since:
11.5
See Also:
XMLView.getReader()