|
Oracle BI Publisher Java API Reference Release 10.1.3.4 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
oracle.apps.xdo.batch.DocumentProcessor
public class DocumentProcessor
The class DocumentProcessor provides a complete beginning-to-end report flow. There are two main functions listed below.
The DocumentProcessor (a.k.a XML API) takes one XML instruction file. The XML file contains more than one set of pairs of template and data. Please refer to XML Publisher Develier's Guide for more detail. Here is how to use it.
DocumentProcessor docProcessor = null; try { docProcessor = new DocumentProcessor(xmlFilePath, temporaryDirectory); Vector outputList = docProcessor.process(); } catch(IOException ioe) { // If this exception is thrown, the temporaryDirectory information is incorrect. ioe.printStackTrace(); } catch(Exception exc) { //If this exception is thrown, process() failed exc.printStackTrace(); }
The command line usage is following.
java oracle.apps.xdo.batch.DocumentProcessor -tempdir <tempdir> <xml file>
Please refer to main() method for more.
Field Summary | |
---|---|
static java.lang.String |
ENC_LEVEL |
static java.lang.String |
ENC_OWNER_PW |
static java.lang.String |
ENC_USER_PW |
static java.lang.String |
RCS_ID |
static boolean |
RCS_ID_RECORDED |
Constructor Summary | |
---|---|
DocumentProcessor(java.io.InputStream xmlInputStream, java.io.InputStream dataInputStream, java.lang.String tmpDir) Constructors a new DocumentProcessor for bursting process. |
|
DocumentProcessor(java.io.InputStream xmlInputStream, java.lang.String tmpDir) Constructors a new DocumentProcessor. |
|
DocumentProcessor(java.io.Reader xmlInputReader, java.io.Reader dataInputReader, java.lang.String tmpDir) Constructors a new DocumentProcessor for bursting process. |
|
DocumentProcessor(java.io.Reader xmlInputReader, java.lang.String tmpDir) Constructors a new DocumentProcessor. |
|
DocumentProcessor(java.lang.String xmlInput, java.lang.String tmpDir) Constructors a new DocumentProcessor. |
|
DocumentProcessor(java.lang.String xmlInput, java.lang.String dataInput, java.lang.String tmpDir) Constructors a new DocumentProcessor for bursting process. |
Method Summary | |
---|---|
void |
cleanup() Clean ups any temporary files explicitly. |
static void |
main(java.lang.String[] args) This DocumentProcessor can run on command mode. |
java.util.Vector |
process() Returns the generated output path list so that the client of DocumentProcessor can print them. |
void |
registerListener(BurstingListener listener) Registers the listener for bursting process. |
void |
removeListener(BurstingListener listener) Removes the listener. |
void |
setConfig(java.util.Properties configProp) Let users specify XDO properties programatically. |
void |
setConfig(java.lang.String propName, java.lang.String propValue) Please refer to setConfig(Properties prop) for more info. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String RCS_ID
public static final boolean RCS_ID_RECORDED
public static final java.lang.String ENC_USER_PW
public static final java.lang.String ENC_OWNER_PW
public static final java.lang.String ENC_LEVEL
Constructor Detail |
---|
public DocumentProcessor(java.io.InputStream xmlInputStream, java.lang.String tmpDir)
xmlInputStream
- the instruction XML InputStream.tmpDir
- the temporary directory information which has enough free space.public DocumentProcessor(java.lang.String xmlInput, java.lang.String tmpDir)
xmlInput
- the instruction XML file path.tmpDir
- the temporary directory information which has enough free space.public DocumentProcessor(java.io.Reader xmlInputReader, java.lang.String tmpDir) throws java.io.IOException
xmlInputReader
- the instruction XML Reader.tmpDir
- the temporary directory information which has enough free space.java.io.IOException
public DocumentProcessor(java.io.InputStream xmlInputStream, java.io.InputStream dataInputStream, java.lang.String tmpDir)
xmlInputStream
- the instruction XML InputStream.dataInputStream
- the XML Data InputStream.tmpDir
- the temporary directory information which has enough free space.public DocumentProcessor(java.lang.String xmlInput, java.lang.String dataInput, java.lang.String tmpDir)
xmlInput
- the instruction XML file path.dataInput
- the XML Data file path.tmpDir
- the temporary directory information which has enough free space.public DocumentProcessor(java.io.Reader xmlInputReader, java.io.Reader dataInputReader, java.lang.String tmpDir)
xmlInputReader
- the instruction XML Reader.dataInputReader
- the Data Reader.tmpDir
- the temporary directory information which has enough free space.Method Detail |
---|
public java.util.Vector process() throws java.io.IOException, java.lang.Exception
java.io.IOException
java.lang.Exception
public void cleanup()
public void setConfig(java.util.Properties configProp) throws java.lang.IllegalArgumentException
Properties prop = new Properties(); prop.put(DocumentProcessor.ENC_USER_PW, ""); prop.put(DocumentProcessor.ENC_OWNER_PW, "xxxx"); prop.put(DocumentProcessor.ENC_LEVEL, "0"); docProcessor.setConfig(prop);At least, two properties(ENC_USER_PW and ENC_OWNER_PW) must be specified to encrypt the output.
docProcessor.setConfig("user-variable.OA_HTML", "/usr/home/OA_HTML");
configProp
- the properties including security and user variables.java.lang.IllegalArgumentException
setConfig(String propName, String propValue)
public void setConfig(java.lang.String propName, java.lang.String propValue) throws java.lang.IllegalArgumentException
propName
- the XDO property keypropValue
- the proper valuejava.lang.IllegalArgumentException
setConfig(Properties configProp)
public static void main(java.lang.String[] args)
usage : java oracle.apps.xdo.batch.DocumentProcessor [-debug] -tempdir physicalPath xmlPath
usage for Bursting process : java oracle.apps.xdo.batch.DocumentProcessor [-debug] -tempdir physicalPath -datafile dataFilePath xmlPathThe "debug" parameter can be used only for debugging purpose. If the "debug" is turned on, performance will be slow down. The "tempdir" parameter should have enough free space so that DocumentProcessor can create and delete internal files.
public void registerListener(BurstingListener listener)
listener
-public void removeListener(BurstingListener listener)
listener
-
|
Oracle BI Publisher Java API Reference Release 10.1.3.4 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |