ADF Designtime

oracle.adf.dt.objects
Class JUDTXMLOutputStream

java.lang.Object
  extended byoracle.adf.dt.objects.JUDTXMLOutputStream
All Implemented Interfaces:
oracle.jbo.mom.xml.DefWriter

public class JUDTXMLOutputStream
extends java.lang.Object
implements oracle.jbo.mom.xml.DefWriter


Field Summary
static int AMP
           
static java.lang.String AMP_STR
           
static int APOS
           
static java.lang.String APOS_STR
           
static int GT
           
static java.lang.String GT_STR
           
static int LT
           
static java.lang.String LT_STR
           
static int MAX_CONT_STRING_SIZE
           
static int MAX_STRING_LINE
           
static java.lang.String NEW_LINE
           
static int QUOT
           
static java.lang.String QUOT_STR
           
static int SPACE_CHAR
           
static java.lang.String SPACE_STR
           
 
Constructor Summary
JUDTXMLOutputStream(oracle.jbo.mom.DefinitionManager mgr)
           
 
Method Summary
 java.lang.String breakStr(java.lang.String inStr)
          Breaks the String in to multiple lines by appending new line Characters.
protected  java.lang.String checkSpecialChar(java.lang.String value, char specialChar, java.lang.String replacement)
           
protected  java.lang.String checkSpecialChars(java.lang.String value)
           
 void closeConnection()
          Writes the internal buffers and closes the XML file.
 void commit()
          This method Commits the transaction.
protected static java.lang.String createEscapes(java.lang.String inStr, boolean userString)
           
static java.net.URL createURL(java.lang.String fileName)
          Creates the URL class for the given filename
 void epilogue(oracle.jbo.mom.xml.DefPersistable jtpObject)
          This method write the ending block for each Object.
 void epilogue(oracle.jbo.mom.xml.PersistentDefinition jtpObject)
          This method write the ending block for each Object.
 java.lang.StringBuffer getBuffer()
           
 java.lang.Object getConnection()
          Returns the the XML FileOutStream.
 java.lang.String getIanaEncoding()
           
 java.lang.String getJdkEncoding()
           
 boolean isConnectionOpen()
          Returns if a Connection is already open
 void openConnection(java.lang.String tagName)
          Opens the XML file in output mode.
 void openConnection(java.lang.String xmlFileName, java.lang.String tagName)
          Opens the XML file in output mode.
 void prologue(oracle.jbo.mom.xml.DefPersistable jtpObject)
          This method writes the starting block for each Object.
 void prologue(oracle.jbo.mom.xml.PersistentDefinition jtpObject)
          This method writes the starting block for each Object.
static java.lang.StringBuffer removeDesignTime(java.lang.StringBuffer buffer)
           
 void resetIndentation()
          Decreases the indentation by three spaces
 void rollback()
          This method rolls back the transaction.
 void saveAs(java.lang.String xmlFileName)
          Opens the XML file in output mode.
 void saveAsRunTimeXML(java.lang.String xmlFileName)
          Saves the Runtime Version of XML File Same as the Regular XML file without DesignTime section
 void saveToOutputStream(java.io.OutputStream os)
          Saves the Buffer to given OutputStream
 void saveToOutputStream(java.io.Writer os)
          Saves the Buffer to given Writer
 void setIanaEncoding(java.lang.String iana)
           
 void setIndentation()
          Increases the indentation by three spaces
 void setJdkEncoding(java.lang.String jdkEnc)
           
 char[] toCharArray()
          expose own content as a char array: this involves a complete buffer copy
 boolean writeBoolean(java.lang.String attrName, boolean value)
          This method writes an attribute of type boolean
 boolean writeByte(java.lang.String attrName, byte value)
          This method writes an attribute of type byte
 boolean writeChar(java.lang.String attrName, char value)
          This method writes an attribute of type char
 void writeComment(java.lang.String comment)
           
 boolean writeDouble(java.lang.String attrName, double value)
          This method writes an attribute of type double
 void writeFileHeader(java.lang.String tagName)
          Creates Properties XML section.
 boolean writeFloat(java.lang.String attrName, float value)
          This method writes an attribute of type float
 boolean writeInt(java.lang.String attrName, int value)
          This method writes an attribute of type int
 boolean writeLong(java.lang.String attrName, long value)
          This method writes an attribute of type long
 void writeObject(oracle.jbo.mom.xml.DefPersistable jtpObject)
           
 void writeObject(oracle.jbo.mom.xml.PersistentDefinition jtpObject)
           
 boolean writeObject(java.lang.String attrName, java.lang.Object value)
          This method writes an attribute of type object
 boolean writeShort(java.lang.String attrName, short value)
          This method writes an attribute of type short
 boolean writeString(java.lang.String attrName, java.lang.String value)
          This method writes an attribute of type String
 boolean writeStringArray(java.lang.String attrName, Iterator value)
          This method writes an attribute of type String
 boolean writeStringArrayElement(java.lang.String attrName, Iterator value)
          This method writes an attribute of type String
 boolean writeTable(oracle.jbo.mom.xml.DefPersistable jtpObject, java.lang.String attrName, HashMap value)
          This method writes an attribute of type Hashtable
 boolean writeTable(oracle.jbo.mom.xml.DefPersistable jtpObject, java.lang.String attrName, java.lang.String elemName, java.lang.String name, java.lang.String value, java.util.Hashtable ht)
           
 void writeUserObject(java.lang.String elementName, java.lang.String value)
           
 boolean writeUserString(java.lang.String attrName, java.lang.String value)
          This method writes an attribute of type String This method replaces the system characters such as '"&<> to escape sequances that XML parser understands.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface oracle.jbo.mom.xml.DefWriter
writeStringArray, writeStringArray, writeStringArrayElement, writeTable, writeTable, writeTable
 

Field Detail

NEW_LINE

public static java.lang.String NEW_LINE

LT_STR

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

GT_STR

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

AMP_STR

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

APOS_STR

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

QUOT_STR

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

SPACE_STR

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

MAX_CONT_STRING_SIZE

public static final int MAX_CONT_STRING_SIZE
See Also:
Constant Field Values

MAX_STRING_LINE

public static final int MAX_STRING_LINE
See Also:
Constant Field Values

LT

public static final int LT
See Also:
Constant Field Values

GT

public static final int GT
See Also:
Constant Field Values

AMP

public static final int AMP
See Also:
Constant Field Values

APOS

public static final int APOS
See Also:
Constant Field Values

QUOT

public static final int QUOT
See Also:
Constant Field Values

SPACE_CHAR

public static final int SPACE_CHAR
See Also:
Constant Field Values
Constructor Detail

JUDTXMLOutputStream

public JUDTXMLOutputStream(oracle.jbo.mom.DefinitionManager mgr)
Method Detail

getBuffer

public java.lang.StringBuffer getBuffer()

prologue

public void prologue(oracle.jbo.mom.xml.DefPersistable jtpObject)
This method writes the starting block for each Object.

Parameters:
jtpObject - the JT Persistable Object

prologue

public void prologue(oracle.jbo.mom.xml.PersistentDefinition jtpObject)
This method writes the starting block for each Object.

Parameters:
jtpObject - the JT Persistable Object

epilogue

public void epilogue(oracle.jbo.mom.xml.DefPersistable jtpObject)
This method write the ending block for each Object.

Parameters:
jtpObject - the JT Persistable Object

epilogue

public void epilogue(oracle.jbo.mom.xml.PersistentDefinition jtpObject)
This method write the ending block for each Object.

Parameters:
jtpObject - the JT Persistable Object

writeObject

public boolean writeObject(java.lang.String attrName,
                           java.lang.Object value)
This method writes an attribute of type object

Specified by:
writeObject in interface oracle.jbo.mom.xml.DefWriter
Parameters:
attrName - the name of the Attribute to read
value - Value of the Attribute
Returns:
Returns true if there are no erros in writing the attribute

writeTable

public boolean writeTable(oracle.jbo.mom.xml.DefPersistable jtpObject,
                          java.lang.String attrName,
                          HashMap value)
This method writes an attribute of type Hashtable

Parameters:
jtpObject - the object holding this Attribute
attrName - the name of the Attribute to written
value - the value of the Attribute
Returns:
Returns true if there are no errors in writing the attribute

writeTable

public boolean writeTable(oracle.jbo.mom.xml.DefPersistable jtpObject,
                          java.lang.String attrName,
                          java.lang.String elemName,
                          java.lang.String name,
                          java.lang.String value,
                          java.util.Hashtable ht)
Specified by:
writeTable in interface oracle.jbo.mom.xml.DefWriter

checkSpecialChars

protected java.lang.String checkSpecialChars(java.lang.String value)

checkSpecialChar

protected java.lang.String checkSpecialChar(java.lang.String value,
                                            char specialChar,
                                            java.lang.String replacement)

writeString

public boolean writeString(java.lang.String attrName,
                           java.lang.String value)
This method writes an attribute of type String

Specified by:
writeString in interface oracle.jbo.mom.xml.DefWriter
Parameters:
attrName - the name of the Attribute to read
value - Value of the Attribute
Returns:
Returns true if there are no erros in writing the attribute

writeUserString

public boolean writeUserString(java.lang.String attrName,
                               java.lang.String value)
This method writes an attribute of type String This method replaces the system characters such as '"&<> to escape sequances that XML parser understands. This method should be used in all the places where the string might contain the above characters.

Specified by:
writeUserString in interface oracle.jbo.mom.xml.DefWriter
Parameters:
attrName - the name of the Attribute to read
value - Value of the Attribute
Returns:
Returns true if there are no erros in writing the attribute

writeStringArray

public boolean writeStringArray(java.lang.String attrName,
                                Iterator value)
This method writes an attribute of type String

Parameters:
attrName - the name of the Attribute to read
value - Enumeration of values
Returns:
Returns true if there are no erros in writing the attribute

writeInt

public boolean writeInt(java.lang.String attrName,
                        int value)
This method writes an attribute of type int

Specified by:
writeInt in interface oracle.jbo.mom.xml.DefWriter
Parameters:
attrName - the name of the Attribute to read
value - Value of the Attribute
Returns:
Returns true if there are no erros in writing the attribute

writeShort

public boolean writeShort(java.lang.String attrName,
                          short value)
This method writes an attribute of type short

Specified by:
writeShort in interface oracle.jbo.mom.xml.DefWriter
Parameters:
attrName - the name of the Attribute to read
value - Value of the Attribute
Returns:
Returns true if there are no erros in writing the attribute

writeLong

public boolean writeLong(java.lang.String attrName,
                         long value)
This method writes an attribute of type long

Specified by:
writeLong in interface oracle.jbo.mom.xml.DefWriter
Parameters:
attrName - the name of the Attribute to read
value - Value of the Attribute
Returns:
Returns true if there are no erros in writing the attribute

writeFloat

public boolean writeFloat(java.lang.String attrName,
                          float value)
This method writes an attribute of type float

Specified by:
writeFloat in interface oracle.jbo.mom.xml.DefWriter
Parameters:
attrName - the name of the Attribute to read
value - Value of the Attribute
Returns:
Returns true if there are no erros in writing the attribute

writeDouble

public boolean writeDouble(java.lang.String attrName,
                           double value)
This method writes an attribute of type double

Specified by:
writeDouble in interface oracle.jbo.mom.xml.DefWriter
Parameters:
attrName - the name of the Attribute to read
value - Value of the Attribute
Returns:
Returns true if there are no erros in writing the attribute

writeBoolean

public boolean writeBoolean(java.lang.String attrName,
                            boolean value)
This method writes an attribute of type boolean

Specified by:
writeBoolean in interface oracle.jbo.mom.xml.DefWriter
Parameters:
attrName - the name of the Attribute to read
value - Value of the Attribute
Returns:
Returns true if there are no erros in writing the attribute

writeByte

public boolean writeByte(java.lang.String attrName,
                         byte value)
This method writes an attribute of type byte

Specified by:
writeByte in interface oracle.jbo.mom.xml.DefWriter
Parameters:
attrName - the name of the Attribute to read
value - Value of the Attribute
Returns:
Returns true if there are no erros in writing the attribute

writeChar

public boolean writeChar(java.lang.String attrName,
                         char value)
This method writes an attribute of type char

Specified by:
writeChar in interface oracle.jbo.mom.xml.DefWriter
Parameters:
attrName - the name of the Attribute to read
value - Value of the Attribute
Returns:
Returns true if there are no erros in writing the attribute

openConnection

public void openConnection(java.lang.String xmlFileName,
                           java.lang.String tagName)
                    throws oracle.jbo.mom.xml.DefPersistenceException
Opens the XML file in output mode. Initializes the internal buffers

Parameters:
xmlFileName - Name of the XML File.
Throws:
java.lang.Error - opening the XML file
oracle.jbo.mom.xml.DefPersistenceException

closeConnection

public void closeConnection()
                     throws oracle.jbo.mom.xml.DefPersistenceException
Writes the internal buffers and closes the XML file.

Throws:
java.lang.Error - closing the connection
oracle.jbo.mom.xml.DefPersistenceException

isConnectionOpen

public boolean isConnectionOpen()
Returns if a Connection is already open

Returns:
Returns true if the connection is opened. Otherwise returns false.

getConnection

public java.lang.Object getConnection()
Returns the the XML FileOutStream.

Returns:
Returns the XML FileOutputStream object

commit

public void commit()
            throws oracle.jbo.mom.xml.DefPersistenceException
This method Commits the transaction. In the case of XML and other file based persistent storages, this method just flushes to the file.

Specified by:
commit in interface oracle.jbo.mom.xml.DefWriter
Throws:
oracle.jbo.mom.xml.DefPersistenceException

rollback

public void rollback()
              throws oracle.jbo.mom.xml.DefPersistenceException
This method rolls back the transaction. In the case of XML and other file based persistent storages, this method just resets the buffer in the memory.

Specified by:
rollback in interface oracle.jbo.mom.xml.DefWriter
Throws:
oracle.jbo.mom.xml.DefPersistenceException

setIndentation

public void setIndentation()
Increases the indentation by three spaces


resetIndentation

public void resetIndentation()
Decreases the indentation by three spaces


writeFileHeader

public void writeFileHeader(java.lang.String tagName)
                     throws oracle.jbo.mom.xml.DefPersistenceException
Creates Properties XML section. Writes all the Property in the hashtable

Returns:
Returns false if the table parameter is not a instanceof Hahstable
Throws:
oracle.jbo.mom.xml.DefPersistenceException

writeObject

public void writeObject(oracle.jbo.mom.xml.DefPersistable jtpObject)
                 throws oracle.jbo.mom.xml.DefPersistenceException
Specified by:
writeObject in interface oracle.jbo.mom.xml.DefWriter
Throws:
oracle.jbo.mom.xml.DefPersistenceException

writeObject

public void writeObject(oracle.jbo.mom.xml.PersistentDefinition jtpObject)
                 throws oracle.jbo.mom.xml.DefPersistenceException
Specified by:
writeObject in interface oracle.jbo.mom.xml.DefWriter
Throws:
oracle.jbo.mom.xml.DefPersistenceException

writeUserObject

public void writeUserObject(java.lang.String elementName,
                            java.lang.String value)
                     throws oracle.jbo.mom.xml.DefPersistenceException
Specified by:
writeUserObject in interface oracle.jbo.mom.xml.DefWriter
Throws:
oracle.jbo.mom.xml.DefPersistenceException

writeComment

public void writeComment(java.lang.String comment)
                  throws oracle.jbo.mom.xml.DefPersistenceException
Throws:
oracle.jbo.mom.xml.DefPersistenceException

saveAs

public void saveAs(java.lang.String xmlFileName)
            throws oracle.jbo.mom.xml.DefPersistenceException
Opens the XML file in output mode. Initializes the internal buffers

Parameters:
xmlFileName - Name of the XML File.
Throws:
java.lang.Error - opening the XML file
oracle.jbo.mom.xml.DefPersistenceException

saveAsRunTimeXML

public void saveAsRunTimeXML(java.lang.String xmlFileName)
                      throws oracle.jbo.mom.xml.DefPersistenceException
Saves the Runtime Version of XML File Same as the Regular XML file without DesignTime section

Parameters:
xmlFileName - Name of the XML File.
Throws:
java.lang.Error - opening the XML file
oracle.jbo.mom.xml.DefPersistenceException

removeDesignTime

public static java.lang.StringBuffer removeDesignTime(java.lang.StringBuffer buffer)

saveToOutputStream

public void saveToOutputStream(java.io.OutputStream os)
                        throws oracle.jbo.mom.xml.DefPersistenceException
Saves the Buffer to given OutputStream

Parameters:
os - OutputStream
Throws:
java.lang.Error - opening the XML file
oracle.jbo.mom.xml.DefPersistenceException

openConnection

public void openConnection(java.lang.String tagName)
                    throws oracle.jbo.mom.xml.DefPersistenceException
Opens the XML file in output mode. Initializes the internal buffers

Throws:
java.lang.Error - opening the XML file
oracle.jbo.mom.xml.DefPersistenceException

breakStr

public java.lang.String breakStr(java.lang.String inStr)
Breaks the String in to multiple lines by appending new line Characters.

Parameters:
inStr - Input String
Returns:
Retuns the new String

createEscapes

protected static java.lang.String createEscapes(java.lang.String inStr,
                                                boolean userString)

createURL

public static java.net.URL createURL(java.lang.String fileName)
                              throws java.io.IOException
Creates the URL class for the given filename

Returns:
URL the created URL
Throws:
java.io.IOException - Can not java.io.File class

saveToOutputStream

public void saveToOutputStream(java.io.Writer os)
                        throws oracle.jbo.mom.xml.DefPersistenceException
Saves the Buffer to given Writer

Throws:
java.lang.Error
oracle.jbo.mom.xml.DefPersistenceException

getIanaEncoding

public java.lang.String getIanaEncoding()

setIanaEncoding

public void setIanaEncoding(java.lang.String iana)

getJdkEncoding

public java.lang.String getJdkEncoding()

setJdkEncoding

public void setJdkEncoding(java.lang.String jdkEnc)

toCharArray

public char[] toCharArray()
expose own content as a char array: this involves a complete buffer copy


writeStringArrayElement

public boolean writeStringArrayElement(java.lang.String attrName,
                                       Iterator value)
This method writes an attribute of type String

Parameters:
attrName - the name of the element to write
value - Enumeration of values
Returns:
Returns true if there are no erros in writing the attribute

ADF Designtime

 

Copyright © 1997, 2004, Oracle. All rights reserved.