Method Detail

• getAttributesAsMap

  public static Map<String,String> getAttributesAsMap(Node node)

  Gets the DOM attributes of the given Node as a Map.

• setMapAsAttributes

  public static void setMapAsAttributes(Element element,
                        Map<String,String> attributes)

  Sets the Map as DOM attributes on the given Element.

  This implementation uses element.setAttribute. Therefore if the element already has attributes, the new attributes are added amongst them. If attributes with the same name already exist, they are overwritten. To remove attributes from the given Element, put them in the Map with a null value.

• getChildNamed

  public static Element getChildNamed(Element element,
                      String... names)

  Looks up a child with the given (local) name.

  An array of several names may be passed, in which case they will be traversed in a simple XPath-like fashion.

  Returns:

  the child with the given name, or null if no such child

• getChildWithAttribute

  public static Element getChildWithAttribute(Element element,
                              String attributeName)

• getChildWithAttributeValue

  public static Element getChildWithAttributeValue(Element element,
                                   String attributeName,
                                   String attributeValue)

• getSiblingNamed

  public static Element getSiblingNamed(Element element,
                        String name)

  Gets the next sibling to the given element with the given name.

  Returns:

  the next sibling, or null if no such sibling

• getSiblingWithAttribute

  public static Element getSiblingWithAttribute(Element element,
                                String attributeName)

  Gets the next sibling to the given element with the given attribute.

  Returns:

  the next sibling, or null if no such sibling

• importElement

  public static Element importElement(Document document,
                      Element element)

• documentToString

  public static String documentToString(Document document,
                        boolean pretty)

  Convert the given Document to an XML String.

  This method is a simplified version of...

  ByteArrayOutputStream out = new ByteArrayOutputStream(); javax.xml.Transformer transformer = TransformerFactory.newInstance().newTransformer(); transformer.transform( new DOMSource( node ), new StreamResult( out )); return out.toString();

  ...but not all platforms (eg. Android) support javax.xml.transform.Transformer.

• nodeToString

  public static String nodeToString(Node node,
                    boolean pretty)

  See documentToString.

• documentFromString

  public static Document documentFromString(String xml)

  Converts the given XML into a org.w3c.dom.Document.

  Named documentFromString, rather than just parse, because DocumentBuilder.parse( String ) already exists and, confusingly, uses the String as a URI to the XML rather than as the XML itself.

  Note: in performance tests, this method was consistently found to be expensive, of the order of around 10%. Consider implementing DomInspector on your Inspectors or DomInspectionResultProcessor on your InspectionResultProcessors to avoid this hit.

• newDocument

  public static Document newDocument()

  Creates a new Document built from a shared, no-external-connection-making DocumentBuilder created by a namespace-aware, comment-ignoring, whitespace-ignoring DocumentBuilderFactory.

• parse

  public static Document parse(InputStream stream)
                        throws IOException,
                               SAXException

  Throws:

  IOException

  SAXException

• getFirstChildElement

  public static Element getFirstChildElement(Element parent)

  Get the indexed Element.

  Similar to Element.getChildNodes.item, but ignores any Nodes (such as indentation TextNodes).

• getNextSiblingElement

  public static Element getNextSiblingElement(Element element)

• combineElements

  public static void combineElements(Element master,
                     Element toAdd,
                     String topLevelAttributeToCombineOn,
                     String childAttributeToCombineOn)

  Combine the attributes and child elements of the second element into the first element.

  Combining is performed purely by matching a topLevelAttributeToCombineOn attribute on the element. The child element ordering of the first element is respected.

  Child elements are matched recursively on childAttributeToCombineOn.

• inspectionResultToJsonSchema

  public static String inspectionResultToJsonSchema(Element inspectionResult)

  Convert the given Element to a JSON Schema (v3) String.

  If converting inspection-result DOMs into JSON Schemas, consider using this method in conjunction with JsonSchemaMappingProcessor and JsonTypeMappingProcessor. The result is directly compatible with the JavaScript versions of Metawidget. It can therefore be returned by REST services (see http://blog.kennardconsulting.com/2013/02/metawidget-and-rest.html).

• getLocalName

  public static String getLocalName(Node node)

  Gets the localName of the given node. Or the nodeName if the localName returns null (as we've seen it do on Android)