public interface DefWriter
NAME DefWriter.java - DESCRIPTION NOTES VERSION MODIFIED (MM/DD/YY) draju 03/04/98 - Created the initial interface.
Modifier and Type | Method and Description |
---|---|
void |
commit()
This method Commits the transaction.
|
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.
|
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 |
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
|
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 |
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) |
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) |
void commit() throws DefPersistenceException
java.lang.Error
- commiting the transactionDefPersistenceException
void rollback() throws DefPersistenceException
java.lang.Error
- Rolling back the transactionDefPersistenceException
boolean isTipInserted()
true
if this element was inserted at the tip
CC layer. If the persistence backend does not support
customization, it returns true
as well.boolean isTipCustomizedAttribute(java.lang.String attrName)
false
.true
if the attribute was set at the tip
CC layer. If the persistence backend does not support
customization, it returns true
as well.void writeObject(DefPersistable jtpObject) throws DefPersistenceException
jtpObject
- the DefPersistable object to writeDefPersistenceException
void writeUserObject(java.lang.String elementName, java.lang.String value) throws DefPersistenceException
DefPersistenceException
void writeUserObject(java.lang.String ns, java.lang.String elementName, java.lang.String value) throws DefPersistenceException
DefPersistenceException
org.w3c.dom.Element writeUserObjectWithAttrs(java.lang.String ns, java.lang.String elementName, java.lang.String value, java.util.LinkedHashMap map) throws DefPersistenceException
DefPersistenceException
boolean writeObject(java.lang.String attrName, java.lang.Object value)
attrName
- the name of the Attribute to readvalue
- Value of the Attributeboolean writeTable(DefPersistable jtpObject, java.lang.String attrName, java.util.HashMap value)
jtpObject
- the object holding this AttributeattrName
- the name of the Attribute to writtenvalue
- the value of the Attributeboolean writeTable(DefPersistable jtpObject, java.lang.String attrName, java.util.Hashtable value)
jtpObject
- the object holding this AttributeattrName
- the name of the Attribute to writtenvalue
- the value of the Attributeboolean writeTable(DefPersistable jtpObject, java.lang.String attrName, java.lang.String elementName, java.lang.String name, java.lang.String value, java.util.HashMap table)
jtpObject
- the object holding this AttributeattrName
- the name of the Attribute to writtenelementName
- the value of the name of the attribute.name
- the value of the label of the attribute namevalue
- the value of the label for the attribute valuetable
- the value of the Attributeboolean writeTable(DefPersistable jtpObject, java.lang.String attrName, java.lang.String elementName, java.lang.String name, java.lang.String value, java.util.Hashtable table)
jtpObject
- the object holding this AttributeattrName
- the name of the Attribute to writtenelementName
- the value of the name of the attribute.name
- the value of the label of the attribute namevalue
- the value of the label for the attribute valuetable
- the value of the Attributeboolean writeString(java.lang.String attrName, java.lang.String value)
attrName
- the name of the Attribute to readvalue
- Value of the Attributeboolean writeUserString(java.lang.String attrName, java.lang.String value)
attrName
- the name of the Attribute to readvalue
- Value of the Attributeboolean writeStringArray(java.lang.String attrName, java.util.Iterator en)
attrName
- the name of the Attribute to readen
- Enumeration of valuesboolean writeStringArray(java.lang.String attrName, java.util.Enumeration en)
attrName
- the name of the Attribute to readen
- Enumeration of valuesboolean writeStringArray(java.lang.String attrName, java.lang.Object[] en)
attrName
- the name of the Attribute to readen
- Enumeration of valuesboolean writeInt(java.lang.String attrName, int value)
attrName
- the name of the Attribute to readvalue
- Value of the Attributeboolean writeShort(java.lang.String attrName, short value)
attrName
- the name of the Attribute to readvalue
- Value of the Attributeboolean writeLong(java.lang.String attrName, long value)
attrName
- the name of the Attribute to readvalue
- Value of the Attributeboolean writeFloat(java.lang.String attrName, float value)
attrName
- the name of the Attribute to readvalue
- Value of the Attributeboolean writeDouble(java.lang.String attrName, double value)
attrName
- the name of the Attribute to readvalue
- Value of the Attributeboolean writeBoolean(java.lang.String attrName, boolean value)
attrName
- the name of the Attribute to readvalue
- Value of the Attributeboolean writeByte(java.lang.String attrName, byte value)
attrName
- the name of the Attribute to readvalue
- Value of the Attributeboolean writeChar(java.lang.String attrName, char value)
attrName
- the name of the Attribute to readvalue
- Value of the Attributevoid writeObject(PersistentDefinition jtpObject) throws DefPersistenceException
jtpObject
- the PersistentDefinition object to writeDefPersistenceException
boolean writeStringArrayElement(java.lang.String attrName, java.util.Iterator en)
attrName
- the name of the Element to writeboolean 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)
boolean removeElements(java.lang.String elemName)
boolean removeElementByAttribute(java.lang.String elemName, java.lang.String attrName, java.lang.String attrValue)
boolean removeObject(DefPersistable jtpObject)
void removeAttribute(java.lang.String attrName)
java.lang.Object writeVariableValues(java.lang.String elemName, java.lang.Object[] objs)
void writeComment(java.lang.String comment)
void writeProcessingInstruction(java.lang.String target, java.lang.String data)
boolean write2DStringArray(java.lang.String parentAttrName, java.lang.String firstAttrName, java.lang.String secondAttrName, java.util.List<java.util.List<java.lang.String>> items)
parentAttrName
- - Name of the parent element under which this 2D structure is to be builtfirstAttrName
- - Name of the first level elementsecondAttrName
- - Name of the second level elementitems
- - A list of list of strings which represents the 2D structure to be added