wt.xml.io
Class DOMTreeDecoderCallback

java.lang.Object
  wt.xml.io.DOMTreeDecoderCallback

All Implemented Interfaces:

DOMTreeStreamCallback, XMLMechanismConstants

Direct Known Subclasses:

CompositeDOMTreeDecoderCallback, ContentItemDOMTreeDecoderCallback, IBADOMTreeDecoderCallback

public abstract class DOMTreeDecoderCallback

extends Object

implements DOMTreeStreamCallback

Abstract class for callbacks which may be given to a DOMTreeDecoder in order to provide a way to handle data in the DOM tree which isn't internalized via the imported objects' readExternal call stack but is still integral to these imported objects. This data should have been created by an appropriate DOMTreeDecoderCallback instance.

Supported API: false

Extendable: false

Field Summary

private static String	CLASSNAME
private Object	container
private Document	doc
private InputStream	inputStream
private static String	RESOURCE

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

DOMTreeDecoderCallback()

Method Summary

abstract Vector	getAncillaryObjects() Gets the value of the attribute: ancillaryObjects; A vector of objects, or references to objects, to be used by the creator of the callback object to get objects or references to objects created by the callback object as part of its handling of DOM Elements.
Object	getContainer() Gets the value of the attribute: container; The Object from which any necessary data not in the DOM tree given to the callback is read.
Document	getDoc() Gets the value of the attribute: doc; The DOM Document needed for creating new Elements, etc.
InputStream	getInputStream() Gets the value of the attribute: inputStream; The InputStream from which any necessary data not in the DOM tree given to the callback is read.
abstract Persistable	getPersistableObject() Gets the value of the attribute: persistableObject; The object to be examined by the callback for additional internalization not handled by the object's readExternal() method.
abstract void	initialize() Sets the object to be examined by the callback for additional internalization not handled by the object's readExternal() method, and may do some internal bookkeeping to allow the callback to handle things like linking other objects to the main persistable object, etc.
protected abstract void	setAncillaryObjects(Vector a_AncillaryObjects) Sets the value of the attribute: ancillaryObjects; A vector of objects, or references to objects, to be used by the creator of the callback object to get objects or references to objects created by the callback object as part of its handling of DOM Elements.
void	setContainer(Object a_Container) Sets the value of the attribute: container; The Object from which any necessary data not in the DOM tree given to the callback is read.
void	setDoc(Document a_Doc) Sets the value of the attribute: doc; The DOM Document needed for creating new Elements, etc.
protected void	setElement(Persistable obj, Element tree) Gets a new DOMTreeDecoder, gives it the tree, and passes it to the readExternal() method of the Persistable argument.
void	setInputStream(InputStream a_InputStream) Sets the value of the attribute: inputStream; The InputStream from which any necessary data not in the DOM tree given to the callback is read.
abstract void	setNextElement(Element tree) Gives the tree and an instance of the Persistable to be created from the tree to the appropriate setElement() method.
protected abstract void	setPersistableObject(Persistable a_PersistableObject) Sets the value of the attribute: persistableObject; The object to be examined by the callback for additional internalization not handled by the object's readExternal() method.

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

container

private Object container

inputStream

private InputStream inputStream

doc

private Document doc

Constructor Detail

DOMTreeDecoderCallback

public DOMTreeDecoderCallback()

Method Detail

getContainer

public Object getContainer()

Gets the value of the attribute: container; The Object from which any necessary data not in the DOM tree given to the callback is read.

Supported API: false

Returns:

Object

setContainer

public void setContainer(Object a_Container)
                  throws WTPropertyVetoException

Sets the value of the attribute: container; The Object from which any necessary data not in the DOM tree given to the callback is read.

Supported API: false

Parameters:

a_Container -

Throws:

WTPropertyVetoException

getInputStream

public InputStream getInputStream()

Gets the value of the attribute: inputStream; The InputStream from which any necessary data not in the DOM tree given to the callback is read.

Supported API: false

Returns:

InputStream

setInputStream

public void setInputStream(InputStream a_InputStream)
                    throws WTPropertyVetoException

Sets the value of the attribute: inputStream; The InputStream from which any necessary data not in the DOM tree given to the callback is read.

Supported API: false

Parameters:

a_InputStream -

Throws:

WTPropertyVetoException

getPersistableObject

public abstract Persistable getPersistableObject()

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

Supported API: false

Returns:

Persistable

setPersistableObject

protected abstract void setPersistableObject(Persistable a_PersistableObject)

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

Supported API: false

Parameters:

a_PersistableObject -

getAncillaryObjects

public abstract Vector getAncillaryObjects()

Gets the value of the attribute: ancillaryObjects; A vector of objects, or references to objects, to be used by the creator of the callback object to get objects or references to objects created by the callback object as part of its handling of DOM Elements.

Supported API: false

Returns:

Vector

setAncillaryObjects

protected abstract void setAncillaryObjects(Vector a_AncillaryObjects)

Sets the value of the attribute: ancillaryObjects; A vector of objects, or references to objects, to be used by the creator of the callback object to get objects or references to objects created by the callback object as part of its handling of DOM Elements.

Supported API: false

Parameters:

a_AncillaryObjects -

initialize

public abstract void initialize()
                         throws XMLMechanismException

Sets the object to be examined by the callback for additional internalization not handled by the object's readExternal() method, and may do some internal bookkeeping to allow the callback to handle things like linking other objects to the main persistable object, etc. This method should be called once per persistableObject being imported.

Supported API: false

Throws:

XMLMechanismException

setElement

protected void setElement(Persistable obj,
                          Element tree)
                   throws XMLMechanismException

Gets a new DOMTreeDecoder, gives it the tree, and passes it to the readExternal() method of the Persistable argument.

Supported API: false

Parameters:

obj - The Persistable to be externalized as a part of the externalization process of the DOMTreeEncoder using this callback object.

tree -

Throws:

XMLMechanismException

setNextElement

public abstract void setNextElement(Element tree)
                             throws XMLMechanismException

Gives the tree and an instance of the Persistable to be created from the tree to the appropriate setElement() method.

Supported API: false

Parameters:

tree -

Throws:

XMLMechanismException

getDoc

public Document getDoc()

Gets the value of the attribute: doc; The DOM Document needed for creating new Elements, etc.

Supported API: false

Specified by:

getDoc in interface DOMTreeStreamCallback

Returns:

Document

setDoc

public void setDoc(Document a_Doc)

Sets the value of the attribute: doc; The DOM Document needed for creating new Elements, etc.

Supported API: false

Specified by:

setDoc in interface DOMTreeStreamCallback

Parameters:

a_Doc -