com.softwareag.tamino.db.api.objectModel.dom
Class TDOMAdapter

java.lang.Object
  extended by com.softwareag.tamino.db.api.objectModel.TDataObject
      extended by com.softwareag.tamino.db.api.objectModel.TXMLObject
          extended by com.softwareag.tamino.db.api.objectModel.dom.TDOMAdapter
All Implemented Interfaces:
TStreamable, TXMLStreamable, java.io.Serializable

public class TDOMAdapter
extends TXMLObject
implements java.io.Serializable

DOMAdapter is the adaption of the DOM object model to the TXMLObject class. It extends the TXMLObject class. XML data is internally represented by the DOM implementation. XML data is always given by DOM Element instances.

Version:
$Revision: 1.34 $
Author:
Marcus Schreyer
See Also:
Serialized Form

Constructor Summary
TDOMAdapter()
          Default Constructor.
TDOMAdapter(org.w3c.dom.Document document)
          Special Constructor.
TDOMAdapter(org.w3c.dom.Element element)
          Special Constructor.
 
Method Summary
protected  boolean canWriteToOutputStream()
          Indicates if this instance can be currently written to an output stream.
 java.lang.String getDocname()
          Gets the ino:docname from this Tamino data object.
 java.lang.String getDoctype()
          Gets the doctype for this Tamino data object.
 java.lang.Object getDocument()
          Gets the document instance of the underlying object model.
 java.lang.Object getElement()
          Gets element instance of the underlying object model.
 java.lang.String getId()
          Gets the ino:id attribute for the underlying XML data.
protected  void readDocumentStateFrom(java.io.ObjectInputStream in)
          This abstract method serves as a plugin method for readStateFrom.
 void readFrom(java.io.InputStream inputStream)
          Reads data from inputStream and initializes the concrete object.
 void readFrom(java.io.InputStream inputStream, java.lang.String systemId)
          Reads data from inputStream and initializes the concrete object.
 void readFrom(java.io.Reader reader)
          Reads data from reader and initializes the concrete object.
 void readFrom(java.io.Reader reader, java.lang.String systemId)
          Reads data from reader and initializes the concrete object.
 void setDocname(java.lang.String docname)
          Sets the ino:docname on this DOM specific TXMLObject.
 void setId(java.lang.String id)
          Sets the ino:id for the XML instance.
protected  void writeDocumentStateTo(java.io.ObjectOutputStream out)
          This abstract method serves as a plugin method for writeStateTo.
 void writeTo(java.io.OutputStream outputStream, java.lang.String encoding)
          Writes the XML data to the given outputStream using the given encoding.
 void writeTo(java.io.Writer writer, java.lang.String encoding)
          Writes the XML data to the given writer using the given encoding.
 
Methods inherited from class com.softwareag.tamino.db.api.objectModel.TXMLObject
getEncoding, getSystemId, newInstance, newInstance, newInstance, newInstance, newInstance, newInstance, newInstance, newInstance, newInstance, newInstance, newInstance, newInstance, newInstance, newInstance, newInstance, newInstance, newInstance, newInstance, newInstance, newInstance, newInstance, newInstance, newInstance, newInstance, setContentType, setEncoding, setProperty, setSystemId, writeTo, writeTo
 
Methods inherited from class com.softwareag.tamino.db.api.objectModel.TDataObject
getCollection, getContentType, getLastModified, getLocale, hasCollection, hasDocname, hasDoctype, hasId, readStateFrom, setCollection, setDoctype, setLastModified, setLocale, writeStateTo
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.softwareag.tamino.db.api.io.TStreamable
getContentType
 

Constructor Detail

TDOMAdapter

public TDOMAdapter()
Default Constructor. Initializes the adapter with no content.


TDOMAdapter

public TDOMAdapter(org.w3c.dom.Document document)
Special Constructor. Initializes the adapter with the given document.


TDOMAdapter

public TDOMAdapter(org.w3c.dom.Element element)
Special Constructor. Initializes the adapter with the given element, collection and schema.

Method Detail

setDocname

public void setDocname(java.lang.String docname)
Sets the ino:docname on this DOM specific TXMLObject.

Overrides:
setDocname in class TXMLObject
Parameters:
docname - is the ino:docname attribute of the data object.

setId

public void setId(java.lang.String id)
Sets the ino:id for the XML instance.

Overrides:
setId in class TXMLObject
Parameters:
id - the ino:id attribute. If null or an empty String, the ino:id attribute is completely removed from the underlying XML document, e.g. in case of a DOM object model, the Node representing the ino:id attribute is removed from the DOM tree.

getDocname

public java.lang.String getDocname()
Gets the ino:docname from this Tamino data object.

Overrides:
getDocname in class TXMLObject
Returns:
the ino:docname attribute if available, otherwise an empty string.

getId

public java.lang.String getId()
Gets the ino:id attribute for the underlying XML data.

Overrides:
getId in class TXMLObject
Returns:
the ino:id attribute if available, otherwise an empty string.

getDoctype

public java.lang.String getDoctype()
Gets the doctype for this Tamino data object. If the doctype has not been explicitly set the name of the root element is assumed as the doctype.

Overrides:
getDoctype in class TDataObject
Returns:
the name of the doctype of this TDataObject instance.

getDocument

public java.lang.Object getDocument()
Gets the document instance of the underlying object model. If there is none null is handed back. E.g. if currently DOM is in use an org.w3c.dom.Document instance is handed back, for JDOM this would be an org.jdom.Document instance.

Specified by:
getDocument in class TXMLObject
Returns:
The document instance of the underlying object model (E.g. org.w3c.dom.Document for DOM, org.jdom.Document for JDOM). If this element is not given due to the fact that the TXMLObject has been instantiated solely with an input stream null is handed back.

getElement

public java.lang.Object getElement()
Gets element instance of the underlying object model. If there is none null is handed back. E.g. if currently DOM is in use an org.w3c.dom.Element instance is handed back, for JDOM this would be an org.jdom.Element instance.

Specified by:
getElement in class TXMLObject
Returns:
The element instance of the underlying object model (E.g. org.w3c.dom.Element for DOM, org.jdom.Element for JDOM). If this element is not given due to the fact that the TXMLObject has been instantiated solely with an input stream null is handed back.

readFrom

public void readFrom(java.io.InputStream inputStream)
              throws TStreamReadException
Reads data from inputStream and initializes the concrete object. If exception occurs due to problems of XML parsing the instance remains in its current state.

Specified by:
readFrom in interface TStreamable
Parameters:
inputStream - denotes the byte stream from which the object is newly initialized.
Throws:
TStreamReadException - due to any problems when reading the stream.

readFrom

public void readFrom(java.io.InputStream inputStream,
                     java.lang.String systemId)
              throws TStreamReadException
Reads data from inputStream and initializes the concrete object. If exception occurs due to problems of XML parsing the instance remains in its current state.

Specified by:
readFrom in interface TXMLStreamable
Parameters:
inputStream - denotes the byte stream from which the object is newly initialized.
systemId - the base URI of the data to resolve relative references.
Throws:
TStreamReadException - due to any problems when reading the stream.

readFrom

public void readFrom(java.io.Reader reader)
              throws TStreamReadException
Reads data from reader and initializes the concrete object. If exception occurs due to problems of XML parsing the instance remains in its current state.

Specified by:
readFrom in interface TStreamable
Parameters:
reader - denotes the character stream from which the object is newly initialized.
Throws:
TStreamReadException - due to any problems when reading the stream.

readFrom

public void readFrom(java.io.Reader reader,
                     java.lang.String systemId)
              throws TStreamReadException
Reads data from reader and initializes the concrete object. If exception occurs due to problems of XML parsing the instance remains in its current state.

Specified by:
readFrom in interface TXMLStreamable
Parameters:
reader - denotes the character stream from which the object is newly initialized.
systemId - the base URI to resolve relative references.
Throws:
TStreamReadException - due to any problems when reading the stream.

writeTo

public void writeTo(java.io.OutputStream outputStream,
                    java.lang.String encoding)
             throws TStreamWriteException
Writes the XML data to the given outputStream using the given encoding.

Specified by:
writeTo in interface TXMLStreamable
Overrides:
writeTo in class TXMLObject
Parameters:
outputStream - the byte output stream.
encoding - the encoding used for serializing the XML document.
Throws:
TStreamWriteException - signals an error while attempting to write the stream.

writeTo

public void writeTo(java.io.Writer writer,
                    java.lang.String encoding)
             throws TStreamWriteException
Writes the XML data to the given writer using the given encoding.

Specified by:
writeTo in interface TXMLStreamable
Overrides:
writeTo in class TXMLObject
Parameters:
outputStream - the character output stream.
encoding - the encoding used for serializing the XML document.
Throws:
TStreamWriteException - signals an error while attempting to write the stream.

canWriteToOutputStream

protected boolean canWriteToOutputStream()
Indicates if this instance can be currently written to an output stream.

Specified by:
canWriteToOutputStream in class TDataObject
Returns:
true if invocation of writeTo is possible, false otherwise.

writeDocumentStateTo

protected void writeDocumentStateTo(java.io.ObjectOutputStream out)
                             throws java.io.IOException
This abstract method serves as a plugin method for writeStateTo. Each time writeStateTo is called with the writeDocument parameter set to true, this method is invoked at the end of the operation. This method is needed for the implementation of serialization.

Overrides:
writeDocumentStateTo in class TDataObject
Parameters:
out - the ObjectOutputStream needed for serialization.
Throws:
java.io.IOException

readDocumentStateFrom

protected void readDocumentStateFrom(java.io.ObjectInputStream in)
                              throws java.io.IOException,
                                     java.lang.ClassNotFoundException
This abstract method serves as a plugin method for readStateFrom. Each time readStateFrom is called this method is invoked at the end of the operation. It is needed for the implementation of deserialization.

Overrides:
readDocumentStateFrom in class TDataObject
Parameters:
out - the ObjectOutputStream needed for serialization.
Throws:
java.io.IOException
java.lang.ClassNotFoundException


Copyright (c) 2013 Software AG. All Rights Reserved.