Java XML First Child Element getFirstChildElementsByTagName( Node contextNode, String elementName)

Description

Returns list of the first child element retrieved by tag name from the parent node and null otherwise.

License

Open Source License

Parameter

Parameter	Description
parentNode	parent node.
elementName	element name to found.

Return

list of the first child element

Declaration

public static Collection<Element> getFirstChildElementsByTagName(
        Node contextNode, String elementName) 

Method Source Code

//package com.java2s;
/**/*w  w w.j av a 2s.c o m*/
 * Copyright (C) 2011-2012 The XDocReport Team <xdocreport@googlegroups.com>
 *
 * All rights reserved.
 *
 * Permission is hereby granted, free  of charge, to any person obtaining
 * a  copy  of this  software  and  associated  documentation files  (the
 * "Software"), to  deal in  the Software without  restriction, including
 * without limitation  the rights to  use, copy, modify,  merge, publish,
 * distribute,  sublicense, and/or sell  copies of  the Software,  and to
 * permit persons to whom the Software  is furnished to do so, subject to
 * the following conditions:
 *
 * The  above  copyright  notice  and  this permission  notice  shall  be
 * included in all copies or substantial portions of the Software.
 *
 * THE  SOFTWARE IS  PROVIDED  "AS  IS", WITHOUT  WARRANTY  OF ANY  KIND,
 * EXPRESS OR  IMPLIED, INCLUDING  BUT NOT LIMITED  TO THE  WARRANTIES OF
 * MERCHANTABILITY,    FITNESS    FOR    A   PARTICULAR    PURPOSE    AND
 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
 * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
 * OF CONTRACT, TORT OR OTHERWISE,  ARISING FROM, OUT OF OR IN CONNECTION
 * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 */

import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;

import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;

public class Main {
    /**
     * Returns list of the first child element retrieved by tag name from the parent node and null otherwise.
     * 
     * @param parentNode parent node.
     * @param elementName element name to found.
     * @return list of the first child element
     */
    public static Collection<Element> getFirstChildElementsByTagName(
            Node contextNode, String elementName) {
        Collection<Element> elements = null;
        Element result = null;

        if (contextNode.getNodeType() == Node.DOCUMENT_NODE) {
            result = ((Document) contextNode).getDocumentElement();
            if (!result.getNodeName().equals(elementName)) {
                result = null;
            }
        } else {
            NodeList nodes = contextNode.getChildNodes();
            Node node;
            for (int i = 0; i < nodes.getLength(); i++) {
                node = nodes.item(i);
                if (node.getNodeType() == Node.ELEMENT_NODE
                        && node.getNodeName().equals(elementName)) {
                    if (elements == null) {
                        elements = new ArrayList<Element>();
                    }
                    result = (Element) node;
                    elements.add(result);
                }
            }
        }
        if (elements == null) {
            return Collections.emptyList();
        }
        return elements;
    }
}

Related

1. getFirstChildElementNode(Node node)
2. getFirstChildElementNS(Element elm, String tns, String localName)
3. getFirstChildElementNS(Node parent, String uri)
4. getFirstChildElementNS(Node parent, String[][] elemNames)
5. getFirstChildElementOfName(@Nonnull final Node aStartNode, @Nullable final String sName)
6. getFirstChildElementsByTagName(Node contextNode, String elementName)
7. getFirstChildElementWithName(Element elem, String name)
8. getFirstChildElmtByTag(String aTagName)
9. getFirstChildElmtByTagAndAttribut(Node aNode, String aTagName, String aAttrId, String aAttrValue)