Skip navigation links

Oracle Fusion Middleware Java API Reference for Oracle Business Intelligence Publisher
11g Release 1 (11.1.1)

E22256-01


oracle.xdo.template
Class EFTProcessor

java.lang.Object
  extended by oracle.xdo.template.EFTProcessor


public final class EFTProcessor
extends java.lang.Object

The class EFTProcessor class is the front-end class to use EFT Processing engine. To use EFTProcessor class, users have to instanciate this class and set parameters such as input, intermediate xsl, final output and control parameters.

After setting the parameters, you can start processing by calling process() method.

Typical usage is following:

EFTProcessor processor = new EFTProcessor();
 
processor.setData(xmlInput);
processor.setTemplate(template);
processor.setXSL(xslInput);
processor.setDebugMode(debug); processor.setSequence(sequenceName, sequenceValue);

Stream data are also allowed to be set.

EFTProcessor processor = new EFTProcessor();
 
processor.setData(xmlInputStream);
processor.setTemplate(templateStream);
processor.setXSL(xslInputStream);
processor.setDebugMode(debug); processor.setSequence(sequenceName, sequenceValue);


Since:
4.0
Author:
ejiang

Constructor Summary
EFTProcessor()
          Constructor
EFTProcessor(java.io.InputStream is)
          Constructor
EFTProcessor(java.lang.String path)
           

 

Method Summary
 java.util.Vector getPeriodicSequenceNames()
          Returns a list of periodic sequence number's name defined by user in the template
 java.util.Hashtable getPeriodicSequenceNumbers()
           
static void main(java.lang.String[] args)
          Command line utility.
 void process()
          Run the EFT compiler to convert RTF to XSL.
 void setConfig(java.io.InputStream docLevelInputStream)
          Sets the configuration for the document to be processed.
 void setConfig(java.util.Properties prop)
          Sets the configuration for the document to be processed.
 void setConfig(java.lang.String docLevelConfigPath)
          Sets the configuration for the document to be processed.
 void setData(java.io.InputStream stream)
          Sets XML Data Input Stream.
 void setData(java.io.Reader reader)
          Sets XML Data Reader.
 void setData(java.lang.String xmlFile)
          Sets Input XML File.
 void setOutput(java.io.OutputStream os)
          Sets output stream.
 void setOutput(java.lang.String path)
          Sets output file path.
 void setTemplate(java.io.InputStream stream)
          Sets Input Stream for Template data.
 void setTemplate(java.io.Reader reader)
          Sets Reader for XSL data.
 void setTemplate(java.lang.String mFile)
          Sets Input Template File.
 void setXSL(java.io.InputStream xslInputStream)
           
 void setXSL(java.lang.String xslFile)
           

 

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

 

Constructor Detail

EFTProcessor

public EFTProcessor()
Constructor
Parameters:
path - EFT source file's path
Throws:
java.io.IOException - if file cannot be created
Since:
5.0

EFTProcessor

public EFTProcessor(java.lang.String path)
             throws java.io.IOException
Throws:
java.io.IOException

EFTProcessor

public EFTProcessor(java.io.InputStream is)
Constructor
Parameters:
in - EFT input stream
Since:
5.0

Method Detail

setTemplate

public void setTemplate(java.lang.String mFile)
Sets Input Template File. You also have to set XML data.
Parameters:
xslFile - xsl input file path

setTemplate

public void setTemplate(java.io.InputStream stream)
Sets Input Stream for Template data. You also have to set XML data.
Parameters:
stream - input stream for xsl input

setTemplate

public void setTemplate(java.io.Reader reader)
Sets Reader for XSL data. You also have to set XML data.
Parameters:
reader - reader for xsl input
Since:
3.5

setData

public void setData(java.lang.String xmlFile)
Sets Input XML File. You also have to set template.
Parameters:
xmlFile - xml input file path

setData

public void setData(java.io.InputStream stream)
Sets XML Data Input Stream. You also have to set template.
Parameters:
stream - input stream for xml input

setData

public void setData(java.io.Reader reader)
Sets XML Data Reader. You also have to set template.
Parameters:
reader - Reader for xml input
Since:
3.5

setXSL

public void setXSL(java.lang.String xslFile)

setXSL

public void setXSL(java.io.InputStream xslInputStream)
            throws java.lang.Exception
Throws:
java.lang.Exception

setOutput

public void setOutput(java.lang.String path)
               throws java.io.IOException
Sets output file path. Output file format must be specified by SetOutputFormat() method.
Parameters:
outFile - output file path
Throws:
java.io.IOException

setOutput

public void setOutput(java.io.OutputStream os)
Sets output stream. Output file format must be specified by SetOutputFormat() method.
Parameters:
stream - output stream name

process

public void process()
             throws XDOException
Run the EFT compiler to convert RTF to XSL. It returns an org.w3c.dom.Document object representing the XSL, returns null if processed unsuccessfully. If the OutputStream is set, then it also writes the xsl to the OutputStream
Throws:
oracle.xdo.XDOException
XDOException
Since:
5.0

getPeriodicSequenceNumbers

public final java.util.Hashtable getPeriodicSequenceNumbers()
Parameters:
-
Returns:
hashtable key is PERIODIC_SEQUENCE sequence name value is last sequence number

setConfig

public void setConfig(java.util.Properties prop)
Sets the configuration for the document to be processed. This method allows you to set the difference from the system configuration.
Parameters:
prop - Properties for the document level configuration
Since:
5.0

setConfig

public void setConfig(java.io.InputStream docLevelInputStream)
Sets the configuration for the document to be processed. This method allows you to set the difference from the system configuration.
Parameters:
configStream - InputStream for the document level configuration
Since:
5.0

setConfig

public void setConfig(java.lang.String docLevelConfigPath)
Sets the configuration for the document to be processed. This method allows you to set the difference from the system configuration.
Parameters:
configFilePath - file path for the document level configuration
Since:
5.0

getPeriodicSequenceNames

public java.util.Vector getPeriodicSequenceNames()
Returns a list of periodic sequence number's name defined by user in the template

If the template is parsed, the method returns null

If parsed template doesn't have any user defined periodic sequence number, this method returns empty list

Returns:
a list of periodic sequence number in java.util.Vector
Since:
5.6

main

public static void main(java.lang.String[] args)
Command line utility. The compile an EFT file to an XSL/FO file, you can use: java oracle.xdo.template.EFTProccessor [-config <configfile.xml>] <input_file.rtf> <output_file.xsl>
Parameters:
args - parameters for this processor
Throws:
oracle.xdo.XDOException - raise XDOException if exception happens
Since:
5.0

Skip navigation links

Oracle Fusion Middleware Java API Reference for Oracle Business Intelligence Publisher
11g Release 1 (11.1.1)

E22256-01


Copyright © 2010, 2011, Oracle. All rights reserved.