Skip navigation links

Oracle BI Publisher Java API Reference
Release 10.1.3.3


oracle.apps.xdo.template.fo.util
Class FOUtility

java.lang.Object
  extended by oracle.apps.xdo.template.fo.util.FOUtility


public class FOUtility
extends java.lang.Object

Static method collection for handling XSL-FO data createFO() method is supported for mixed type input. It needs to be instanciated to use this feature.

 FOUtility foUtil = new FOUtility();
 foUtil.setXml(xmlReader);
 foUtil.setXsl("template.xsl");
 result = foUtil.createFO();
 
Version:
3.0
Author:
hinami

Field Summary
static java.lang.String RCS_ID
           
static boolean RCS_ID_RECORDED
           

 

Constructor Summary
FOUtility()
          Constructor for using mixed type input fo createFO()

 

Method Summary
 java.io.InputStream createFO()
          start XSL transformation to generate XSL-FO
static java.io.InputStream createFO(java.io.InputStream xmlStream, java.io.InputStream xslStream)
          Creates XSL-FO InputStream from XML and XSL InputStreams
static void createFO(java.io.InputStream xmlStream, java.io.InputStream xslStream, java.io.OutputStream outStream)
          Creates XSL-FO InputStream from XML and XSL files
static java.io.InputStream createFO(java.io.Reader xmlInput, java.io.Reader xslInput)
          Creates XSL-FO InputStream from XML and XSL files
static java.io.InputStream createFO(java.lang.String xmlFile, java.lang.String xslFile)
          Creates XSL-FO InputStream from XML and XSL files
 java.io.InputStream generateFO()
          start XSL transformation to generate XSL-FO
 java.io.File generateFO(java.util.Properties prop)
          start XSL transformation to generate XSL-FO with parameters such as temporary file setting
 java.io.InputStream generateFO(java.util.Properties prop, java.io.File outFile, boolean multiThreads)
           
static java.io.InputStream mergeFOs(java.io.InputStream[] foInput)
          Deprecated. use mergeFOs(InputStream[], Properties)
static java.io.InputStream mergeFOs(java.io.InputStream[] foInput, java.util.Properties prop)
          Merges two or more XSL-FO InputStreams into one XSL-FO file.
static java.io.InputStream mergeFOs(java.io.Reader[] foReaders)
          Deprecated. use mergeFOs(Reader[], Properties)
static java.io.InputStream mergeFOs(java.io.Reader[] foReaders, java.util.Properties prop)
          Merges two or more XSL-FO files into one XSL-FO file.
static java.io.InputStream mergeFOs(java.lang.String[] foInput)
          Deprecated. use mergeFOs(String[], Properties)
static java.io.InputStream mergeFOs(java.lang.String[] foInput, java.util.Properties prop)
          Merges two or more XSL-FO files into one XSL-FO file.
static java.io.InputStream mergeFOs(java.util.Vector inputs)
          Deprecated. use mergeFOs(Vector[], Properties)
static java.io.InputStream mergeFOs(java.util.Vector inputs, java.util.Properties prop)
          Merges two or more XSL-FO files into one XSL-FO file.
 void setProperties(java.util.Properties prop)
           
 void setXml(java.io.InputStream xmlStream)
          Sets XML Data Input Stream.
 void setXml(java.io.Reader xmlReader)
          Sets XML Data Input Reader.
 void setXml(java.lang.String xmlFile)
          Sets Input XML File.
 void setXsl(java.io.InputStream xslStream)
          Sets Input Stream for XSL data.
 void setXsl(java.io.Reader xslReader)
          Sets Reader for XSL data
 void setXsl(java.lang.String xslFile)
          Sets Input XSL File.
static java.io.InputStream toInputStream(oracle.xml.parser.v2.XMLDocument doc)
          Converts XMLDocument to InputStream

 

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

 

Field Detail

RCS_ID

public static final java.lang.String RCS_ID
See Also:
Constant Field Values

RCS_ID_RECORDED

public static final boolean RCS_ID_RECORDED

Constructor Detail

FOUtility

public FOUtility()
Constructor for using mixed type input fo createFO()
Since:
3.5

Method Detail

setXml

public void setXml(java.lang.String xmlFile)
Sets Input XML File.
Parameters:
xmlFile - xml input file path
Since:
3.5

setXml

public void setXml(java.io.InputStream xmlStream)
Sets XML Data Input Stream.
Parameters:
xmlStream - input stream for xml input
Since:
3.5

setXml

public void setXml(java.io.Reader xmlReader)
Sets XML Data Input Reader.
Parameters:
xmlReader - Reader for xml input
Since:
3.5

setXsl

public void setXsl(java.lang.String xslFile)
Sets Input XSL File.
Parameters:
xslFile - xsl input file path
Since:
3.5

setXsl

public void setXsl(java.io.InputStream xslStream)
Sets Input Stream for XSL data.
Parameters:
xslStream - input stream for xsl input
Since:
3.5

setXsl

public void setXsl(java.io.Reader xslReader)
Sets Reader for XSL data
Parameters:
xslReader - reader for xsl input
Since:
3.5

setProperties

public void setProperties(java.util.Properties prop)

createFO

public java.io.InputStream createFO()
start XSL transformation to generate XSL-FO
Returns:
InputStream generated InputStream of XSL-FO
Since:
3.5

generateFO

public java.io.InputStream generateFO()
                               throws XDOException
start XSL transformation to generate XSL-FO
Returns:
InputStream generated InputStream of XSL-FO
Throws:
XDOException
Since:
4.5

generateFO

public java.io.File generateFO(java.util.Properties prop)
                        throws XDOException
start XSL transformation to generate XSL-FO with parameters such as temporary file setting
Parameters:
prop -
Returns:
File ... File object for generated XSL-FO
Throws:
XDOException
Since:
4.5

generateFO

public java.io.InputStream generateFO(java.util.Properties prop,
                                      java.io.File outFile,
                                      boolean multiThreads)
                               throws XDOException
Throws:
XDOException

mergeFOs

public static java.io.InputStream mergeFOs(java.io.InputStream[] foInput)
Deprecated. use mergeFOs(InputStream[], Properties)

Merges two or more XSL-FO InputStreams into one XSL-FO file. This method handles first XSL-FO file as a master and appends other files to it.

Parameters:
foInput - InputStream Array for XSL-FO files
Returns:
InputStream for merged XSL-FO; null means error

mergeFOs

public static java.io.InputStream mergeFOs(java.lang.String[] foInput)
Deprecated. use mergeFOs(String[], Properties)

Merges two or more XSL-FO files into one XSL-FO file. This method handles first XSL-FO file as master and appends other files to it. This method does not resolve naming confliction. If the same name or id is used in the two documents, method ends successfully but merged XSL-FO may have a problem.

Parameters:
foInputs - filepath String Array for XSL-FO files
Returns:
InputStream for merged XSL-FO; null means error

mergeFOs

public static java.io.InputStream mergeFOs(java.io.Reader[] foReaders)
Deprecated. use mergeFOs(Reader[], Properties)

Merges two or more XSL-FO files into one XSL-FO file. This method handles first XSL-FO file as master and appends other files to it.

Parameters:
foReaders - Reader Array for XSL-FO files
Returns:
InputStream for merged XSL-FO; null means error

mergeFOs

public static java.io.InputStream mergeFOs(java.util.Vector inputs)
Deprecated. use mergeFOs(Vector[], Properties)

Merges two or more XSL-FO files into one XSL-FO file. This method handles first XSL-FO file as master and appends other files to it.

Parameters:
inputs - vector of filepath String, InputStrem and Reader
Returns:
InputStream for merged XSL-FO; null means error

mergeFOs

public static java.io.InputStream mergeFOs(java.io.InputStream[] foInput,
                                           java.util.Properties prop)

Merges two or more XSL-FO InputStreams into one XSL-FO file. This method handles first XSL-FO file as a master and appends other files to it.

Parameters:
foInput - InputStream Array for XSL-FO files
Returns:
InputStream for merged XSL-FO; null means error

mergeFOs

public static java.io.InputStream mergeFOs(java.lang.String[] foInput,
                                           java.util.Properties prop)

Merges two or more XSL-FO files into one XSL-FO file. This method handles first XSL-FO file as master and appends other files to it. This method does not resolve naming confliction. If the same name or id is used in the two documents, method ends successfully but merged XSL-FO may have a problem.

Parameters:
foInputs - filepath String Array for XSL-FO files
Returns:
InputStream for merged XSL-FO; null means error

mergeFOs

public static java.io.InputStream mergeFOs(java.io.Reader[] foReaders,
                                           java.util.Properties prop)

Merges two or more XSL-FO files into one XSL-FO file. This method handles first XSL-FO file as master and appends other files to it.

Parameters:
foReaders - Reader Array for XSL-FO files
Returns:
InputStream for merged XSL-FO; null means error

mergeFOs

public static java.io.InputStream mergeFOs(java.util.Vector inputs,
                                           java.util.Properties prop)

Merges two or more XSL-FO files into one XSL-FO file. This method handles first XSL-FO file as master and appends other files to it.

Parameters:
inputs - vector of filepath String, InputStrem and Reader
Returns:
InputStream for merged XSL-FO; null means error

createFO

public static java.io.InputStream createFO(java.io.Reader xmlInput,
                                           java.io.Reader xslInput)
Creates XSL-FO InputStream from XML and XSL files
Parameters:
xmlFile - input xml file path
xslFile - input xsl file path
Returns:
XSL-FO InputStream

createFO

public static java.io.InputStream createFO(java.lang.String xmlFile,
                                           java.lang.String xslFile)
Creates XSL-FO InputStream from XML and XSL files
Parameters:
xmlFile - input xml file path
xslFile - input xsl file path
Returns:
XSL-FO InputStream

createFO

public static void createFO(java.io.InputStream xmlStream,
                            java.io.InputStream xslStream,
                            java.io.OutputStream outStream)
Creates XSL-FO InputStream from XML and XSL files
Parameters:
xmlFile - input xml file path
xslFile - input xsl file path

createFO

public static java.io.InputStream createFO(java.io.InputStream xmlStream,
                                           java.io.InputStream xslStream)
Creates XSL-FO InputStream from XML and XSL InputStreams
Parameters:
xmlStrean - input XML data stream
xslStream - input XSL data stream
Returns:
XSL-FO InputStream

toInputStream

public static java.io.InputStream toInputStream(oracle.xml.parser.v2.XMLDocument doc)
Converts XMLDocument to InputStream
Parameters:
doc - XMLDocument to be converted to InputStream
Returns:
InputStream

Skip navigation links

Oracle BI Publisher Java API Reference
Release 10.1.3.3


© 2004, 2005, 2006, 2007, Oracle. All rights reserved.