com.mycila.xmltool

Class XMLDoc

public final class XMLDoc extends Object implements XMLTag

Author: Mathieu Carbou (mathieu.carbou@gmail.com)

Method Summary
XMLTagaddAttribute(String name, String value)
XMLTagaddAttribute(Attr attr)
XMLTagaddCDATA(String data)
XMLTagaddCDATA(CDATASection data)
XMLTagaddDocument(XMLTag tag)
XMLTagaddDocument(Document doc)
XMLTagaddNamespace(String prefix, String namespaceURI)
XMLTagaddTag(XMLTag tag)
XMLTagaddTag(Element tag)
XMLTagaddTag(String name)
XMLTagaddText(String text)
XMLTagaddText(Text text)
XMLTagdelete()
XMLTagdeleteAttribute(String name)
XMLTagdeleteAttributeIfExists(String name)
XMLTagdeleteAttributes()
XMLTagdeleteChilds()
XMLTagdeletePrefixes()
XMLTagduplicate()
StringfindAttribute(String name)
StringfindAttribute(String name, String relativeXpath, Object... arguments)
XMLTagforEach(CallBack callBack, String relativeXpath, Object... arguments)
XMLTagforEach(String xpath, CallBack callBack)
XMLTagforEachChild(CallBack callBack)
static XMLTagfrom(Node node, boolean ignoreNamespaces)
static XMLTagfrom(InputSource source, boolean ignoreNamespaces)
static XMLTagfrom(Reader reader, boolean ignoreNamespaces)
static XMLTagfrom(InputStream is, boolean ignoreNamespaces)
static XMLTagfrom(File file, boolean ignoreNamespaces)
static XMLTagfrom(URL xmlLocation, boolean ignoreNamespaces)
static XMLTagfrom(String xmlData, boolean ignoreNamespaces)
static XMLTagfrom(Source source, boolean ignoreNamespaces)
static XMLTagfrom(XMLTag tag, boolean ignoreNamespaces)
static XMLTagfromCurrentTag(XMLTag tag, boolean ignoreNamespaces)
Create another XMLTag instance from the hierarchy under the current tag.
StringgetAttribute(String name)
StringgetAttribute(String name, String relativeXpath, Object... arguments)
StringgetCDATA(String relativeXpath, Object... arguments)
StringgetCDATA()
StringgetCDATAorText()
StringgetCDATAorText(String relativeXpath, Object... arguments)
intgetChildCount()
List<Element>getChildElement()
Iterable<XMLTag>getChilds()
Iterable<XMLTag>getChilds(String relativeXpath, Object... arguments)
NamespaceContextgetContext()
ElementgetCurrentTag()
StringgetCurrentTagLocation()
StringgetCurrentTagName()
XMLTaggetInnerDocument()
StringgetInnerText()
StringgetPefix(String namespaceURI)
StringgetText(String relativeXpath, Object... arguments)
StringgetText()
StringgetTextOrCDATA()
StringgetTextOrCDATA(String relativeXpath, Object... arguments)
XMLTaggotoChild()
XMLTaggotoChild(int i)
XMLTaggotoChild(String nodeName)
XMLTaggotoFirstChild()
XMLTaggotoFirstChild(String name)
XMLTaggotoLastChild()
XMLTaggotoLastChild(String name)
XMLTaggotoParent()
XMLTaggotoRoot()
XMLTaggotoTag(String relativeXpath, Object... arguments)
booleanhasAttribute(String name)
booleanhasAttribute(String name, String relativeXpath, Object... arguments)
booleanhasTag(String relativeXpath, Object... arguments)
static XMLDocBuildernewDocument(boolean ignoreNamespaces)
BooleanrawXpathBoolean(String relativeXpath, Object... arguments)
NoderawXpathNode(String relativeXpath, Object... arguments)
NodeListrawXpathNodeSet(String relativeXpath, Object... arguments)
NumberrawXpathNumber(String relativeXpath, Object... arguments)
StringrawXpathString(String relativeXpath, Object... arguments)
XMLTagrenameTo(String newNodeName)
XMLTagsetAttribute(String name, String value)
XMLTagsetAttribute(String name, String value, String relativeXpath, Object... arguments)
XMLTagsetAttributeIfExist(String name, String value)
XMLTagsetAttributeIfExist(String name, String value, String relativeXpath, Object... arguments)
XMLTagsetCDATA(String data)
XMLTagsetCDATA(String data, String relativeXpath, Object... arguments)
XMLTagsetCDATAIfExist(String data, String relativeXpath, Object... arguments)
XMLTagsetText(String text)
XMLTagsetText(String text, String relativeXpath, Object... arguments)
XMLTagsetTextIfExist(String text, String relativeXpath, Object... arguments)
byte[]toBytes()
byte[]toBytes(String encoding)
DocumenttoDocument()
OutputStreamtoOutputStream()
OutputStreamtoOutputStream(String encoding)
ResulttoResult()
ResulttoResult(String encoding)
XMLTagtoResult(Result out)
XMLTagtoResult(Result out, String encoding)
SourcetoSource()
XMLTagtoStream(OutputStream out)
XMLTagtoStream(OutputStream out, String encoding)
XMLTagtoStream(Writer out)
XMLTagtoStream(Writer out, String encoding)
StringtoString(String encoding)
WritertoWriter()
WritertoWriter(String encoding)
ValidationResultvalidate(Source... schemas)
ValidationResultvalidate(URL... schemaLocations)

Method Detail

addAttribute

public XMLTag addAttribute(String name, String value)

addAttribute

public XMLTag addAttribute(Attr attr)

addCDATA

public XMLTag addCDATA(String data)

addCDATA

public XMLTag addCDATA(CDATASection data)

addDocument

public XMLTag addDocument(XMLTag tag)

addDocument

public XMLTag addDocument(Document doc)

addNamespace

public XMLTag addNamespace(String prefix, String namespaceURI)

addTag

public XMLTag addTag(XMLTag tag)

addTag

public XMLTag addTag(Element tag)

addTag

public XMLTag addTag(String name)

addText

public XMLTag addText(String text)

addText

public XMLTag addText(Text text)

delete

public XMLTag delete()

deleteAttribute

public XMLTag deleteAttribute(String name)

deleteAttributeIfExists

public XMLTag deleteAttributeIfExists(String name)

deleteAttributes

public XMLTag deleteAttributes()

deleteChilds

public XMLTag deleteChilds()

deletePrefixes

public XMLTag deletePrefixes()

duplicate

public XMLTag duplicate()

findAttribute

public String findAttribute(String name)

findAttribute

public String findAttribute(String name, String relativeXpath, Object... arguments)

forEach

public XMLTag forEach(CallBack callBack, String relativeXpath, Object... arguments)

forEach

public XMLTag forEach(String xpath, CallBack callBack)

forEachChild

public XMLTag forEachChild(CallBack callBack)

from

public static XMLTag from(Node node, boolean ignoreNamespaces)

from

public static XMLTag from(InputSource source, boolean ignoreNamespaces)

from

public static XMLTag from(Reader reader, boolean ignoreNamespaces)

from

public static XMLTag from(InputStream is, boolean ignoreNamespaces)

from

public static XMLTag from(File file, boolean ignoreNamespaces)

from

public static XMLTag from(URL xmlLocation, boolean ignoreNamespaces)

from

public static XMLTag from(String xmlData, boolean ignoreNamespaces)

from

public static XMLTag from(Source source, boolean ignoreNamespaces)

from

public static XMLTag from(XMLTag tag, boolean ignoreNamespaces)

fromCurrentTag

public static XMLTag fromCurrentTag(XMLTag tag, boolean ignoreNamespaces)
Create another XMLTag instance from the hierarchy under the current tag. The current tag becomes the root tag.

Parameters: tag The current XML Tag positionned to the new root tag ignoreNamespaces Wheter to build a namespace aware document

Returns: The inner XMLTag instance

getAttribute

public String getAttribute(String name)

getAttribute

public String getAttribute(String name, String relativeXpath, Object... arguments)

getCDATA

public String getCDATA(String relativeXpath, Object... arguments)

getCDATA

public String getCDATA()

getCDATAorText

public String getCDATAorText()

getCDATAorText

public String getCDATAorText(String relativeXpath, Object... arguments)

getChildCount

public int getChildCount()

getChildElement

public List<Element> getChildElement()

getChilds

public Iterable<XMLTag> getChilds()

getChilds

public Iterable<XMLTag> getChilds(String relativeXpath, Object... arguments)

getContext

public NamespaceContext getContext()

getCurrentTag

public Element getCurrentTag()

getCurrentTagLocation

public String getCurrentTagLocation()

getCurrentTagName

public String getCurrentTagName()

getInnerDocument

public XMLTag getInnerDocument()

getInnerText

public String getInnerText()

getPefix

public String getPefix(String namespaceURI)

getText

public String getText(String relativeXpath, Object... arguments)

getText

public String getText()

getTextOrCDATA

public String getTextOrCDATA()

getTextOrCDATA

public String getTextOrCDATA(String relativeXpath, Object... arguments)

gotoChild

public XMLTag gotoChild()

gotoChild

public XMLTag gotoChild(int i)

gotoChild

public XMLTag gotoChild(String nodeName)

gotoFirstChild

public XMLTag gotoFirstChild()

gotoFirstChild

public XMLTag gotoFirstChild(String name)

gotoLastChild

public XMLTag gotoLastChild()

gotoLastChild

public XMLTag gotoLastChild(String name)

gotoParent

public XMLTag gotoParent()

gotoRoot

public XMLTag gotoRoot()

gotoTag

public XMLTag gotoTag(String relativeXpath, Object... arguments)

hasAttribute

public boolean hasAttribute(String name)

hasAttribute

public boolean hasAttribute(String name, String relativeXpath, Object... arguments)

hasTag

public boolean hasTag(String relativeXpath, Object... arguments)

newDocument

public static XMLDocBuilder newDocument(boolean ignoreNamespaces)

rawXpathBoolean

public Boolean rawXpathBoolean(String relativeXpath, Object... arguments)

rawXpathNode

public Node rawXpathNode(String relativeXpath, Object... arguments)

rawXpathNodeSet

public NodeList rawXpathNodeSet(String relativeXpath, Object... arguments)

rawXpathNumber

public Number rawXpathNumber(String relativeXpath, Object... arguments)

rawXpathString

public String rawXpathString(String relativeXpath, Object... arguments)

renameTo

public XMLTag renameTo(String newNodeName)

setAttribute

public XMLTag setAttribute(String name, String value)

setAttribute

public XMLTag setAttribute(String name, String value, String relativeXpath, Object... arguments)

setAttributeIfExist

public XMLTag setAttributeIfExist(String name, String value)

setAttributeIfExist

public XMLTag setAttributeIfExist(String name, String value, String relativeXpath, Object... arguments)

setCDATA

public XMLTag setCDATA(String data)

setCDATA

public XMLTag setCDATA(String data, String relativeXpath, Object... arguments)

setCDATAIfExist

public XMLTag setCDATAIfExist(String data, String relativeXpath, Object... arguments)

setText

public XMLTag setText(String text)

setText

public XMLTag setText(String text, String relativeXpath, Object... arguments)

setTextIfExist

public XMLTag setTextIfExist(String text, String relativeXpath, Object... arguments)

toBytes

public byte[] toBytes()

toBytes

public byte[] toBytes(String encoding)

toDocument

public Document toDocument()

toOutputStream

public OutputStream toOutputStream()

toOutputStream

public OutputStream toOutputStream(String encoding)

toResult

public Result toResult()

toResult

public Result toResult(String encoding)

toResult

public XMLTag toResult(Result out)

toResult

public XMLTag toResult(Result out, String encoding)

toSource

public Source toSource()

toStream

public XMLTag toStream(OutputStream out)

toStream

public XMLTag toStream(OutputStream out, String encoding)

toStream

public XMLTag toStream(Writer out)

toStream

public XMLTag toStream(Writer out, String encoding)

toString

public String toString(String encoding)

toWriter

public Writer toWriter()

toWriter

public Writer toWriter(String encoding)

validate

public ValidationResult validate(Source... schemas)

validate

public ValidationResult validate(URL... schemaLocations)
Copyright © 2008-2010 Mathieu Carbou. All Rights Reserved.