oracle.jbo.mom.xml
Interface DefWriter

All Known Implementing Classes:

ElementDefWriter, XMLOutputStream

public interface DefWriter

 NAME
      DefWriter.java -
 DESCRIPTION

 NOTES

 VERSION
 MODIFIED   (MM/DD/YY)
      draju     03/04/98 -  Created the initial interface.
 

Method Summary

void	commit() This method Commits the transaction.
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.
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
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
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, 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	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.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)
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)

Method Detail

commit

void commit()
            throws DefPersistenceException

This method Commits the transaction. In the case of XML and other file based persistent storages, this method just flushes to the file.

Throws:

java.lang.Error - commiting the transaction

DefPersistenceException

rollback

void rollback()
              throws 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.

Throws:

java.lang.Error - Rolling back the transaction

DefPersistenceException

writeObject

void writeObject(DefPersistable jtpObject)
                 throws DefPersistenceException

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

Parameters:

jtpObject - the DefPersistable object to write

Throws:

DefPersistenceException

writeUserObject

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

Throws:

DefPersistenceException

writeUserObject

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

Throws:

DefPersistenceException

writeUserObjectWithAttrs

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

Throws:

DefPersistenceException

writeObject

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

This method writes an attribute of type object

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

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

This method writes an attribute of type ArrayList

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

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

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

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

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

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

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

This method writes an attribute of type String

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

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. The String's Formatting is retained.

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

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

This method writes an attribute of type String

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

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

This method writes an attribute of type String

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

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

This method writes an attribute of type String

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

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

This method writes an attribute of type int

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

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

This method writes an attribute of type short

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

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

This method writes an attribute of type long

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

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

This method writes an attribute of type float

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

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

This method writes an attribute of type double

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

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

This method writes an attribute of type boolean

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

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

This method writes an attribute of type byte

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

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

This method writes an attribute of type char

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

void writeObject(PersistentDefinition jtpObject)
                 throws DefPersistenceException

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

Parameters:

jtpObject - the PersistentDefinition object to write

Throws:

DefPersistenceException

writeStringArrayElement

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

This method writes an attribute of type String

Parameters:

attrName - the name of the Element to write

Returns:

Retuns true if there are no erros in writing the attribute

writeUserStringArrayElement

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

writeUserStringElementsMap

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

removeElements

boolean removeElements(java.lang.String elemName)

removeElementByAttribute

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

removeObject

boolean removeObject(DefPersistable jtpObject)

removeAttribute

void removeAttribute(java.lang.String attrName)

writeVariableValues

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