org.carewebframework.shell

Class BaseXmlParser

java.lang.Object

org.springframework.beans.factory.xml.AbstractBeanDefinitionParser

org.springframework.beans.factory.xml.AbstractSingleBeanDefinitionParser

org.carewebframework.shell.BaseXmlParser

All Implemented Interfaces:

org.springframework.beans.factory.xml.BeanDefinitionParser

Direct Known Subclasses:

HelpXmlParser, PluginXmlParser, ThemeXmlParser

public class BaseXmlParser
extends org.springframework.beans.factory.xml.AbstractSingleBeanDefinitionParser

Spring xml configuration file parser extension. This is an abstract base class for implementing CareWeb extensions to the Spring configuration xml schema.

Field Summary

Fields inherited from class org.springframework.beans.factory.xml.AbstractBeanDefinitionParser

ID_ATTRIBUTE, NAME_ATTRIBUTE

Constructor Summary

Constructors

Constructor and Description
BaseXmlParser()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addProperties(Element element, org.springframework.beans.factory.support.BeanDefinitionBuilder builder) Adds all attributes of the specified elements as properties in the current builder.
protected Element	findTag(String tagName, Element element) Find the child element whose tag matches the specified tag name.
protected Object	fromXml(String xml, String tagName) Parses an xml extension from an xml string.
protected String	getNodeName(Node node) Returns the node name.
protected String	getResourcePath(org.springframework.beans.factory.xml.ParserContext parserContext) Return the path of the resource being parsed.
protected NodeList	getTagChildren(String tagName, Element element) Returns the children under the specified tag.

Methods inherited from class org.springframework.beans.factory.xml.AbstractSingleBeanDefinitionParser

doParse, doParse, getBeanClass, getBeanClassName, getParentName, parseInternal

Methods inherited from class org.springframework.beans.factory.xml.AbstractBeanDefinitionParser

parse, postProcessComponentDefinition, registerBeanDefinition, resolveId, shouldFireEvents, shouldGenerateId, shouldGenerateIdAsFallback, shouldParseNameAsAliases

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BaseXmlParser

public BaseXmlParser()

Method Detail

findTag

protected Element findTag(String tagName,
              Element element)

Find the child element whose tag matches the specified tag name.

Parameters:

tagName - Tag name to locate.

element - Parent element whose children are to be searched.

Returns:

The matching node (first occurrence only) or null if not found.

getTagChildren

protected NodeList getTagChildren(String tagName,
                      Element element)

Returns the children under the specified tag. Compensates for namespace usage.

Parameters:

tagName - Name of tag whose children are sought.

element - Element to search for tag.

Returns:

Node list containing children of tag.

addProperties

protected void addProperties(Element element,
                 org.springframework.beans.factory.support.BeanDefinitionBuilder builder)

Adds all attributes of the specified elements as properties in the current builder.

Parameters:

element - Element whose attributes are to be added.

builder - Target builder.

getNodeName

protected String getNodeName(Node node)

Returns the node name. First tries local name. If this is null, returns instead the full node name.

Parameters:

node - DOM node to examine.

Returns:

Name of the node.

fromXml

protected Object fromXml(String xml,
             String tagName)
                  throws Exception

Parses an xml extension from an xml string.

Parameters:

xml - XML containing the extension.

tagName - The top level tag name.

Returns:

Result of the parsed extension.

Throws:

Exception - Unspecified exception.

getResourcePath

protected String getResourcePath(org.springframework.beans.factory.xml.ParserContext parserContext)

Return the path of the resource being parsed.

Parameters:

parserContext - The current parser context.

Returns:

The resource being parsed, or null if cannot be determined.