nanoxml
Class kXMLElement

java.lang.Object
  nanoxml.kXMLElement

public class kXMLElement
extends java.lang.Object

kXMLElement is a representation of an XML object. The object is able to parse XML code.

Note that NanoXML is not 100% XML 1.0 compliant:

• The parser is non-validating.
• The DTD is fully ignored, including <!ENTITY...>.
• There is no support for mixed content (elements containing both subelements and CDATA elements)

You can opt to use a SAX compatible API, by including both nanoxml.jar and nanoxml-sax.jar in your classpath and setting the property org.xml.sax.parser to nanoxml.sax.SAXParser

$Revision: 1.1 $
$Date: 2007/05/09 15:54:52 $

Version:

1.0.7

Author:

Marc De Scheemaecker <Marc.DeScheemaecker@advalvas.be>

See Also:

XMLParseException

Nested Class Summary

static class

kXMLElement.FakeProperties

Field Summary

static int	NANOXML_MAJOR_VERSION Major version of NanoXML.
static int	NANOXML_MINOR_VERSION Minor version of NanoXML.

Constructor Summary

	kXMLElement() Creates a new XML element.
	kXMLElement(boolean skipLeadingWhitespace) Creates a new XML element.
	kXMLElement(kXMLElement.FakeProperties conversionTable) Creates a new XML element.
	kXMLElement(kXMLElement.FakeProperties conversionTable, boolean skipLeadingWhitespace) Creates a new XML element.
	kXMLElement(kXMLElement.FakeProperties conversionTable, boolean skipLeadingWhitespace, boolean ignoreCase) Creates a new XML element.
protected	kXMLElement(kXMLElement.FakeProperties conversionTable, boolean skipLeadingWhitespace, boolean fillBasicConversionTable, boolean ignoreCase) Creates a new XML element.

Method Summary

void	addChild(kXMLElement child) Adds a subobject.
void	addProperty(java.lang.String key, int value) Adds a property.
void	addProperty(java.lang.String key, java.lang.Object value) Adds a property.
int	countChildren() Returns the number of subobjects of the object.
protected kXMLElement	createAnotherElement() Creates a new XML element.
protected java.lang.String	decodeString(java.lang.String s, int lineNr) Converts &...; sequences to "normal" chars.
java.util.Enumeration	enumerateChildren() Enumerates the subobjects of the object.
java.util.Enumeration	enumeratePropertyNames() Enumerates the attribute names.
java.util.Vector	getChildren() Returns the subobjects of the object.
java.lang.String	getContents() Returns the #PCDATA content of the object.
int	getIntProperty(java.lang.String key, java.util.Hashtable valueSet, java.lang.String defaultValue) Returns a property by looking up a key in a hashtable.
int	getLineNr() Returns the line nr on which the element is found.
java.lang.String	getProperty(java.lang.String key) Returns a property of the object.
java.lang.Object	getProperty(java.lang.String key, java.util.Hashtable valueSet, java.lang.String defaultValue) Returns a property by looking up a key in the hashtable valueSet If the property doesn't exist, the value corresponding to defaultValue is returned.
int	getProperty(java.lang.String key, int defaultValue) Returns an integer property of the object.
java.lang.String	getProperty(java.lang.String key, java.lang.String defaultValue) Returns a property of the object.
boolean	getProperty(java.lang.String key, java.lang.String trueValue, java.lang.String falseValue, boolean defaultValue) Returns a boolean property of the object.
int	getSpecialIntProperty(java.lang.String key, java.util.Hashtable valueSet, java.lang.String defaultValue) Returns a property by looking up a key in the hashtable valueSet.
java.lang.String	getStringProperty(java.lang.String key, java.util.Hashtable valueSet, java.lang.String defaultValue) Returns a property by looking up a key in the hashtable valueSet.
java.lang.String	getTagName() Returns the class (i.e. the name indicated in the tag) of the object.
int	parseCharArray(char[] input, int offset, int end) Parses an XML definition starting at offset.
int	parseCharArray(char[] input, int offset, int end, int startingLineNr) Parses an XML definition starting at offset.
void	parseFromReader(java.io.Reader reader) Reads an XML definition from a java.io.Reader and parses it.
void	parseFromReader(java.io.Reader reader, int startingLineNr) Reads an XML definition from a java.io.Reader and parses it.
void	parseString(java.lang.String string) Parses an XML definition.
int	parseString(java.lang.String string, int offset) Parses an XML definition starting at offset.
int	parseString(java.lang.String string, int offset, int end) Parses an XML definition starting at offset.
int	parseString(java.lang.String string, int offset, int end, int startingLineNr) Parses an XML definition starting at offset.
void	removeChild(kXMLElement child) Removes a child object.
void	removeChild(java.lang.String key) Removes an attribute.
protected void	scanChildren(char[] input, int contentOffset, int contentSize, int contentLineNr) !!!
void	setContent(java.lang.String content) Changes the content string.
void	setTagName(java.lang.String tagName) Changes the tag name.
protected int	skipBogusTag(char[] input, int offset, int end, int[] lineNr) Skips a tag that don't contain any useful data: <?...?
java.lang.String	toString() Writes the XML element to a string.
void	write(java.io.Writer writer) Writes the XML element to a writer.
void	write(java.io.Writer writer, int indent) Writes the XML element to a writer.
protected void	writeEncoded(nanoxml.kXMLElement.FakePrintWriter out, java.lang.String str) Writes a string encoded to a writer.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

NANOXML_MAJOR_VERSION

public static final int NANOXML_MAJOR_VERSION

Major version of NanoXML.

See Also:

Constant Field Values

NANOXML_MINOR_VERSION

public static final int NANOXML_MINOR_VERSION

Minor version of NanoXML.

See Also:

Constant Field Values

Constructor Detail

kXMLElement

public kXMLElement()

Creates a new XML element. The following settings are used:

Conversion table

Minimal XML conversions: & < > ' "

Skip whitespace in contents

false

Ignore Case

true

See Also:

kXMLElement(FakeProperties), kXMLElement(boolean), kXMLElement(FakeProperties,boolean)

kXMLElement

public kXMLElement(kXMLElement.FakeProperties conversionTable)

Creates a new XML element. The following settings are used:

Conversion table

conversionTable combined with the minimal XML conversions: & < > ' "

Skip whitespace in contents

false

Ignore Case

true

See Also:

kXMLElement(), kXMLElement(boolean), kXMLElement(FakeProperties,boolean)

kXMLElement

public kXMLElement(boolean skipLeadingWhitespace)

Creates a new XML element. The following settings are used:

Conversion table

Minimal XML conversions: & < > ' "

Skip whitespace in contents

skipLeadingWhitespace

Ignore Case

true

See Also:

kXMLElement(), kXMLElement(FakeProperties), kXMLElement(FakeProperties,boolean)

kXMLElement

public kXMLElement(kXMLElement.FakeProperties conversionTable,
                   boolean skipLeadingWhitespace)

Creates a new XML element. The following settings are used:

Conversion table

conversionTable combined with the minimal XML conversions: & < > ' "

Skip whitespace in contents

skipLeadingWhitespace

Ignore Case

true

See Also:

kXMLElement(), kXMLElement(boolean), kXMLElement(FakeProperties)

kXMLElement

public kXMLElement(kXMLElement.FakeProperties conversionTable,
                   boolean skipLeadingWhitespace,
                   boolean ignoreCase)

Creates a new XML element. The following settings are used:

Conversion table

conversionTable, eventually combined with the minimal XML conversions: & < > ' " (depending on fillBasicConversionTable)

Skip whitespace in contents

skipLeadingWhitespace

Ignore Case

ignoreCase

This constructor should only be called from kXMLElement itself to create child elements.

See Also:

kXMLElement(), kXMLElement(boolean), kXMLElement(FakeProperties), kXMLElement(FakeProperties,boolean)

kXMLElement

protected kXMLElement(kXMLElement.FakeProperties conversionTable,
                      boolean skipLeadingWhitespace,
                      boolean fillBasicConversionTable,
                      boolean ignoreCase)

Creates a new XML element. The following settings are used:

Conversion table

conversionTable, eventually combined with the minimal XML conversions: & < > ' " (depending on fillBasicConversionTable)

Skip whitespace in contents

skipLeadingWhitespace

Ignore Case

ignoreCase

This constructor should only be called from kXMLElement itself to create child elements.

See Also:

kXMLElement(), kXMLElement(boolean), kXMLElement(FakeProperties), kXMLElement(FakeProperties,boolean)

Method Detail

addChild

public void addChild(kXMLElement child)

Adds a subobject.

addProperty

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

Adds a property. If the element is case insensitive, the property name is capitalized.

addProperty

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

Adds a property. If the element is case insensitive, the property name is capitalized.

countChildren

public int countChildren()

Returns the number of subobjects of the object.

enumeratePropertyNames

public java.util.Enumeration enumeratePropertyNames()

Enumerates the attribute names.

enumerateChildren

public java.util.Enumeration enumerateChildren()

Enumerates the subobjects of the object.

getChildren

public java.util.Vector getChildren()

Returns the subobjects of the object.

getContents

public java.lang.String getContents()

Returns the #PCDATA content of the object. If there is no such content, null is returned.

getLineNr

public int getLineNr()

Returns the line nr on which the element is found.

getIntProperty

public int getIntProperty(java.lang.String key,
                          java.util.Hashtable valueSet,
                          java.lang.String defaultValue)

Returns a property by looking up a key in a hashtable. If the property doesn't exist, the value corresponding to defaultValue is returned.

getProperty

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

Returns a property of the object. If there is no such property, this method returns null.

getProperty

public java.lang.String getProperty(java.lang.String key,
                                    java.lang.String defaultValue)

Returns a property of the object. If the property doesn't exist, defaultValue is returned.

getProperty

public int getProperty(java.lang.String key,
                       int defaultValue)

Returns an integer property of the object. If the property doesn't exist, defaultValue is returned.

getProperty

public boolean getProperty(java.lang.String key,
                           java.lang.String trueValue,
                           java.lang.String falseValue,
                           boolean defaultValue)

Returns a boolean property of the object. If the property is missing, defaultValue is returned.

getProperty

public java.lang.Object getProperty(java.lang.String key,
                                    java.util.Hashtable valueSet,
                                    java.lang.String defaultValue)

Returns a property by looking up a key in the hashtable valueSet If the property doesn't exist, the value corresponding to defaultValue is returned.

getStringProperty

public java.lang.String getStringProperty(java.lang.String key,
                                          java.util.Hashtable valueSet,
                                          java.lang.String defaultValue)

Returns a property by looking up a key in the hashtable valueSet. If the property doesn't exist, the value corresponding to defaultValue is returned.

getSpecialIntProperty

public int getSpecialIntProperty(java.lang.String key,
                                 java.util.Hashtable valueSet,
                                 java.lang.String defaultValue)

Returns a property by looking up a key in the hashtable valueSet. If the value is not defined in the hashtable, the value is considered to be an integer. If the property doesn't exist, the value corresponding to defaultValue is returned.

getTagName

public java.lang.String getTagName()

Returns the class (i.e. the name indicated in the tag) of the object.

parseFromReader

public void parseFromReader(java.io.Reader reader)
                     throws java.io.IOException,
                            XMLParseException

Reads an XML definition from a java.io.Reader and parses it.

Throws:

java.io.IOException - if an error occured while reading the input

XMLParseException - if an error occured while parsing the read data

parseFromReader

public void parseFromReader(java.io.Reader reader,
                            int startingLineNr)
                     throws java.io.IOException,
                            XMLParseException

Reads an XML definition from a java.io.Reader and parses it.

Throws:

java.io.IOException - if an error occured while reading the input

XMLParseException - if an error occured while parsing the read data

parseString

public void parseString(java.lang.String string)
                 throws XMLParseException

Parses an XML definition.

Throws:

XMLParseException - if an error occured while parsing the string

parseString

public int parseString(java.lang.String string,
                       int offset)
                throws XMLParseException

Parses an XML definition starting at offset.

Returns:

the offset of the string following the XML data

Throws:

XMLParseException - if an error occured while parsing the string

parseString

public int parseString(java.lang.String string,
                       int offset,
                       int end)
                throws XMLParseException

Parses an XML definition starting at offset.

Returns:

the offset of the string following the XML data (<= end)

Throws:

XMLParseException - if an error occured while parsing the string

parseString

public int parseString(java.lang.String string,
                       int offset,
                       int end,
                       int startingLineNr)
                throws XMLParseException

Parses an XML definition starting at offset.

Returns:

the offset of the string following the XML data (<= end)

Throws:

XMLParseException - if an error occured while parsing the string

parseCharArray

public int parseCharArray(char[] input,
                          int offset,
                          int end)
                   throws XMLParseException

Parses an XML definition starting at offset.

Returns:

the offset of the array following the XML data (<= end)

Throws:

XMLParseException - if an error occured while parsing the array

parseCharArray

public int parseCharArray(char[] input,
                          int offset,
                          int end,
                          int startingLineNr)
                   throws XMLParseException

Parses an XML definition starting at offset.

Returns:

the offset of the array following the XML data (<= end)

Throws:

XMLParseException - if an error occured while parsing the array

removeChild

public void removeChild(kXMLElement child)

Removes a child object. If the object is not a child, nothing happens.

removeChild

public void removeChild(java.lang.String key)

Removes an attribute.

scanChildren

protected void scanChildren(char[] input,
                            int contentOffset,
                            int contentSize,
                            int contentLineNr)
                     throws XMLParseException

!!! Searches the content for child objects. If such objects exist, the content is reduced to null.

Throws:

XMLParseException - if an error occured while parsing the array

See Also:

parseCharArray(char[], int, int)

createAnotherElement

protected kXMLElement createAnotherElement()

Creates a new XML element.

setContent

public void setContent(java.lang.String content)

Changes the content string.

Parameters:

content - The new content string.

setTagName

public void setTagName(java.lang.String tagName)

Changes the tag name.

Parameters:

tagName - The new tag name.

skipBogusTag

protected int skipBogusTag(char[] input,
                           int offset,
                           int end,
                           int[] lineNr)

Skips a tag that don't contain any useful data: <?...?>, <!...> and comments.

Returns:

the position after the tag

Throws:

XMLParseException - if an error occured while parsing the array

decodeString

protected java.lang.String decodeString(java.lang.String s,
                                        int lineNr)

Converts &...; sequences to "normal" chars.

toString

public java.lang.String toString()

Writes the XML element to a string.

Overrides:

toString in class java.lang.Object

write

public void write(java.io.Writer writer)

Writes the XML element to a writer.

write

public void write(java.io.Writer writer,
                  int indent)

Writes the XML element to a writer.

writeEncoded

protected void writeEncoded(nanoxml.kXMLElement.FakePrintWriter out,
                            java.lang.String str)

Writes a string encoded to a writer.