com.hfg.xml

Interface XMLNode

All Superinterfaces:

Cloneable, XMLContainer, XMLizable

All Known Subinterfaces:

HTMLNode, SvgNode

All Known Implementing Classes:

AbstractSvgNode, Applet, Area, Body, Center, CheckboxSpan, ClickLabelSpan, Col, Colgroup, CreativeCommons_Work, Div, DmlBevelLineJoin, DmlBlip, DmlBlipFill, DmlColor, DmlColorScheme, DmlEffect, DmlEffectRef, DmlEffectStyle, DmlExtents, DmlFill, DmlFillRef, DmlFontRef, DmlFontScheme, DmlFormatScheme, DmlGradientFill, DmlGradientStop, DmlGraphic, DmlGraphicData, DmlGraphicFrameLocks, DmlLine, DmlLineDash, DmlLineEnd, DmlLineHeadEnd, DmlLineJoin, DmlLineRef, DmlLineTailEnd, DmlMajorFont, DmlMinorFont, DmlMiterLineJoin, DmlNoFill, DmlNonVisualDrawingProperties, DmlNonVisualPictureDrawingProperties, DmlNonVisualPictureProperties, DmlNonVisualShapeDrawingProperties, DmlNonVisualShapeProperties, DmlParagraph, DmlPicture, DmlPictureLocks, DmlPresetGeometry, DmlPresetLineDash, DmlRoundLineJoin, DmlSchemeColor, DmlShape, DmlShapeAdjustValues, DmlShapeProperties, DmlSolidFill, DmlSrcRect, DmlSRGBColor, DmlStretch, DmlText, DmlTextBody, DmlTextBodyProperties, DmlTextRun, DmlTextRunProperties, DmlTheme, DmlThemeElements, DmlTransform, DublinCore, DublinCore_Format, DublinCore_Title, DublinCore_Type, Em, ExcelBorder, ExcelCell, ExcelColumn, ExcelComment, ExcelData, ExcelFont, ExcelRow, ExcelStyle, ExcelTable, ExcelWorkbook, ExcelWorksheet, ExcelWorksheetOptions, Form, Frame, Frameset, H1, H2, H3, Head, Hr, HTML, HTMLTag, HTMLTagWithCoreEvents, HTMLTagWithFormEvents, IFrame, ImageMap, Img, InputButton, InputCheckbox, InputFile, InputHidden, InputPassword, InputRadio, InputReset, InputSubmit, InputText, Label, Li, Link, Meta, MultiSelectExpander, Nobr, ObjectTag, OfficeOpenXMLTag, Ol, OptGroup, Option, P, Param, Pre, RDF, Script, Select, Span, SsDrawAbsoluteAnchor, SsDrawDrawingAnchor, SsDrawNonVisualDrawingProperties, SsDrawNonVisualShapeDrawingProperties, SsDrawNonVisualShapeProperties, SsDrawOneCellAnchor, SsDrawShape, SsDrawShapeProperties, SsDrawShapeStyle, SsDrawTextBody, SsDrawTwoCellAnchor, SsmlAlignment, SsmlBorder, SsmlCell, SsmlCellFormat, SsmlCellStyle, SsmlCfColorScaleRule, SsmlCfRule, SsmlCol, SsmlColorScale, SsmlConditionalFormatting, SsmlDataBar, SsmlDataValidation, SsmlDifferentialFormat, SsmlExtension, SsmlFill, SsmlFont, SsmlHeaderFooter, SsmlNumberFormat, SsmlPageMargins, SsmlPane, SsmlRow, SsmlSheetData, SsmlSheetFormatProperties, SsmlSheetView, SsmlSortState, SsmlStyleFormat, SsmlTable, SsmlTextRun, SsmlTextRunProperties, SsmlWorkbook, SsmlWorkbookProperties, SsmlWorkbookView, SsmlWorksheet, SsmlXMLTag, StyleTag, SVG, SvgCircle, SvgDefs, SvgDesc, SvgEllipse, SvgFeBlend, SvgFeColorMatrix, SvgFeComponentTransfer, SvgFeComposite, SvgFeConvolveMatrix, SvgFeDiffuseLighting, SvgFeDisplacementMap, SvgFeDistantLight, SvgFeFlood, SvgFeFunc, SvgFeFuncA, SvgFeFuncB, SvgFeFuncG, SvgFeFuncR, SvgFeGaussianBlur, SvgFeImage, SvgFeMerge, SvgFeMergeNode, SvgFeMorphology, SvgFeOffset, SvgFePointLight, SvgFeSpecularLighting, SvgFeSpotLight, SvgFeTile, SvgFeTurbulence, SvgFilter, SvgForeignObject, SvgGroup, SvgLightSource, SvgLine, SvgLink, SvgMarker, SvgMetadata, SvgPath, SvgPolygon, SvgPolyline, SvgRect, SvgScript, SvgSwitch, SvgSymbol, SvgText, SvgTitle, SvgTSpan, SvgUse, TabbedPaneSet, Table, TBody, Td, Textarea, TextareaExpander, TFoot, Th, THead, Tr, Ul, WmlAbstractNumbering, WmlBody, WmlBorder, WmlCharacterStyle, WmlComments, WmlCommonDrawingMLNonVisualProperties, WmlComplexField, WmlContentContainer, WmlDocDefaults, WmlDrawing, WmlDrawingObjNonVisualProperties, WmlEffectExtent, WmlFooter, WmlHeader, WmlHyperlink, WmlIndentation, WmlInline, WmlLineBorder, WmlList, WmlListProperties, WmlNumberingLevelDef, WmlNumberingProperties, WmlNumberingStyle, WmlOrderedList, WmlPageMargins, WmlPageSize, WmlParagraph, WmlParagraphBorder, WmlParagraphProperties, WmlParagraphStyle, WmlSectionProperties, WmlShading, WmlSimpleField, WmlSpacing, WmlStructuredDocumentTag, WmlStructuredDocumentTagContent, WmlStructuredDocumentTagEndProperties, WmlStructuredDocumentTagProperties, WmlStyle, WmlStyles, WmlSubDoc, WmlTab, WmlTable, WmlTableBorders, WmlTableCell, WmlTableCellBorders, WmlTableCellMargins, WmlTableCellProperties, WmlTableProperties, WmlTableRow, WmlTableRowProperties, WmlTableStyle, WmlTableStyleProperties, WmlText, WmlTextBorder, WmlTextRun, WmlTextRunProperties, WmlUnorderedList, WmlXMLTag, WorksheetDrawing, XMLTag

public interface XMLNode
extends XMLContainer

Interface for an XML node. See XMLTag for an implementation.

Method Summary

Modifier and Type	Method and Description
List<? extends XMLNode>	findNodesByAttributeValue(String inAttribute, String inValue)
List<? extends XMLNode>	findNodesByAttributeValue(XMLName inAttribute, String inValue)
XMLAttribute	getAttribute(String inAttributeName)
XMLAttribute	getAttribute(XMLName inAttributeName)
Collection<XMLAttribute>	getAttributes() Returns a Set of XMLAttribute objects.
String	getAttributeValue(String inAttributeName)
String	getAttributeValue(XMLName inAttributeName)
XMLNamespace	getNamespace()
String	getTagName()
boolean	hasAttribute(String inAttributeName)
boolean	hasAttribute(XMLName inAttributeName)
boolean	hasAttributes()
boolean	isEmptyTag()
XMLAttribute	removeAttribute(String inAttributeName)
XMLAttribute	removeAttribute(XMLName inAttributeName)
void	replaceCharacterEntities()
XMLNode	setAttribute(String inAttributeName, Object inValue)
XMLNode	setAttribute(XMLAttribute inAttribute)
XMLNode	setAttribute(XMLName inAttributeName, Object inValue)
void	setAttributes(Collection<XMLAttribute> inAttributes) Takes a Collection of XMLAttribute objects as input.
XMLNode	setNamespace(XMLNamespace inValue)
XMLNode	setTagName(String inName)
XMLTag	setTagName(XMLName inName)
void	toIndentedXML(Writer inWriter, int inInitialIndentLevel, int inIndentSize, XMLNamespaceSet inDeclaredNamespaces)
void	verifyTagName(String inTagName)
void	verifyTagName(String inTagName, Case inCaseSensitivity)
void	verifyTagName(XMLName inTagName)
void	verifyTagName(XMLName inTagName, Case inCaseSensitivity)

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, setContent, setParentNode, setSubtags

Methods inherited from interface com.hfg.xml.XMLizable

clone, toIndentedXML, toIndentedXML, toIndentedXML, toXML, toXML, toXML

Method Detail

isEmptyTag

boolean isEmptyTag()

setTagName

XMLTag setTagName(XMLName inName)

setTagName

XMLNode setTagName(String inName)

getTagName

String getTagName()

verifyTagName

void verifyTagName(String inTagName)

verifyTagName

void verifyTagName(String inTagName,
                   Case inCaseSensitivity)

verifyTagName

void verifyTagName(XMLName inTagName)

verifyTagName

void verifyTagName(XMLName inTagName,
                   Case inCaseSensitivity)

getNamespace

XMLNamespace getNamespace()

setNamespace

XMLNode setNamespace(XMLNamespace inValue)

setAttribute

XMLNode setAttribute(String inAttributeName,
                     Object inValue)

setAttribute

XMLNode setAttribute(XMLName inAttributeName,
                     Object inValue)

setAttribute

XMLNode setAttribute(XMLAttribute inAttribute)

setAttributes

void setAttributes(Collection<XMLAttribute> inAttributes)

Takes a Collection of XMLAttribute objects as input.

Parameters:

inAttributes - the attributes to add to the xml node

getAttribute

XMLAttribute getAttribute(String inAttributeName)

getAttribute

XMLAttribute getAttribute(XMLName inAttributeName)

getAttributeValue

String getAttributeValue(String inAttributeName)

getAttributeValue

String getAttributeValue(XMLName inAttributeName)

getAttributes

Collection<XMLAttribute> getAttributes()

Returns a Set of XMLAttribute objects.

Returns:

the attribute objects from this XML node

hasAttributes

boolean hasAttributes()

hasAttribute

boolean hasAttribute(String inAttributeName)

hasAttribute

boolean hasAttribute(XMLName inAttributeName)

removeAttribute

XMLAttribute removeAttribute(String inAttributeName)

removeAttribute

XMLAttribute removeAttribute(XMLName inAttributeName)

findNodesByAttributeValue

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

findNodesByAttributeValue

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

toIndentedXML

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

replaceCharacterEntities

void replaceCharacterEntities()