com.hfg.xml

Class XMLTag

java.lang.Object

com.hfg.xml.XMLContainerImpl

com.hfg.xml.XMLTag

All Implemented Interfaces:

XMLContainer, XMLizable, XMLNode, Cloneable, Comparable

Direct Known Subclasses:

AbstractSvgNode, CreativeCommons_Work, DmlColor, DmlEffectRef, DmlExtents, DmlFill, DmlFillRef, DmlFontRef, DmlGradientStop, DmlGraphicFrameLocks, DmlLineEnd, DmlLineJoin, DmlLineRef, DmlNonVisualDrawingProperties, DmlNonVisualPictureDrawingProperties, DmlNonVisualPictureProperties, DmlParagraph, DmlPictureLocks, DmlPresetGeometry, DmlShapeAdjustValues, DmlSrcRect, DmlText, DmlTextBodyProperties, DmlTextRun, DmlTextRunProperties, DmlTransform, DublinCore, ExcelBorder, ExcelCell, ExcelColumn, ExcelComment, ExcelData, ExcelFont, ExcelRow, ExcelStyle, ExcelTable, ExcelWorkbook, ExcelWorksheet, ExcelWorksheetOptions, HTMLTag, OfficeOpenXMLTag, RDF, WmlComments, WmlCommonDrawingMLNonVisualProperties, WmlDrawingObjNonVisualProperties, WmlEffectExtent, WmlIndentation, WmlListProperties, WmlPageMargins, WmlPageSize, WmlShading, WmlSpacing, WmlTableBorders, WmlTableCellBorders, WmlTableCellMargins, WmlTableProperties, WmlText

public class XMLTag
extends XMLContainerImpl
implements XMLNode, Comparable

XMLTag is a generic container for XML. It can be used both to construct XML or to deconstruct XML into a DOM-like structure.

Nested Class Summary

Nested classes/interfaces inherited from class com.hfg.xml.XMLContainerImpl

XMLContainerImpl.sMode

Field Summary

Fields inherited from class com.hfg.xml.XMLContainerImpl

mContentAndSubtagList

Constructor Summary

Constructors

Constructor and Description
XMLTag(File inXMLFile)
XMLTag(InputStream inXML)
XMLTag(Reader inXML)
XMLTag(String inName)
XMLTag(String inName, Collection<XMLAttribute> inAttributes)
XMLTag(String inName, Collection inAttributes, String inContent)
XMLTag(String inName, Map<String,String> inAttributes)
XMLTag(String inName, Map inAttributes, String inContent)
XMLTag(XMLName inName)

Method Summary

Modifier and Type	Method and Description
XMLTag	addSubtag(String inTagName)
XMLTag	addSubtag(XMLName inTagName)
XMLTag	addXMLNamespaceDeclaration(XMLNamespace inValue)
XMLTag	clone()
int	compareTo(Object inObj2)
boolean	equals(Object inObj2)
List<? extends XMLNode>	findNodesByAttributeValue(String inAttribute, String inValue) Returns a List of all nodes with the specified attribute name and specified attribute value.
List<? extends XMLNode>	findNodesByAttributeValue(XMLName inAttribute, String inValue) Returns a List of all nodes with the specified attribute name and specified attribute value.
XMLAttribute	getAttribute(String inAttributeName)
XMLAttribute	getAttribute(XMLName inAttributeName)
Collection<XMLAttribute>	getAttributes() Returns a Collection of XMLAttribute objects.
String	getAttributeValue(String inAttributeName)
String	getAttributeValue(XMLName inAttributeName)
String	getEndTag()
XMLNamespace	getNamespace()
String	getQualifiedTagName()
String	getStartTag()
String	getTagName()
boolean	hasAttribute(String inAttributeName)
boolean	hasAttribute(XMLName inAttributeName)
boolean	hasAttributes()
boolean	isEmptyTag()
XMLAttribute	removeAttribute(String inAttributeName)
XMLAttribute	removeAttribute(XMLName inAttributeName)
void	replaceCharacterEntities()
XMLTag	setAttribute(String inAttributeName, Object inValue)
XMLTag	setAttribute(XMLAttribute inAttribute)
XMLTag	setAttribute(XMLName inAttributeName, Object inValue)
void	setAttributes(Collection<XMLAttribute> inAttributes) Takes a Collection of XMLAttribute objects as input.
XMLNode	setContent(CharSequence inContent)
XMLTag	setDefaultXMLNamespaceDeclaration(XMLNamespace inValue)
XMLTag	setNamespace(XMLNamespace inValue)
XMLTag	setSortAttributesBeforeWriting(boolean inValue)
XMLTag	setTagName(String inName)
XMLTag	setTagName(XMLName inName)
protected void	sortAttributes(List<XMLAttribute> inAttributes)
String	toIndentedXML(int inInitialIndentLevel, int inIndentSize)
void	toIndentedXML(OutputStream inOutputStream, int inInitialIndentLevel, int inIndentSize) Writes out the tag (and any subtags) to te specified OutputStream.
void	toIndentedXML(Writer inWriter, int inInitialIndentLevel, int inIndentSize)
void	toIndentedXML(Writer inWriter, int inInitialIndentLevel, int inIndentSize, XMLNamespaceSet inDeclaredNamespaces)
String	toString()
String	toXML()
void	toXML(OutputStream inStream)
void	toXML(Writer inWriter)
protected void	toXML(Writer inWriter, XMLNamespaceSet inDeclaredNamespaces)
static void	useDoubleQuotes(boolean inValue)
void	verifyTagName(String inTagName)
void	verifyTagName(String inTagName, Case inCaseSensitivity)
void	verifyTagName(XMLName inTagName)
void	verifyTagName(XMLName inTagName, Case inCaseSensitivity)

Methods inherited from class com.hfg.xml.XMLContainerImpl

addContent, addContentWithoutEscaping, addSubtag, addSubtag, addSubtags, clearContent, clearSubtags, getContent, getContentPlusSubtagList, getNextSibling, getOptionalSubtagByName, getOptionalSubtagByName, getOptionalSubtagByName, getOptionalSubtagByName, getParentNode, getPreviousSibling, getRequiredSubtagById, getRequiredSubtagById, getRequiredSubtagByName, getRequiredSubtagByName, getSubtagByAttribute, getSubtagByAttribute, getSubtags, getSubtagsByAttribute, getSubtagsByAttribute, getSubtagsByAttribute, getSubtagsByAttribute, getSubtagsByAttribute, getSubtagsByClass, getSubtagsByClass, getSubtagsByName, getSubtagsByName, getSubtagsByName, getSubtagsByName, getSubtagsByName, getTotalTagCount, getUnescapedContent, getXMLNodeSubtags, hasContent, hasContentOrSubtags, indexOf, innerHTML, removeSubtag, removeSubtagsByAttribute, removeSubtagsByAttribute, removeSubtagsByAttribute, removeSubtagsByClass, removeSubtagsByClass, removeSubtagsByName, removeSubtagsByName, removeSubtagsByName, setContent, setParentNode, setSubtags

Methods inherited from class java.lang.Object

finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.hfg.xml.XMLContainer

addContent, addContentWithoutEscaping, addSubtag, addSubtags, clearContent, clearSubtags, getContent, getNextSibling, getOptionalSubtagByName, getOptionalSubtagByName, getParentNode, getPreviousSibling, getRequiredSubtagByName, getRequiredSubtagByName, getSubtags, getSubtagsByName, getSubtagsByName, getSubtagsByName, getSubtagsByName, getTotalTagCount, getUnescapedContent, getXMLNodeSubtags, hasContent, indexOf, removeSubtag, removeSubtagsByName, removeSubtagsByName, setParentNode, setSubtags

Constructor Detail

XMLTag

public XMLTag(String inName)

Parameters:

inName - the tag name

XMLTag

public XMLTag(XMLName inName)

Parameters:

inName - the tag name

XMLTag

public XMLTag(String inName,
              Collection<XMLAttribute> inAttributes)

Parameters:

inName - the tag name

inAttributes - a Collection of XMLAttribute objects

XMLTag

public XMLTag(String inName,
              Map<String,String> inAttributes)

Parameters:

inName - the tag name

inAttributes - a Map of attribute (names and values as String objects)

XMLTag

public XMLTag(String inName,
              Collection inAttributes,
              String inContent)

Parameters:

inName - the tag name

inAttributes - a Collection of XMLAttribute objects

inContent - the tag's content

XMLTag

public XMLTag(String inName,
              Map inAttributes,
              String inContent)

Parameters:

inName - the tag name

inAttributes - a ImageMap of attribute (names and values as String objects)

inContent - the tag's content

XMLTag

public XMLTag(InputStream inXML)
       throws XMLException,
              IOException

Parameters:

inXML - an InputStream containing XML text

Throws:

XMLException

IOException

XMLTag

public XMLTag(Reader inXML)
       throws XMLException,
              IOException

Parameters:

inXML - a Reader containing XML text

Throws:

XMLException

IOException

XMLTag

public XMLTag(File inXMLFile)
       throws XMLException,
              IOException

Parameters:

inXMLFile - a File containing XML text

Throws:

XMLException

IOException

Method Detail

useDoubleQuotes

public static void useDoubleQuotes(boolean inValue)

setSortAttributesBeforeWriting

public XMLTag setSortAttributesBeforeWriting(boolean inValue)

clone

public XMLTag clone()

Specified by:

clone in interface XMLizable

Overrides:

clone in class XMLContainerImpl

equals

public boolean equals(Object inObj2)

Overrides:

equals in class Object

compareTo

public int compareTo(Object inObj2)

Specified by:

compareTo in interface Comparable

setContent

public XMLNode setContent(CharSequence inContent)

Specified by:

setContent in interface XMLContainer

Overrides:

setContent in class XMLContainerImpl

addSubtag

public XMLTag addSubtag(String inTagName)

addSubtag

public XMLTag addSubtag(XMLName inTagName)

getStartTag

public String getStartTag()

getEndTag

public String getEndTag()

isEmptyTag

public boolean isEmptyTag()

Specified by:

isEmptyTag in interface XMLNode

setTagName

public XMLTag setTagName(XMLName inName)

Specified by:

setTagName in interface XMLNode

setTagName

public XMLTag setTagName(String inName)

Specified by:

setTagName in interface XMLNode

getTagName

public String getTagName()

Specified by:

getTagName in interface XMLNode

getQualifiedTagName

public String getQualifiedTagName()

verifyTagName

public void verifyTagName(XMLName inTagName)

Specified by:

verifyTagName in interface XMLNode

verifyTagName

public void verifyTagName(XMLName inTagName,
                          Case inCaseSensitivity)

Specified by:

verifyTagName in interface XMLNode

verifyTagName

public void verifyTagName(String inTagName)

Specified by:

verifyTagName in interface XMLNode

verifyTagName

public void verifyTagName(String inTagName,
                          Case inCaseSensitivity)

Specified by:

verifyTagName in interface XMLNode

setAttribute

public XMLTag setAttribute(String inAttributeName,
                           Object inValue)

Specified by:

setAttribute in interface XMLNode

setAttribute

public XMLTag setAttribute(XMLName inAttributeName,
                           Object inValue)

Specified by:

setAttribute in interface XMLNode

setAttribute

public XMLTag setAttribute(XMLAttribute inAttribute)

Specified by:

setAttribute in interface XMLNode

setAttributes

public void setAttributes(Collection<XMLAttribute> inAttributes)

Takes a Collection of XMLAttribute objects as input.

Specified by:

setAttributes in interface XMLNode

Parameters:

inAttributes - the attributes to add to the xml node

getAttribute

public XMLAttribute getAttribute(XMLName inAttributeName)

Specified by:

getAttribute in interface XMLNode

getAttribute

public XMLAttribute getAttribute(String inAttributeName)

Specified by:

getAttribute in interface XMLNode

hasAttributes

public boolean hasAttributes()

Specified by:

hasAttributes in interface XMLNode

hasAttribute

public boolean hasAttribute(XMLName inAttributeName)

Specified by:

hasAttribute in interface XMLNode

hasAttribute

public boolean hasAttribute(String inAttributeName)

Specified by:

hasAttribute in interface XMLNode

getAttributeValue

public String getAttributeValue(XMLName inAttributeName)

Specified by:

getAttributeValue in interface XMLNode

getAttributeValue

public String getAttributeValue(String inAttributeName)

Specified by:

getAttributeValue in interface XMLNode

getAttributes

public Collection<XMLAttribute> getAttributes()

Returns a Collection of XMLAttribute objects.

Specified by:

getAttributes in interface XMLNode

Returns:

the attribute objects from this XML node

removeAttribute

public XMLAttribute removeAttribute(String inAttributeName)

Specified by:

removeAttribute in interface XMLNode

removeAttribute

public XMLAttribute removeAttribute(XMLName inAttributeName)

Specified by:

removeAttribute in interface XMLNode

getNamespace

public XMLNamespace getNamespace()

Specified by:

getNamespace in interface XMLNode

setNamespace

public XMLTag setNamespace(XMLNamespace inValue)

Specified by:

setNamespace in interface XMLNode

setDefaultXMLNamespaceDeclaration

public XMLTag setDefaultXMLNamespaceDeclaration(XMLNamespace inValue)

addXMLNamespaceDeclaration

public XMLTag addXMLNamespaceDeclaration(XMLNamespace inValue)

findNodesByAttributeValue

public List<? extends XMLNode> findNodesByAttributeValue(XMLName inAttribute,
                                                         String inValue)

Returns a List of all nodes with the specified attribute name and specified attribute value.

Specified by:

findNodesByAttributeValue in interface XMLNode

findNodesByAttributeValue

public List<? extends XMLNode> findNodesByAttributeValue(String inAttribute,
                                                         String inValue)

Returns a List of all nodes with the specified attribute name and specified attribute value.

Specified by:

findNodesByAttributeValue in interface XMLNode

toString

public String toString()

Overrides:

toString in class Object

toXML

public String toXML()

Specified by:

toXML in interface XMLizable

toXML

public void toXML(OutputStream inStream)

Specified by:

toXML in interface XMLizable

toXML

public void toXML(Writer inWriter)

Specified by:

toXML in interface XMLizable

toXML

protected void toXML(Writer inWriter,
                     XMLNamespaceSet inDeclaredNamespaces)

toIndentedXML

public String toIndentedXML(int inInitialIndentLevel,
                            int inIndentSize)

Specified by:

toIndentedXML in interface XMLizable

toIndentedXML

public void toIndentedXML(OutputStream inOutputStream,
                          int inInitialIndentLevel,
                          int inIndentSize)

Writes out the tag (and any subtags) to te specified OutputStream. Note that the OutputStream is not closed by this method.

Specified by:

toIndentedXML in interface XMLizable

Parameters:

inOutputStream - OutputStream to which the XML is written.

toIndentedXML

public void toIndentedXML(Writer inWriter,
                          int inInitialIndentLevel,
                          int inIndentSize)

Specified by:

toIndentedXML in interface XMLizable

toIndentedXML

public void toIndentedXML(Writer inWriter,
                          int inInitialIndentLevel,
                          int inIndentSize,
                          XMLNamespaceSet inDeclaredNamespaces)

Specified by:

toIndentedXML in interface XMLNode

replaceCharacterEntities

public void replaceCharacterEntities()

Specified by:

replaceCharacterEntities in interface XMLNode

sortAttributes

protected void sortAttributes(List<XMLAttribute> inAttributes)