pivot.wtkx
Class WTKXSerializer

java.lang.Object
  extended by pivot.wtkx.WTKXSerializer
All Implemented Interfaces:
Serializer<java.lang.Object>

public class WTKXSerializer
extends java.lang.Object
implements Serializer<java.lang.Object>

Loads an object hierarchy from an XML document.

Author:
gbrown

Field Summary
static java.lang.String ID_ATTRIBUTE
           
static java.lang.String INCLUDE_NAMESPACE_ATTRIBUTE
           
static java.lang.String INCLUDE_RESOURCES_ATTRIBUTE
           
static java.lang.String INCLUDE_SRC_ATTRIBUTE
           
static java.lang.String INCLUDE_TAG
           
static java.lang.String MIME_TYPE
           
static char OBJECT_REFERENCE_PREFIX
           
static char RESOURCE_KEY_PREFIX
           
static java.lang.String SCRIPT_SRC_ATTRIBUTE
           
static java.lang.String SCRIPT_TAG
           
static char URL_PREFIX
           
static java.lang.String WTKX_PREFIX
           
 
Constructor Summary
WTKXSerializer()
           
WTKXSerializer(Resources resources)
           
 
Method Summary
 java.lang.String getMIMEType(java.lang.Object object)
          Returns the MIME type of the data read and written by this serializer.
 java.lang.Object getObjectByName(java.lang.String name)
          Retrieves a named object.
 Resources getResources()
           
 WTKXSerializer getSerializerByName(java.lang.String name)
          Retrieves a included serializer by its namespace.
 java.lang.Object readObject(java.io.InputStream inputStream)
          Reads an object from an input stream.
 java.lang.Object readObject(java.lang.String resourceName)
           
 java.lang.Object readObject(java.net.URL location)
           
 void writeObject(java.lang.Object object, java.io.OutputStream outputStream)
          Writes an object to an output stream.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

URL_PREFIX

public static final char URL_PREFIX
See Also:
Constant Field Values

RESOURCE_KEY_PREFIX

public static final char RESOURCE_KEY_PREFIX
See Also:
Constant Field Values

OBJECT_REFERENCE_PREFIX

public static final char OBJECT_REFERENCE_PREFIX
See Also:
Constant Field Values

WTKX_PREFIX

public static final java.lang.String WTKX_PREFIX
See Also:
Constant Field Values

ID_ATTRIBUTE

public static final java.lang.String ID_ATTRIBUTE
See Also:
Constant Field Values

INCLUDE_TAG

public static final java.lang.String INCLUDE_TAG
See Also:
Constant Field Values

INCLUDE_SRC_ATTRIBUTE

public static final java.lang.String INCLUDE_SRC_ATTRIBUTE
See Also:
Constant Field Values

INCLUDE_NAMESPACE_ATTRIBUTE

public static final java.lang.String INCLUDE_NAMESPACE_ATTRIBUTE
See Also:
Constant Field Values

INCLUDE_RESOURCES_ATTRIBUTE

public static final java.lang.String INCLUDE_RESOURCES_ATTRIBUTE
See Also:
Constant Field Values

SCRIPT_TAG

public static final java.lang.String SCRIPT_TAG
See Also:
Constant Field Values

SCRIPT_SRC_ATTRIBUTE

public static final java.lang.String SCRIPT_SRC_ATTRIBUTE
See Also:
Constant Field Values

MIME_TYPE

public static final java.lang.String MIME_TYPE
See Also:
Constant Field Values
Constructor Detail

WTKXSerializer

public WTKXSerializer()

WTKXSerializer

public WTKXSerializer(Resources resources)
Method Detail

getResources

public Resources getResources()

readObject

public java.lang.Object readObject(java.lang.String resourceName)
                            throws java.io.IOException,
                                   SerializationException
Throws:
java.io.IOException
SerializationException

readObject

public java.lang.Object readObject(java.net.URL location)
                            throws java.io.IOException,
                                   SerializationException
Throws:
java.io.IOException
SerializationException

readObject

public java.lang.Object readObject(java.io.InputStream inputStream)
                            throws java.io.IOException,
                                   SerializationException
Description copied from interface: Serializer
Reads an object from an input stream.

Specified by:
readObject in interface Serializer<java.lang.Object>
Parameters:
inputStream - The data stream from which the object will be read.
Returns:
The deserialized object.
Throws:
java.io.IOException
SerializationException

writeObject

public void writeObject(java.lang.Object object,
                        java.io.OutputStream outputStream)
                 throws java.io.IOException,
                        SerializationException
Description copied from interface: Serializer
Writes an object to an output stream.

Specified by:
writeObject in interface Serializer<java.lang.Object>
Parameters:
object - The object to serialize.
outputStream - The data stream to which the object will be written.
Throws:
java.io.IOException
SerializationException

getMIMEType

public java.lang.String getMIMEType(java.lang.Object object)
Description copied from interface: Serializer
Returns the MIME type of the data read and written by this serializer.

Specified by:
getMIMEType in interface Serializer<java.lang.Object>
Parameters:
object - If provided, allows the serializer to attach parameters to the returned MIME type containing more detailed information about the data. If null, the base MIME type is returned.

getSerializerByName

public WTKXSerializer getSerializerByName(java.lang.String name)
Retrieves a included serializer by its namespace.

Parameters:
name - The name of the serializer, relative to this loader. The values's name is the concatentation of its parent namespaces and its namespace, separated by periods (e.g. "foo.bar.baz").
Returns:
The named serializer, or null if a serializer with the given name does not exist.

getObjectByName

public java.lang.Object getObjectByName(java.lang.String name)
Retrieves a named object.

Parameters:
name - The name of the object, relative to this loader. The values's name is the concatentation of its parent namespaces and its ID, separated by periods (e.g. "foo.bar.baz").
Returns:
The named object, or null if an object with the given name does not exist.