wt.xml.io
Class CompositeDOMTreeEncoderCallback

java.lang.Object
  wt.xml.io.DOMTreeEncoderCallback
      wt.xml.io.CompositeDOMTreeEncoderCallback

All Implemented Interfaces:

DOMTreeStreamCallback, XMLMechanismConstants

public class CompositeDOMTreeEncoderCallback

extends DOMTreeEncoderCallback

Supported API: false

Extendable: false

Field Summary

private Enumeration	callbacks
private static String	CLASSNAME
private DOMTreeEncoderCallback	currentCallback
private Persistable	persistableObject
private static String	RESOURCE
private Vector	theDOMTreeEncoderCallbacks

Fields inherited from class wt.xml.io.DOMTreeEncoderCallback

Fields inherited from interface wt.util.xml.XMLMechanismConstants

ATTLIST_ATTRIBUTE_NAME, ATTLIST_CLASS_NAME, ATTLIST_ENCODING_TYPE, ATTLIST_OID, DEFAULT_XML_PARSER_IMPLEMENTATION, DOCUMENT_ELEMENT_NAME, SELF_DESCRIBING_XML, XML_FILE_EXT

Constructor Summary

CompositeDOMTreeEncoderCallback()
Initializes theDOMTreeEncoderCallbacks as a new empty Vector.

CompositeDOMTreeEncoderCallback(DOMTreeEncoderCallback theDOMTreeEncoderCallback)
Initializes theDOMTreeEncoderCallbacks as a new Vector with the argument as the first element.

Method Summary

void	addDOMTreeEncoderCallback(DOMTreeEncoderCallback theDOMTreeEncoderCallback) Supported API: false
protected Enumeration	getCallbacks() Gets the value of the attribute: callbacks; An enumeration of the Vector theDOMTreeEncoderCallbacks.
protected DOMTreeEncoderCallback	getCurrentCallback() Gets the value of the attribute: currentCallback; A placeholder to keep track of the current DOMTreeEncoderCallback object to be used by the getNextElement() method of this class, so that state can be kept between subsequent calls of getNextElement().
protected Vector	getDOMTreeEncoderCallbacks() Gets the object for the association that plays role: theDOMTreeEncoderCallbacks.
Element	getNextElement() Gets the next tree returned by the appropriate callback's getElement() method.
Persistable	getPersistableObject() Gets the value of the attribute: persistableObject; The object to be examined by the callback for additional externalization not handled by the object's writeExternal() method.
Vector	getZipEntryVector() Gets the zipEntryVector for this object, which is the Vector composed of all the unique elements from all the zipEntryVectors of all the DOMTreeEncoderCallback objects in the Vector theDOMTreeEncoderCallbacks.
void	initialize(Persistable persistableObject) Sets the object to be examined by the callback for additional exernalization not handled by the object's writeExternal() method, and does some internal bookkeeping to prepare the callback to have its getNextElement() method invoked.
protected void	setCallbacks(Enumeration a_Callbacks) Sets the value of the attribute: callbacks; An enumeration of the Vector theDOMTreeEncoderCallbacks.
protected void	setCurrentCallback(DOMTreeEncoderCallback a_CurrentCallback) Sets the value of the attribute: currentCallback; A placeholder to keep track of the current DOMTreeEncoderCallback object to be used by the getNextElement() method of this class, so that state can be kept between subsequent calls of getNextElement().
protected void	setDOMTreeEncoderCallbacks(Vector a_DOMTreeEncoderCallbacks) Sets the object for the association that plays role: theDOMTreeEncoderCallbacks.
void	setOutputStream(OutputStream os) Sets the outputStream for this object, and all callbacks in the Vector theDOMTreeEncoderCallbacks.
protected void	setPersistableObject(Persistable a_PersistableObject) Sets the value of the attribute: persistableObject; The object to be examined by the callback for additional externalization not handled by the object's writeExternal() method.
void	setZipEntryVector(Vector zev) Sets the zipEntryVector for this object, and for all DOMTreeEncoderCallback objects in the Vector theDOMTreeEncoderCallbacks.

Methods inherited from class wt.xml.io.DOMTreeEncoderCallback

getDoc, getElement, getOutputStream, setDoc

Methods inherited from class java.lang.Object

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

Field Detail

RESOURCE

private static final String RESOURCE

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

callbacks

private Enumeration callbacks

currentCallback

private DOMTreeEncoderCallback currentCallback

theDOMTreeEncoderCallbacks

private Vector theDOMTreeEncoderCallbacks

persistableObject

private Persistable persistableObject

Constructor Detail

CompositeDOMTreeEncoderCallback

public CompositeDOMTreeEncoderCallback()

Initializes theDOMTreeEncoderCallbacks as a new empty Vector.

Supported API: false

CompositeDOMTreeEncoderCallback

public CompositeDOMTreeEncoderCallback(DOMTreeEncoderCallback theDOMTreeEncoderCallback)

Initializes theDOMTreeEncoderCallbacks as a new Vector with the argument as the first element.

Supported API: false

Parameters:

theDOMTreeEncoderCallback -

Method Detail

getCallbacks

protected Enumeration getCallbacks()

Gets the value of the attribute: callbacks; An enumeration of the Vector theDOMTreeEncoderCallbacks. This Enumeration is for the use of the getNextElement() method of this class, so that state can be kept between subsequent calls of getNextElement(). This Enumeration is recreated at each call of this class's constructors, when addDOMTreeEncoderCallback() is called, and each time setDOMTreeEncoderCallbacks() is called.

Supported API: false

Returns:

Enumeration

setCallbacks

protected void setCallbacks(Enumeration a_Callbacks)

Sets the value of the attribute: callbacks; An enumeration of the Vector theDOMTreeEncoderCallbacks. This Enumeration is for the use of the getNextElement() method of this class, so that state can be kept between subsequent calls of getNextElement(). This Enumeration is recreated at each call of this class's constructors, when addDOMTreeEncoderCallback() is called, and each time setDOMTreeEncoderCallbacks() is called.

Supported API: false

Parameters:

a_Callbacks -

getCurrentCallback

protected DOMTreeEncoderCallback getCurrentCallback()

Gets the value of the attribute: currentCallback; A placeholder to keep track of the current DOMTreeEncoderCallback object to be used by the getNextElement() method of this class, so that state can be kept between subsequent calls of getNextElement().

Supported API: false

Returns:

DOMTreeEncoderCallback

setCurrentCallback

protected void setCurrentCallback(DOMTreeEncoderCallback a_CurrentCallback)

Sets the value of the attribute: currentCallback; A placeholder to keep track of the current DOMTreeEncoderCallback object to be used by the getNextElement() method of this class, so that state can be kept between subsequent calls of getNextElement().

Supported API: false

Parameters:

a_CurrentCallback -

getDOMTreeEncoderCallbacks

protected Vector getDOMTreeEncoderCallbacks()

Gets the object for the association that plays role: theDOMTreeEncoderCallbacks.

Supported API: false

Returns:

Vector

setDOMTreeEncoderCallbacks

protected void setDOMTreeEncoderCallbacks(Vector a_DOMTreeEncoderCallbacks)

Sets the object for the association that plays role: theDOMTreeEncoderCallbacks.

Supported API: false

Parameters:

a_DOMTreeEncoderCallbacks -

addDOMTreeEncoderCallback

public void addDOMTreeEncoderCallback(DOMTreeEncoderCallback theDOMTreeEncoderCallback)

Supported API: false

Parameters:

theDOMTreeEncoderCallback -

initialize

public void initialize(Persistable persistableObject)
                throws XMLMechanismException

Sets the object to be examined by the callback for additional exernalization not handled by the object's writeExternal() method, and does some internal bookkeeping to prepare the callback to have its getNextElement() method invoked. This method should be called once per persistableObject before each set of getNextElement() calls.

Supported API: false

Specified by:

initialize in class DOMTreeEncoderCallback

Parameters:

persistableObject -

Throws:

XMLMechanismException

getNextElement

public Element getNextElement()
                       throws XMLMechanismException

Gets the next tree returned by the appropriate callback's getElement() method.

Supported API: false

Specified by:

getNextElement in class DOMTreeEncoderCallback

Returns:

Element

Throws:

XMLMechanismException

setOutputStream

public void setOutputStream(OutputStream os)
                     throws WTPropertyVetoException

Sets the outputStream for this object, and all callbacks in the Vector theDOMTreeEncoderCallbacks.

Supported API: false

Overrides:

setOutputStream in class DOMTreeEncoderCallback

Parameters:

os -

Throws:

WTPropertyVetoException

getZipEntryVector

public Vector getZipEntryVector()

Gets the zipEntryVector for this object, which is the Vector composed of all the unique elements from all the zipEntryVectors of all the DOMTreeEncoderCallback objects in the Vector theDOMTreeEncoderCallbacks.

Supported API: false

Overrides:

getZipEntryVector in class DOMTreeEncoderCallback

Returns:

Vector

setZipEntryVector

public void setZipEntryVector(Vector zev)

Sets the zipEntryVector for this object, and for all DOMTreeEncoderCallback objects in the Vector theDOMTreeEncoderCallbacks.

Supported API: false

Overrides:

setZipEntryVector in class DOMTreeEncoderCallback

Parameters:

zev -

getPersistableObject

public Persistable getPersistableObject()

Gets the value of the attribute: persistableObject; The object to be examined by the callback for additional externalization not handled by the object's writeExternal() method.

Supported API: false

Specified by:

getPersistableObject in class DOMTreeEncoderCallback

Returns:

Persistable

setPersistableObject

protected void setPersistableObject(Persistable a_PersistableObject)

Sets the value of the attribute: persistableObject; The object to be examined by the callback for additional externalization not handled by the object's writeExternal() method.

Supported API: false

Specified by:

setPersistableObject in class DOMTreeEncoderCallback

Parameters:

a_PersistableObject -