electric.xml.io.encoded
Class EncodedReader

java.lang.Object
  electric.xml.io.encoded.EncodedReader

All Implemented Interfaces:

IReader, ISchemaConstants

public final class EncodedReader

extends java.lang.Object

implements IReader, ISchemaConstants

EncodedReader

Author:

webMethods

Field Summary

Fields inherited from interface electric.xml.io.schema.ISchemaConstants

ABSTRACT, ALL, ANNOTATION, ANY, ANY_ATTRIBUTE, ANY_TYPE, ANY_URI, ARRAY, ARRAY_PREFIX, ARRAY_TYPE, ATTRIBUTE, ATTRIBUTE_FORM_DEFAULT, ATTRIBUTE_GROUP, BASE, BASE_64_BINARY, BOOLEAN, BYTE, CHOICE, COMPLEX_CONTENT, COMPLEX_TYPE, DATE_TIME, DECIMAL, DOMINANT_SIMPLE_TYPE_NAMES, DOUBLE, DURATION, ELEMENT, ELEMENT_FORM_DEFAULT, ENUMERATION, EXTENSION, FLOAT, FORM, FRACTION_DIGITS, GROUP, HEX_BINARY, HREF, ID, IMPORT, INCLUDE, INSTANCE_SUFFIX, INT, INTEGER, LENGTH, LONG, MAX_EXCLUSIVE, MAX_INCLUSIVE, MAX_LENGTH, MAX_OCCURS, MIN_EXCLUSIVE, MIN_INCLUSIVE, MIN_LENGTH, MIN_OCCURS, NAME, NAMESPACE, NIL, NILLABLE, NOTATION, NULL, ONE, PATTERN, POUND_ID, PROCESS_CONTENTS, QNAME, QUALIFIED, REDEFINE, REF, RESTRICTION, ROOT, SCHEMA, SCHEMA_LOCATION, SEQUENCE, SHORT, SIMPLE_CONTENT, SIMPLE_TYPE, SOAP_ENCODING, SOAP_ENCODING_ARRAY, SOAP12_ENCODING, SOAP12_ENCODING_ARRAY, SOAPENC, STAR, STRING, TARGET_NAMESPACE, TIME, TOTAL_DIGITS, TYPE, UNBOUNDED, UNQUALIFIED, UNSIGNED_SHORT, USE, VALUE, WHITESPACE, WSDL_ARRAY, WSDL_HTTP, WSDL_MIME, WSDL_NAMESPACE, WSDL_SOAP, XSD_BOOLEAN, XSD_BYTE, XSD_DOUBLE, XSD_FLOAT, XSD_INT, XSD_LONG, XSD_PREFIX, XSD_SHORT, XSD_STRING, XSD_UNSIGNED_SHORT, XSI_PREFIX, ZERO

Constructor Summary

EncodedReader(Document document)
Construct an EncodedReader for the document.

EncodedReader(Element element)
Construct an EncodedReader for the element passed in.

EncodedReader(Element element, Namespaces namespaces)
Construct an EncodedReader for the element passed in, with the given namespaces.

EncodedReader(Element element, Namespaces namespaces, Element root)
Construct an EncodedReader for the element passed in, with the given namespaces.

EncodedReader(Element element, java.lang.String encodingStyle)

Method Summary

void	addObject(java.lang.String id, java.lang.Object attachment) Register a new value to be referred to via hrefs.
void	addProperty(java.lang.String key, java.lang.Object value)
Document	getDocument() Return my Document.
Element	getElement() Return my element.
java.lang.Object	getObject(java.lang.String id)
java.lang.Object	getProperty(java.lang.String key)
IReader	getReader(java.lang.String name) Return an IReader for my first child named name.
IReader	getReaderAt(int index) Return an IReader for my index-th child.
IReader[]	getReaders() Return an array of IReaders for all my children.
IReader[]	getReaders(java.lang.String name) Return an array of IReaders for all my children named name.
IReader[]	getRemainingReaders()
Type	getType()
Element[]	getUnreadElements()
java.lang.String	getVersion()
boolean	isNil() Return true if my element is "nil".
Attribute	readAttribute(java.lang.String name) Return the first Attribute of my element with the given name.
java.lang.String	readAttributeValue(java.lang.String name) Return the value of the first Attribute of my element with the given name.
boolean	readBoolean() Return a boolean represented in this element.
boolean	readBoolean(java.lang.String name) Return a boolean value for my first child element named name.
byte	readByte() Return a byte represented in this element.
byte	readByte(java.lang.String name)
char	readChar() Return a char represented in this element.
char	readChar(java.lang.String name)
double	readDouble() Return a double represented in this element.
double	readDouble(java.lang.String name)
Element	readElement(java.lang.String name) Return the first child element of my element represented by the name.
Elements	readElements() Return all child elements of my element.
Elements	readElements(java.lang.String name) Return all child elements of my element being.
float	readFloat() Return a float represented in this element.
float	readFloat(java.lang.String name)
int	readInt() Return a int represented in this element.
int	readInt(java.lang.String name)
long	readLong() Return a long represented in this element.
long	readLong(java.lang.String name)
java.lang.String	readName() Return the name of my element.
java.lang.Object	readObject() Return an Object represented in this element.
java.lang.Object	readObject(java.lang.Class type)
java.lang.Object	readObject(java.lang.String name)
java.lang.Object	readObject(java.lang.String name, java.lang.Class type)
java.lang.Object	readObject(java.lang.String name, Type type)
java.lang.Object	readObject(Type type)
short	readShort() Return a short represented in this element.
short	readShort(java.lang.String name)
java.lang.String	readString() Return a String represented in this element.
java.lang.String	readString(java.lang.String name)
java.lang.String	readText() Return the text specified in this node.
Value	readValue()
Value	readValue(Type type)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

EncodedReader

public EncodedReader(Document document)

Construct an EncodedReader for the document. Since IReaders map one to one for an element, this actually returns the EncodedReader for the root element.

Parameters:

document -

EncodedReader

public EncodedReader(Element element)

Construct an EncodedReader for the element passed in.

Parameters:

element -

EncodedReader

public EncodedReader(Element element,
                     java.lang.String encodingStyle)

Parameters:

element -

encodingStyle -

EncodedReader

public EncodedReader(Element element,
                     Namespaces namespaces)

Construct an EncodedReader for the element passed in, with the given namespaces.

Parameters:

element -

namespaces -

EncodedReader

public EncodedReader(Element element,
                     Namespaces namespaces,
                     Element root)

Construct an EncodedReader for the element passed in, with the given namespaces.

Parameters:

element -

namespaces -

root -

Method Detail

getVersion

public java.lang.String getVersion()

Specified by:

getVersion in interface IReader

getDocument

public Document getDocument()

Return my Document.

Specified by:

getDocument in interface IReader

getElement

public Element getElement()

Return my element.

Specified by:

getElement in interface IReader

readElement

public Element readElement(java.lang.String name)

Return the first child element of my element represented by the name.

Specified by:

readElement in interface IReader

Parameters:

name -

readElements

public Elements readElements(java.lang.String name)

Return all child elements of my element being.

Specified by:

readElements in interface IReader

Parameters:

name -

readElements

public Elements readElements()

Return all child elements of my element.

Specified by:

readElements in interface IReader

getUnreadElements

public Element[] getUnreadElements()

Specified by:

getUnreadElements in interface IReader

readName

public java.lang.String readName()

Return the name of my element.

Specified by:

readName in interface IReader

readAttribute

public Attribute readAttribute(java.lang.String name)

Return the first Attribute of my element with the given name.

Specified by:

readAttribute in interface IReader

Parameters:

name -

readAttributeValue

public java.lang.String readAttributeValue(java.lang.String name)

Return the value of the first Attribute of my element with the given name.

Specified by:

readAttributeValue in interface IReader

Parameters:

name -

isNil

public boolean isNil()

Return true if my element is "nil".

Specified by:

isNil in interface IReader

getReaderAt

public IReader getReaderAt(int index)

Return an IReader for my index-th child.

Specified by:

getReaderAt in interface IReader

Parameters:

index -

getReader

public IReader getReader(java.lang.String name)

Return an IReader for my first child named name.

Specified by:

getReader in interface IReader

Parameters:

name -

getReaders

public IReader[] getReaders(java.lang.String name)

Return an array of IReaders for all my children named name.

Specified by:

getReaders in interface IReader

Parameters:

name -

getReaders

public IReader[] getReaders()

Return an array of IReaders for all my children.

Specified by:

getReaders in interface IReader

getRemainingReaders

public IReader[] getRemainingReaders()

Specified by:

getRemainingReaders in interface IReader

readText

public java.lang.String readText()

Return the text specified in this node.

Specified by:

readText in interface IReader

readBoolean

public boolean readBoolean()
                    throws java.io.IOException

Return a boolean represented in this element.

Specified by:

readBoolean in interface IReader

Throws:

java.io.IOException

readBoolean

public boolean readBoolean(java.lang.String name)
                    throws java.io.IOException

Return a boolean value for my first child element named name.

Specified by:

readBoolean in interface IReader

Parameters:

name -

Throws:

java.io.IOException

readByte

public byte readByte()
              throws java.io.IOException

Return a byte represented in this element.

Specified by:

readByte in interface IReader

Throws:

java.io.IOException

readByte

public byte readByte(java.lang.String name)
              throws java.io.IOException

Specified by:

readByte in interface IReader

Parameters:

name -

Throws:

java.io.IOException

readChar

public char readChar()
              throws java.io.IOException

Return a char represented in this element.

Specified by:

readChar in interface IReader

Throws:

java.io.IOException

readChar

public char readChar(java.lang.String name)
              throws java.io.IOException

Specified by:

readChar in interface IReader

Parameters:

name -

Throws:

java.io.IOException

readShort

public short readShort()
                throws java.io.IOException

Return a short represented in this element.

Specified by:

readShort in interface IReader

Throws:

java.io.IOException

readShort

public short readShort(java.lang.String name)
                throws java.io.IOException

Specified by:

readShort in interface IReader

Parameters:

name -

Throws:

java.io.IOException

readInt

public int readInt()
            throws java.io.IOException

Return a int represented in this element.

Specified by:

readInt in interface IReader

Throws:

java.io.IOException

readInt

public int readInt(java.lang.String name)
            throws java.io.IOException

Specified by:

readInt in interface IReader

Parameters:

name -

Throws:

java.io.IOException

readLong

public long readLong()
              throws java.io.IOException

Return a long represented in this element.

Specified by:

readLong in interface IReader

Throws:

java.io.IOException

readLong

public long readLong(java.lang.String name)
              throws java.io.IOException

Specified by:

readLong in interface IReader

Parameters:

name -

Throws:

java.io.IOException

readFloat

public float readFloat()
                throws java.io.IOException

Return a float represented in this element.

Specified by:

readFloat in interface IReader

Throws:

java.io.IOException

readFloat

public float readFloat(java.lang.String name)
                throws java.io.IOException

Specified by:

readFloat in interface IReader

Parameters:

name -

Throws:

java.io.IOException

readDouble

public double readDouble()
                  throws java.io.IOException

Return a double represented in this element.

Specified by:

readDouble in interface IReader

Throws:

java.io.IOException

readDouble

public double readDouble(java.lang.String name)
                  throws java.io.IOException

Specified by:

readDouble in interface IReader

Parameters:

name -

Throws:

java.io.IOException

readString

public java.lang.String readString()

Return a String represented in this element.

Specified by:

readString in interface IReader

readString

public java.lang.String readString(java.lang.String name)

Specified by:

readString in interface IReader

Parameters:

name -

getType

public Type getType()
             throws SchemaException

Specified by:

getType in interface IReader

Throws:

SchemaException

readObject

public java.lang.Object readObject()
                            throws java.io.IOException

Return an Object represented in this element.

Specified by:

readObject in interface IReader

Throws:

java.io.IOException

readObject

public java.lang.Object readObject(java.lang.String name)
                            throws java.io.IOException

Specified by:

readObject in interface IReader

Parameters:

name -

Throws:

java.io.IOException

readObject

public java.lang.Object readObject(Type type)
                            throws java.io.IOException

Specified by:

readObject in interface IReader

Parameters:

type -

Throws:

java.io.IOException

readObject

public java.lang.Object readObject(java.lang.Class type)
                            throws java.io.IOException

Specified by:

readObject in interface IReader

Parameters:

type -

Throws:

java.io.IOException

readObject

public java.lang.Object readObject(java.lang.String name,
                                   Type type)
                            throws java.io.IOException

Specified by:

readObject in interface IReader

Parameters:

name -

type -

Throws:

java.io.IOException

readObject

public java.lang.Object readObject(java.lang.String name,
                                   java.lang.Class type)
                            throws java.io.IOException

Specified by:

readObject in interface IReader

Parameters:

name -

type -

Throws:

java.io.IOException

addObject

public void addObject(java.lang.String id,
                      java.lang.Object attachment)

Register a new value to be referred to via hrefs. This method is very useful for registering values declared (and passed) outside of the scope of one xml element or document. One of the examples is MIME attachments.

Specified by:

addObject in interface IReader

Parameters:

id -

attachment -

getObject

public java.lang.Object getObject(java.lang.String id)

Specified by:

getObject in interface IReader

Parameters:

id -

Returns:

object added with id, or null.

readValue

public Value readValue()
                throws java.io.IOException

Specified by:

readValue in interface IReader

Throws:

java.io.IOException

readValue

public Value readValue(Type type)
                throws java.io.IOException

Specified by:

readValue in interface IReader

Parameters:

type -

Throws:

java.io.IOException

addProperty

public void addProperty(java.lang.String key,
                        java.lang.Object value)

Specified by:

addProperty in interface IReader

Parameters:

key -

value -

getProperty

public java.lang.Object getProperty(java.lang.String key)

Specified by:

getProperty in interface IReader

Parameters:

key -