wt.transfer.delegate
Class ContentItemDOMTreeDecoderCallback

java.lang.Object
  extended bywt.xml.io.DOMTreeDecoderCallback
      extended bywt.transfer.delegate.ContentItemDOMTreeDecoderCallback
All Implemented Interfaces:
DOMTreeStreamCallback, XMLMechanismConstants

public class ContentItemDOMTreeDecoderCallback
extends DOMTreeDecoderCallback



Supported API: false

Extendable: false


Field Summary
private  Vector ancillaryObjects
           
private static String CLASSNAME
           
private  Persistable persistableObject
           
private static String RESOURCE
           
 
Fields inherited from class wt.xml.io.DOMTreeDecoderCallback
 
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
private ContentItemDOMTreeDecoderCallback()
          No-arg constructor.
  ContentItemDOMTreeDecoderCallback(Document doc)
          

Supported API: false
 
Method Summary
private  void containerValidate(Object a_Container)
           
 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.
 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.
 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.
private  void inputStreamValidate(InputStream a_InputStream)
           
protected  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 ZipFile from which to read files referred to by ContentItems.
 void setInputStream(InputStream a_InputStream)
          Sets the value of the attribute: inputStream; The ZipInputStream from which to read files referred to by ContentItems.
 void setNextElement(Element tree)
          Gives the tree and an instance of the appropriate Persistable to the appropriate callback's setElement() method.
protected  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 wt.xml.io.DOMTreeDecoderCallback
getContainer, getDoc, getInputStream, setDoc, setElement
 
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

persistableObject

private Persistable persistableObject

ancillaryObjects

private Vector ancillaryObjects
Constructor Detail

ContentItemDOMTreeDecoderCallback

private ContentItemDOMTreeDecoderCallback()
No-arg constructor. Private so a constructor with an argument must be used.


ContentItemDOMTreeDecoderCallback

public ContentItemDOMTreeDecoderCallback(Document doc)


Supported API: false

Parameters:
doc -
Method Detail

setContainer

public void setContainer(Object a_Container)
                  throws WTPropertyVetoException
Sets the value of the attribute: container; The ZipFile from which to read files referred to by ContentItems.

Supported API: false

Overrides:
setContainer in class DOMTreeDecoderCallback
Parameters:
a_Container -
Throws:
WTPropertyVetoException

containerValidate

private void containerValidate(Object a_Container)
                        throws WTPropertyVetoException
Parameters:
a_Container -
Throws:
WTPropertyVetoException

setInputStream

public void setInputStream(InputStream a_InputStream)
                    throws WTPropertyVetoException
Sets the value of the attribute: inputStream; The ZipInputStream from which to read files referred to by ContentItems.

Supported API: false

Overrides:
setInputStream in class DOMTreeDecoderCallback
Parameters:
a_InputStream -
Throws:
WTPropertyVetoException

inputStreamValidate

private void inputStreamValidate(InputStream a_InputStream)
                          throws WTPropertyVetoException
Parameters:
a_InputStream -
Throws:
WTPropertyVetoException

initialize

public 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

Specified by:
initialize in class DOMTreeDecoderCallback
Throws:
wt.xml.XMLMechanismException
XMLMechanismException

setNextElement

public void setNextElement(Element tree)
                    throws XMLMechanismException
Gives the tree and an instance of the appropriate Persistable to the appropriate callback's setElement() method.

Supported API: false

Specified by:
setNextElement in class DOMTreeDecoderCallback
Parameters:
tree -
Throws:
wt.xml.XMLMechanismException
XMLMechanismException

getPersistableObject

public 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

Specified by:
getPersistableObject in class DOMTreeDecoderCallback
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 internalization not handled by the object's readExternal() method.

Supported API: false

Specified by:
setPersistableObject in class DOMTreeDecoderCallback
Parameters:
a_PersistableObject -

getAncillaryObjects

public 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

Specified by:
getAncillaryObjects in class DOMTreeDecoderCallback
Returns:
Vector

setAncillaryObjects

protected 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

Specified by:
setAncillaryObjects in class DOMTreeDecoderCallback
Parameters:
a_AncillaryObjects -