oracle.jbo.mom

Class TransferDefWriter

java.lang.Object

oracle.jbo.mom.TransferDefWriter

All Implemented Interfaces:

DefWriter

public class TransferDefWriter
extends java.lang.Object
implements DefWriter

Constructor Summary

Constructors

Constructor and Description
TransferDefWriter(PersistableDefObject def)

Method Summary

Modifier and Type	Method and Description
void	commit() This method Commits the transaction.
DifferDetails	getChildren()
DifferDetails	getContents()
java.lang.StringBuffer	getStringBuffer()
PersistableDefObject	getTargetDef()
boolean	isBufferOutput()
boolean	isJSON()
boolean	isTargetDefPDef()
boolean	isTipCustomizedAttribute(java.lang.String attrName) Indicates whether the attribute for the current element XML element was set at the tip CC layer.
boolean	isTipInserted() Indicates whether the current element XML element was inserted at the tip CC layer.
boolean	isToTransferAllChildren()
void	openConnection(java.lang.String xmlFileName, java.lang.String tagName)
void	removeAttribute(java.lang.String attrName)
boolean	removeElementByAttribute(java.lang.String elemName, java.lang.String attrName, java.lang.String attrValue)
boolean	removeElements(java.lang.String elemName)
boolean	removeObject(DefPersistable jtpObject)
void	rollback() This method rolls back the transaction.
void	setChildElementTag(java.lang.String s)
void	setToTransferAllChildren(boolean b)
boolean	write2DStringArray(java.lang.String parentAttrName, java.lang.String firstAttrName, java.lang.String secondAttrName, java.util.List<java.util.List<java.lang.String>> items) This method creates a 2D hierarchical element structure under the parent element.
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
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(DefPersistable jtpObject) This method writes a persistable object including its children to the output stream
void	writeObject(PersistentDefinition jtpObject) This method writes a persistable object including its children to the output stream
void	writeObject(PersistentDefinition jtpObject, boolean bAsChildMap) If in json, this will save the object as a map.
boolean	writeObject(java.lang.String attrName, java.lang.Object value) This method writes an attribute of type object
void	writeProcessingInstruction(java.lang.String target, java.lang.String data)
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, java.util.Enumeration en) This method writes an attribute of type String
boolean	writeStringArray(java.lang.String attrName, java.util.Iterator en) This method writes an attribute of type String
boolean	writeStringArray(java.lang.String attrName, java.lang.Object[] en) This method writes an attribute of type String
boolean	writeStringArrayElement(java.lang.String attrName, java.util.Iterator en) This method writes an attribute of type String
boolean	writeStringList(java.lang.String attrName, java.lang.String[] en) This method writes an attribute of type String For JSON, this reads a simple list of strings instead of the more complex xml element structure.
boolean	writeTable(DefPersistable jtpObject, java.lang.String attrName, java.util.HashMap value) This method writes an attribute of type ArrayList
boolean	writeTable(DefPersistable jtpObject, java.lang.String attrName, java.util.Hashtable value) This method writes an attribute of type Hashtable
boolean	writeTable(DefPersistable jtpObject, java.lang.String attrName, java.lang.String elementName, java.lang.String name, java.lang.String value, java.util.HashMap table) This method writes an attribute of type Hashtable
boolean	writeTable(DefPersistable jtpObject, java.lang.String attrName, java.lang.String elementName, java.lang.String name, java.lang.String value, java.util.HashMap table, boolean bAsChildMap) This method writes an attribute of type Hashtable
boolean	writeTable(DefPersistable jtpObject, java.lang.String attrName, java.lang.String elementName, java.lang.String name, java.lang.String value, java.util.Hashtable table) This method writes an attribute of type Hashtable
void	writeUserObject(java.lang.String elementName, java.lang.String value)
void	writeUserObject(java.lang.String ns, java.lang.String elementName, java.lang.String value)
org.w3c.dom.Element	writeUserObjectWithAttrs(java.lang.String ns, java.lang.String elementName, java.lang.String value, java.util.LinkedHashMap map)
boolean	writeUserString(java.lang.String attrName, java.lang.String value) This method writes an attribute of type String This method writes the String as it is.
boolean	writeUserStringArrayElement(java.lang.String attrName, java.lang.String elemName, java.util.Iterator value)
boolean	writeUserStringElementsMap(DefPersistable jtpObject, java.lang.String attrName, java.lang.String elemName, java.util.HashMap values)
java.lang.Object	writeVariableValues(java.lang.String elemName, java.lang.Object[] objs)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TransferDefWriter

public TransferDefWriter(PersistableDefObject def)

Method Detail

getTargetDef

public PersistableDefObject getTargetDef()

isTargetDefPDef

public boolean isTargetDefPDef()

getContents

public DifferDetails getContents()

getChildren

public DifferDetails getChildren()

setChildElementTag

public void setChildElementTag(java.lang.String s)

isToTransferAllChildren

public boolean isToTransferAllChildren()

setToTransferAllChildren

public void setToTransferAllChildren(boolean b)

commit

public void commit()
            throws DefPersistenceException

Description copied from interface: DefWriter

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 DefWriter

Throws:

DefPersistenceException

rollback

public void rollback()
              throws DefPersistenceException

Description copied from interface: DefWriter

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 DefWriter

Throws:

DefPersistenceException

isTipInserted

public boolean isTipInserted()

Description copied from interface: DefWriter

Indicates whether the current element XML element was inserted at the tip CC layer. This API is meaningful only for customization supporting backends like MDS.

Specified by:

isTipInserted in interface DefWriter

Returns:

true if this element was inserted at the tip CC layer. If the persistence backend does not support customization, it returns true as well.

isTipCustomizedAttribute

public boolean isTipCustomizedAttribute(java.lang.String attrName)

Description copied from interface: DefWriter

Indicates whether the attribute for the current element XML element was set at the tip CC layer. This API is meaningful only for customization supporting backends like MDS. Otherwise, returns false.

Specified by:

isTipCustomizedAttribute in interface DefWriter

Returns:

true if the attribute was set at the tip CC layer. If the persistence backend does not support customization, it returns true as well.

writeObject

public void writeObject(DefPersistable jtpObject)
                 throws DefPersistenceException

Description copied from interface: DefWriter

This method writes a persistable object including its children to the output stream

Specified by:

writeObject in interface DefWriter

Parameters:

jtpObject - the DefPersistable object to write

Throws:

DefPersistenceException

writeUserObject

public void writeUserObject(java.lang.String elementName,
                            java.lang.String value)
                     throws DefPersistenceException

Specified by:

writeUserObject in interface DefWriter

Throws:

DefPersistenceException

writeUserObject

public void writeUserObject(java.lang.String ns,
                            java.lang.String elementName,
                            java.lang.String value)
                     throws DefPersistenceException

Specified by:

writeUserObject in interface DefWriter

Throws:

DefPersistenceException

writeUserObjectWithAttrs

public org.w3c.dom.Element writeUserObjectWithAttrs(java.lang.String ns,
                                                    java.lang.String elementName,
                                                    java.lang.String value,
                                                    java.util.LinkedHashMap map)
                                             throws DefPersistenceException

Specified by:

writeUserObjectWithAttrs in interface DefWriter

Throws:

DefPersistenceException

writeObject

public boolean writeObject(java.lang.String attrName,
                           java.lang.Object value)

Description copied from interface: DefWriter

This method writes an attribute of type object

Specified by:

writeObject in interface DefWriter

Parameters:

attrName - the name of the Attribute to read

value - Value of the Attribute

Returns:

Retuns true if there are no erros in writing the attribute

writeTable

public boolean writeTable(DefPersistable jtpObject,
                          java.lang.String attrName,
                          java.util.HashMap value)

Description copied from interface: DefWriter

This method writes an attribute of type ArrayList

Specified by:

writeTable in interface DefWriter

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(DefPersistable jtpObject,
                          java.lang.String attrName,
                          java.util.Hashtable value)

Description copied from interface: DefWriter

This method writes an attribute of type Hashtable

Specified by:

writeTable in interface DefWriter

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(DefPersistable jtpObject,
                          java.lang.String attrName,
                          java.lang.String elementName,
                          java.lang.String name,
                          java.lang.String value,
                          java.util.HashMap table)

Description copied from interface: DefWriter

This method writes an attribute of type Hashtable

Specified by:

writeTable in interface DefWriter

Parameters:

jtpObject - the object holding this Attribute

attrName - the name of the Attribute to written

elementName - the value of the name of the attribute.

name - the value of the label of the attribute name

value - the value of the label for the attribute value

table - the value of the Attribute

Returns:

Returns true if there are no errors in writing the attribute

writeTable

public boolean writeTable(DefPersistable jtpObject,
                          java.lang.String attrName,
                          java.lang.String elementName,
                          java.lang.String name,
                          java.lang.String value,
                          java.util.HashMap table,
                          boolean bAsChildMap)

Description copied from interface: DefWriter

This method writes an attribute of type Hashtable

Specified by:

writeTable in interface DefWriter

Parameters:

jtpObject - the object holding this Attribute

attrName - the name of the Attribute to written

elementName - the value of the name of the attribute.

name - the value of the label of the attribute name

value - the value of the label for the attribute value

table - the value of the Attribute

bAsChildMap - save the object as a map, not a list

Returns:

Returns true if there are no errors in writing the attribute

writeTable

public boolean writeTable(DefPersistable jtpObject,
                          java.lang.String attrName,
                          java.lang.String elementName,
                          java.lang.String name,
                          java.lang.String value,
                          java.util.Hashtable table)

Description copied from interface: DefWriter

This method writes an attribute of type Hashtable

Specified by:

writeTable in interface DefWriter

Parameters:

jtpObject - the object holding this Attribute

attrName - the name of the Attribute to written

elementName - the value of the name of the attribute.

name - the value of the label of the attribute name

value - the value of the label for the attribute value

table - the value of the Attribute

Returns:

Returns true if there are no errors in writing the attribute

writeString

public boolean writeString(java.lang.String attrName,
                           java.lang.String value)

Description copied from interface: DefWriter

This method writes an attribute of type String

Specified by:

writeString in interface DefWriter

Parameters:

attrName - the name of the Attribute to read

value - Value of the Attribute

Returns:

Retuns true if there are no erros in writing the attribute

writeUserString

public boolean writeUserString(java.lang.String attrName,
                               java.lang.String value)

Description copied from interface: DefWriter

This method writes an attribute of type String This method writes the String as it is. The String's Formatting is retained.

Specified by:

writeUserString in interface DefWriter

Parameters:

attrName - the name of the Attribute to read

value - Value of the Attribute

Returns:

Retuns true if there are no erros in writing the attribute

writeStringArray

public boolean writeStringArray(java.lang.String attrName,
                                java.util.Iterator en)

Description copied from interface: DefWriter

This method writes an attribute of type String

Specified by:

writeStringArray in interface DefWriter

Parameters:

attrName - the name of the Attribute to read

en - Enumeration of values

Returns:

Retuns true if there are no erros in writing the attribute

writeStringArray

public boolean writeStringArray(java.lang.String attrName,
                                java.util.Enumeration en)

Description copied from interface: DefWriter

This method writes an attribute of type String

Specified by:

writeStringArray in interface DefWriter

Parameters:

attrName - the name of the Attribute to read

en - Enumeration of values

Returns:

Retuns true if there are no erros in writing the attribute

writeStringArray

public boolean writeStringArray(java.lang.String attrName,
                                java.lang.Object[] en)

Description copied from interface: DefWriter

This method writes an attribute of type String

Specified by:

writeStringArray in interface DefWriter

Parameters:

attrName - the name of the Attribute to read

en - Enumeration of values

Returns:

Retuns true if there are no erros in writing the attribute

writeStringList

public boolean writeStringList(java.lang.String attrName,
                               java.lang.String[] en)

Description copied from interface: DefWriter

This method writes an attribute of type String For JSON, this reads a simple list of strings instead of the more complex xml element structure. Used with DefElement.readStringList For XML, it defaults to writeStringArray

Specified by:

writeStringList in interface DefWriter

Parameters:

attrName - the name of the Attribute to read

en - Enumeration of values

Returns:

Retuns true if there are no erros in writing the attribute

writeInt

public boolean writeInt(java.lang.String attrName,
                        int value)

Description copied from interface: DefWriter

This method writes an attribute of type int

Specified by:

writeInt in interface DefWriter

Parameters:

attrName - the name of the Attribute to read

value - Value of the Attribute

Returns:

Retuns true if there are no erros in writing the attribute

writeShort

public boolean writeShort(java.lang.String attrName,
                          short value)

Description copied from interface: DefWriter

This method writes an attribute of type short

Specified by:

writeShort in interface DefWriter

Parameters:

attrName - the name of the Attribute to read

value - Value of the Attribute

Returns:

Retuns true if there are no erros in writing the attribute

writeLong

public boolean writeLong(java.lang.String attrName,
                         long value)

Description copied from interface: DefWriter

This method writes an attribute of type long

Specified by:

writeLong in interface DefWriter

Parameters:

attrName - the name of the Attribute to read

value - Value of the Attribute

Returns:

Retuns true if there are no erros in writing the attribute

writeFloat

public boolean writeFloat(java.lang.String attrName,
                          float value)

Description copied from interface: DefWriter

This method writes an attribute of type float

Specified by:

writeFloat in interface DefWriter

Parameters:

attrName - the name of the Attribute to read

value - Value of the Attribute

Returns:

Retuns true if there are no erros in writing the attribute

writeDouble

public boolean writeDouble(java.lang.String attrName,
                           double value)

Description copied from interface: DefWriter

This method writes an attribute of type double

Specified by:

writeDouble in interface DefWriter

Parameters:

attrName - the name of the Attribute to read

value - Value of the Attribute

Returns:

Retuns true if there are no erros in writing the attribute

writeBoolean

public boolean writeBoolean(java.lang.String attrName,
                            boolean value)

Description copied from interface: DefWriter

This method writes an attribute of type boolean

Specified by:

writeBoolean in interface DefWriter

Parameters:

attrName - the name of the Attribute to read

value - Value of the Attribute

Returns:

Retuns true if there are no erros in writing the attribute

writeByte

public boolean writeByte(java.lang.String attrName,
                         byte value)

Description copied from interface: DefWriter

This method writes an attribute of type byte

Specified by:

writeByte in interface DefWriter

Parameters:

attrName - the name of the Attribute to read

value - Value of the Attribute

Returns:

Retuns true if there are no erros in writing the attribute

writeChar

public boolean writeChar(java.lang.String attrName,
                         char value)

Description copied from interface: DefWriter

This method writes an attribute of type char

Specified by:

writeChar in interface DefWriter

Parameters:

attrName - the name of the Attribute to read

value - Value of the Attribute

Returns:

Retuns true if there are no erros in writing the attribute

writeObject

public void writeObject(PersistentDefinition jtpObject)
                 throws DefPersistenceException

Description copied from interface: DefWriter

This method writes a persistable object including its children to the output stream

Specified by:

writeObject in interface DefWriter

Parameters:

jtpObject - the PersistentDefinition object to write

Throws:

DefPersistenceException

writeObject

public void writeObject(PersistentDefinition jtpObject,
                        boolean bAsChildMap)
                 throws DefPersistenceException

Description copied from interface: DefWriter

If in json, this will save the object as a map. The default is to save is as an array of maps, fits better with xml.

Specified by:

writeObject in interface DefWriter

Parameters:

jtpObject - the DefPersistable object to write

bAsChildMap - save the object as a map, not a list

Throws:

DefPersistenceException

writeStringArrayElement

public boolean writeStringArrayElement(java.lang.String attrName,
                                       java.util.Iterator en)

Description copied from interface: DefWriter

This method writes an attribute of type String

Specified by:

writeStringArrayElement in interface DefWriter

Parameters:

attrName - the name of the Element to write

Returns:

Retuns true if there are no erros in writing the attribute

writeUserStringArrayElement

public boolean writeUserStringArrayElement(java.lang.String attrName,
                                           java.lang.String elemName,
                                           java.util.Iterator value)

Specified by:

writeUserStringArrayElement in interface DefWriter

writeUserStringElementsMap

public boolean writeUserStringElementsMap(DefPersistable jtpObject,
                                          java.lang.String attrName,
                                          java.lang.String elemName,
                                          java.util.HashMap values)

Specified by:

writeUserStringElementsMap in interface DefWriter

removeElements

public boolean removeElements(java.lang.String elemName)

Specified by:

removeElements in interface DefWriter

removeElementByAttribute

public boolean removeElementByAttribute(java.lang.String elemName,
                                        java.lang.String attrName,
                                        java.lang.String attrValue)

Specified by:

removeElementByAttribute in interface DefWriter

removeObject

public boolean removeObject(DefPersistable jtpObject)

Specified by:

removeObject in interface DefWriter

removeAttribute

public void removeAttribute(java.lang.String attrName)

Specified by:

removeAttribute in interface DefWriter

writeVariableValues

public java.lang.Object writeVariableValues(java.lang.String elemName,
                                            java.lang.Object[] objs)

Specified by:

writeVariableValues in interface DefWriter

writeComment

public void writeComment(java.lang.String comment)

Specified by:

writeComment in interface DefWriter

writeProcessingInstruction

public void writeProcessingInstruction(java.lang.String target,
                                       java.lang.String data)

Specified by:

writeProcessingInstruction in interface DefWriter

write2DStringArray

public boolean write2DStringArray(java.lang.String parentAttrName,
                                  java.lang.String firstAttrName,
                                  java.lang.String secondAttrName,
                                  java.util.List<java.util.List<java.lang.String>> items)

Description copied from interface: DefWriter

This method creates a 2D hierarchical element structure under the parent element. The structure that is created looks like: value value value value

Specified by:

write2DStringArray in interface DefWriter

Parameters:

parentAttrName - - Name of the parent element under which this 2D structure is to be built

firstAttrName - - Name of the first level element

secondAttrName - - Name of the second level element

items - - A list of list of strings which represents the 2D structure to be added

Returns:

true if reading was succesful, false otherwise

isJSON

public boolean isJSON()

Specified by:

isJSON in interface DefWriter

isBufferOutput

public boolean isBufferOutput()

Specified by:

isBufferOutput in interface DefWriter

getStringBuffer

public java.lang.StringBuffer getStringBuffer()

Specified by:

getStringBuffer in interface DefWriter

openConnection

public void openConnection(java.lang.String xmlFileName,
                           java.lang.String tagName)

Specified by:

openConnection in interface DefWriter