Oracle Fusion Middleware extensions for Seed Data Framework
11g Release 1 (11.1.2)

E22564-02

oracle.apps.fnd.applseed.rt.extract.util.xml
Class SDExtractXml

java.lang.Object
  extended by oracle.apps.fnd.applseed.rt.extract.util.xml.SDExtractXml

public class SDExtractXml
extends java.lang.Object

Singleton class handles XML write functions for Seed Data Extract. Class initiated once. Processing createExtractDoc(ExtractFile) - start a new document for named ExtractFile newViewRow(node, row) - start a new row for node writeRowAttributes(row, attributes) - write the attribute values writeReference(name, value) - write the reference key name value endViewRow(node) - end the node row endExtractDoc() - ends the document created If model contains any translatable views, Xliff files will be generated for each user selected language, with minimum for base US.


Constructor Summary
SDExtractXml()
          Constructor.
 
Method Summary
 void abort(java.lang.String msg)
          Abort this extract run, for critical errors.
 void addAdXmlCommentsAndUpdateRowCount(int rowcount)
          Create the adxml comment and append it to the extract xml file.
 void createExtractDoc(ExtractFile extractFileP)
          Start a new document for named ExtractFile.
 void endExtractDoc(int rowcount)
          End the document for current ExtractFile.
 void endViewRow(SDViewNode node, oracle.jbo.Row row)
          End the named view row.
 ExtractFile getCurrentExtractFile()
           
static SDExtractXml getInstance()
          Get the singleton SDExtractXml instance.
 boolean isDEbegin()
          Return true when currently processing Date Effective begin row.
 void newViewRow(SDViewNode parentNode, SDViewNode extensionNode, oracle.jbo.Row row)
          Add a new row for named node.
 void writeExternalReference(java.lang.String productCode, java.lang.String location, java.lang.String fileName)
           
 void writeReference(java.lang.String name, java.lang.String value)
          Write an external Reference to Base xml.
 int writeRowAttributes(oracle.jbo.Row row, SDExtractViewNode node)
          Write the row attribute values to base and xlf.
 void writeRowKeys(SDExtractViewNode node, oracle.jbo.Row row)
          Write only the row keys as attributes of the current node.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SDExtractXml

public SDExtractXml()
Constructor.

Method Detail

getInstance

public static SDExtractXml getInstance()
Get the singleton SDExtractXml instance.

Returns:
SDExtactXml

createExtractDoc

public void createExtractDoc(ExtractFile extractFileP)
                      throws ExtractException
Start a new document for named ExtractFile.

Parameters:
extractFileP - ExtractFile to create
Throws:
ExtractException - failure to start document

newViewRow

public void newViewRow(SDViewNode parentNode,
                       SDViewNode extensionNode,
                       oracle.jbo.Row row)
                throws ExtractXmlSerializeException,
                       ExtractException
Add a new row for named node. Adds to base xml and any xlif for all langs.

Parameters:
parentNode - SDViewNode parent starting node
extensionNode - SDViewNode any polymorphic extension node, same as parentNode if none
row - Row
Throws:
ExtractXmlSerializeException
ExtractException

isDEbegin

public boolean isDEbegin()
Return true when currently processing Date Effective begin row.

Returns:
True when last row processed was DE begin row.

writeRowAttributes

public int writeRowAttributes(oracle.jbo.Row row,
                              SDExtractViewNode node)
                       throws ExtractXmlSerializeException
Write the row attribute values to base and xlf.

Parameters:
row - Row
node - SDExtractViewNode node containing attrs to write
Returns:
int number of attributes written
Throws:
ExtractXmlSerializeException

writeRowKeys

public void writeRowKeys(SDExtractViewNode node,
                         oracle.jbo.Row row)
                  throws ExtractException
Write only the row keys as attributes of the current node. Special case method to handle writing only key values.

Parameters:
node - SDExtractViewNode node
row - Row containing key values
Throws:
ExtractException

writeReference

public void writeReference(java.lang.String name,
                           java.lang.String value)
                    throws ExtractXmlSerializeException
Write an external Reference to Base xml.

Parameters:
name - String ref key name
value - String ref key value
Throws:
ExtractXmlSerializeException

writeExternalReference

public void writeExternalReference(java.lang.String productCode,
                                   java.lang.String location,
                                   java.lang.String fileName)

endViewRow

public void endViewRow(SDViewNode node,
                       oracle.jbo.Row row)
                throws ExtractXmlSerializeException
End the named view row.

Parameters:
node - SDViewNode node to end
row - Row not currently used
Throws:
ExtractXmlSerializeException

abort

public void abort(java.lang.String msg)
           throws ExtractXmlSerializeException
Abort this extract run, for critical errors.

Parameters:
msg - String any fail message to add to writer, null if none
Throws:
ExtractXmlSerializeException

endExtractDoc

public void endExtractDoc(int rowcount)
                   throws ExtractXmlSerializeException
End the document for current ExtractFile.

Throws:
ExtractXmlSerializeException

getCurrentExtractFile

public ExtractFile getCurrentExtractFile()

addAdXmlCommentsAndUpdateRowCount

public void addAdXmlCommentsAndUpdateRowCount(int rowcount)
                                       throws ExtractXmlSerializeException
Create the adxml comment and append it to the extract xml file.

Throws:
ExtractXmlSerializeException

Oracle Fusion Middleware extensions for Seed Data Framework
11g Release 1 (11.1.2)

E22564-02

Copyright © 2011 Oracle. All Rights Reserved.