wt.xml
Class XMLLob

java.lang.Object
  extended bywt.xml.XMLLob
All Implemented Interfaces:
Externalizable, NetFactor, ObjectMappable, Serializable

public class XMLLob
extends Object
implements ObjectMappable, Externalizable

Use the newXMLLob static factory method(s), not the XMLLob constructor, to construct instances of this class. Instances must be constructed using the static factory(s), in order to ensure proper initialization of the instance.



Supported API: false

Extendable: false

See Also:
Serialized Form

Field Summary
private static String CLASSNAME
           
private  String contents
           
static String CONTENTS
          Label for the attribute.
private static int CONTENTS_UPPER_LIMIT
           
private  String encoding
           
static String ENCODING
          Label for the attribute.
private static int ENCODING_UPPER_LIMIT
           
static long EXTERNALIZATION_VERSION_UID
           
protected static long OLD_FORMAT_VERSION_UID
           
private static String RESOURCE
           
(package private) static long serialVersionUID
           
 
Constructor Summary
XMLLob()
           
 
Method Summary
private  void encodingValidate(String a_Encoding)
           
 ClassInfo getClassInfo()
          Returns the ClassInfo object for this class.
 String getConceptualClassname()
          Deprecated.  
 String getContents()
          Gets the value of the attribute: CONTENTS.
 String getEncoding()
          Gets the value of the attribute: ENCODING.
 InputStream getInputStream(String contents)
          Gets an input stream for the given contents string with the platform's default encoding.
 InputStream getInputStream(String contents, String encoding)
          Gets an input stream for the given contents string with the given encoding name.
protected  void initialize()
          Supports initialization, following construction of an instance.
static XMLLob newXMLLob()
          Default factory for the class.
 void readExternal(ObjectInput input)
          Reads the non-transient fields of this class from an external source.
 void readExternal(PersistentRetrieveIfc input)
          Used by Persistent Data Service to populate the persistent attributes of this class from a persistent store.
private  boolean readOldVersion(ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone)
          Reads the non-transient fields of this class from an external source, which is not the current version.
protected  boolean readVersion(XMLLob thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone)
          Reads the non-transient fields of this class from an external source.
 void setContents(String a_Contents)
          Sets the value of the attribute: CONTENTS.
 void setEncoding(String a_Encoding)
          Sets the value of the attribute: ENCODING.
 String toString()
          Returns the conceptual (modeled) name for the class.
 void writeExternal(ObjectOutput output)
          Writes the non-transient fields of this class to an external source.
 void writeExternal(PersistentStoreIfc output)
          Used by Persistent Data Service to obtain the values of the persistent attributes of this class, so they can be written to a persistent store.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

RESOURCE

private static final String RESOURCE
See Also:
Constant Field Values

CLASSNAME

private static final String CLASSNAME

CONTENTS

public static final String CONTENTS
Label for the attribute.

Supported API: false

See Also:
Constant Field Values

CONTENTS_UPPER_LIMIT

private static int CONTENTS_UPPER_LIMIT

contents

private String contents

ENCODING

public static final String ENCODING
Label for the attribute.

Supported API: false

See Also:
Constant Field Values

ENCODING_UPPER_LIMIT

private static int ENCODING_UPPER_LIMIT

encoding

private String encoding

serialVersionUID

static final long serialVersionUID
See Also:
Constant Field Values

EXTERNALIZATION_VERSION_UID

public static final long EXTERNALIZATION_VERSION_UID
See Also:
Constant Field Values

OLD_FORMAT_VERSION_UID

protected static final long OLD_FORMAT_VERSION_UID
See Also:
Constant Field Values
Constructor Detail

XMLLob

public XMLLob()
Method Detail

writeExternal

public void writeExternal(ObjectOutput output)
                   throws IOException
Writes the non-transient fields of this class to an external source.

Supported API: false

Specified by:
writeExternal in interface Externalizable
Parameters:
output -
Throws:
IOException

readExternal

public void readExternal(ObjectInput input)
                  throws IOException,
                         ClassNotFoundException
Reads the non-transient fields of this class from an external source.

Supported API: false

Specified by:
readExternal in interface Externalizable
Parameters:
input -
Throws:
IOException
ClassNotFoundException

readVersion

protected boolean readVersion(XMLLob thisObject,
                              ObjectInput input,
                              long readSerialVersionUID,
                              boolean passThrough,
                              boolean superDone)
                       throws IOException,
                              ClassNotFoundException
Reads the non-transient fields of this class from an external source.

Supported API: false

Parameters:
thisObject -
input -
readSerialVersionUID -
passThrough -
superDone -
Returns:
boolean
Throws:
IOException
ClassNotFoundException

readOldVersion

private boolean readOldVersion(ObjectInput input,
                               long readSerialVersionUID,
                               boolean passThrough,
                               boolean superDone)
                        throws IOException,
                               ClassNotFoundException
Reads the non-transient fields of this class from an external source, which is not the current version.

Parameters:
input -
readSerialVersionUID -
passThrough -
superDone -
Returns:
boolean
Throws:
IOException
ClassNotFoundException

writeExternal

public void writeExternal(PersistentStoreIfc output)
                   throws SQLException,
                          DatastoreException
Used by Persistent Data Service to obtain the values of the persistent attributes of this class, so they can be written to a persistent store.

(Not intended for general use.)

Supported API: false

Specified by:
writeExternal in interface ObjectMappable
Parameters:
output -
Throws:
SQLException
DatastoreException

readExternal

public void readExternal(PersistentRetrieveIfc input)
                  throws SQLException,
                         DatastoreException
Used by Persistent Data Service to populate the persistent attributes of this class from a persistent store.

(Not intended for general use.)

Supported API: false

Specified by:
readExternal in interface ObjectMappable
Parameters:
input -
Throws:
SQLException
DatastoreException

getConceptualClassname

public String getConceptualClassname()
Deprecated.  

Returns the conceptual (modeled) name for the class.

Supported API: false

Specified by:
getConceptualClassname in interface NetFactor
Returns:
String

toString

public String toString()
Returns the conceptual (modeled) name for the class.

Supported API: false

Returns:
String

getClassInfo

public ClassInfo getClassInfo()
                       throws WTIntrospectionException
Returns the ClassInfo object for this class.

Supported API: false

Specified by:
getClassInfo in interface NetFactor
Returns:
ClassInfo
Throws:
WTIntrospectionException

getContents

public String getContents()
Gets the value of the attribute: CONTENTS.

Supported API: false

Returns:
String

setContents

public void setContents(String a_Contents)
Sets the value of the attribute: CONTENTS.

Supported API: false

Parameters:
a_Contents -

getEncoding

public String getEncoding()
Gets the value of the attribute: ENCODING.

Supported API: false

Returns:
String

setEncoding

public void setEncoding(String a_Encoding)
                 throws WTPropertyVetoException
Sets the value of the attribute: ENCODING.

Supported API: false

Parameters:
a_Encoding -
Throws:
WTPropertyVetoException

encodingValidate

private void encodingValidate(String a_Encoding)
                       throws WTPropertyVetoException
Parameters:
a_Encoding -
Throws:
WTPropertyVetoException

getInputStream

public InputStream getInputStream(String contents)
Gets an input stream for the given contents string with the platform's default encoding.

Supported API: false

Parameters:
contents -
Returns:
InputStream

getInputStream

public InputStream getInputStream(String contents,
                                  String encoding)
                           throws UnsupportedEncodingException
Gets an input stream for the given contents string with the given encoding name.

Supported API: false

Parameters:
contents -
encoding -
Returns:
InputStream
Throws:
UnsupportedEncodingException

newXMLLob

public static XMLLob newXMLLob()
                        throws WTException
Default factory for the class.

Supported API: false

Returns:
XMLLob
Throws:
WTException

initialize

protected void initialize()
                   throws WTException
Supports initialization, following construction of an instance. Invoked by "new" factory having the same signature.

Supported API: false

Throws:
WTException