org.eclipse.gemini.blueprint.blueprint.config.internal

Class BlueprintParser

java.lang.Object

org.eclipse.gemini.blueprint.blueprint.config.internal.BlueprintParser

public class BlueprintParser
extends java.lang.Object

Stateful class that handles the parsing details of a <component> elements. Borrows heavily from BeanDefinitionParserDelegate. Note: Due to its stateful nature, this class is not thread safe. Note: Since the namespace is important when parsing elements and since mixed elements, from both rfc124 and Spring can coexist in the same file, reusing the delegate isn't entirely possible since the two state needs to be kept in synch.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	BEAN
static java.lang.String	COMPONENT_ID_ATTR
static java.lang.String	CONSTRUCTOR_ARG
static java.lang.String	DECLARED_SCOPE
private BlueprintDefaultsDefinition	defaults
private static java.lang.String	EAGER_INIT_VALUE
private static java.lang.String	FACTORY_REF_ATTR
private static java.lang.String	LAZY_INIT_ATTR
private static java.lang.String	LAZY_INIT_VALUE
private static org.apache.commons.logging.Log	log logger
static java.lang.String	NAMESPACE_URI
private org.springframework.beans.factory.xml.ParserContext	parserContext
private org.springframework.beans.factory.parsing.ParseState	parseState
private java.util.Collection<java.lang.String>	usedNames

Constructor Summary

Constructors

Modifier	Constructor and Description
	BlueprintParser()
private	BlueprintParser(org.springframework.beans.factory.xml.ParserContext parserContext) Constructs a new ComponentParser instance.
	BlueprintParser(org.springframework.beans.factory.parsing.ParseState parseState, java.util.Collection<java.lang.String> usedNames)

Method Summary

Modifier and Type	Method and Description
private org.springframework.beans.factory.config.TypedStringValue	buildTypedStringValue(java.lang.String value, java.lang.String targetTypeName) Build a typed String value Object for the given raw value.
private java.lang.Object	buildTypedStringValueForMap(java.lang.String value, java.lang.String defaultTypeName, org.w3c.dom.Element entryEle) Build a typed String value Object for the given raw value.
private boolean	checkNameUniqueness(java.lang.String beanName, java.util.Collection<java.lang.String> aliases, java.util.Collection<java.lang.String> usedNames) Validate that the specified bean name and aliases have not been used already.
private void	error(java.lang.String message, org.w3c.dom.Node source) Reports an error with the given message for the given source element.
private void	error(java.lang.String message, org.w3c.dom.Node source, java.lang.Throwable cause) Reports an error with the given message for the given source element.
private java.lang.Object	extractSource(org.w3c.dom.Element ele)
private BlueprintDefaultsDefinition	getDefaults(org.w3c.dom.Element ele)
org.springframework.beans.factory.config.BeanDefinition	parse(org.w3c.dom.Element componentElement, org.springframework.beans.factory.xml.ParserContext parserContext)
java.lang.Object	parseArrayElement(org.w3c.dom.Element arrayEle, org.springframework.beans.factory.config.BeanDefinition bd) Parse an array element.
org.springframework.beans.factory.config.BeanDefinitionHolder	parseAsHolder(org.w3c.dom.Element componentElement, org.springframework.beans.factory.xml.ParserContext parserContext)
private org.springframework.beans.factory.support.AbstractBeanDefinition	parseAttributes(org.w3c.dom.Element ele, java.lang.String beanName, org.springframework.beans.factory.support.AbstractBeanDefinition beanDefinition)
private org.springframework.beans.factory.support.AbstractBeanDefinition	parseBeanDefinitionElement(org.w3c.dom.Element ele, java.lang.String beanName, org.springframework.beans.factory.config.BeanDefinition containingBean) Parse the bean definition itself, without regard to name or aliases.
protected void	parseCollectionElements(org.w3c.dom.NodeList elementNodes, java.util.Collection<java.lang.Object> target, org.springframework.beans.factory.config.BeanDefinition bd, java.lang.String defaultElementType)
private org.springframework.beans.factory.config.BeanDefinitionHolder	parseComponentDefinitionElement(org.w3c.dom.Element ele, org.springframework.beans.factory.config.BeanDefinition containingBean) Parses the supplied <bean> element.
private void	parseConstructorArgElement(org.w3c.dom.Element ele, org.springframework.beans.factory.support.AbstractBeanDefinition beanDefinition)
private void	parseConstructorArgElements(org.w3c.dom.Element ele, org.springframework.beans.factory.support.AbstractBeanDefinition beanDefinition) Parsers contructor arguments.
private java.lang.Object	parseIdRefElement(org.w3c.dom.Element ele)
private java.lang.Object	parseKeyElement(org.w3c.dom.Element keyEle, org.springframework.beans.factory.config.BeanDefinition bd, java.lang.String defaultKeyTypeName) Parse a key sub-element of a map element.
java.util.List<?>	parseListElement(org.w3c.dom.Element collectionEle, org.springframework.beans.factory.config.BeanDefinition bd) Parse a list element.
java.util.Map<?,?>	parseMapElement(org.w3c.dom.Element mapEle, org.springframework.beans.factory.config.BeanDefinition bd) Parse a map element.
private boolean	parseMergeAttribute(org.w3c.dom.Element element)
private void	parsePropertyElement(org.w3c.dom.Element ele, org.springframework.beans.factory.config.BeanDefinition bd)
private void	parsePropertyElements(org.w3c.dom.Element ele, org.springframework.beans.factory.support.AbstractBeanDefinition beanDefinition) Parses property elements.
static java.util.Map<?,?>	parsePropertyMapElement(org.springframework.beans.factory.xml.ParserContext parserContext, org.w3c.dom.Element ele, org.springframework.beans.factory.config.BeanDefinition bd)
static java.util.Set<?>	parsePropertySetElement(org.springframework.beans.factory.xml.ParserContext parserContext, org.w3c.dom.Element ele, org.springframework.beans.factory.config.BeanDefinition bd)
private java.lang.Object	parsePropertySubElement(org.w3c.dom.Element ele, org.springframework.beans.factory.config.BeanDefinition bd, java.lang.String defaultValueType) Parse a value, ref or collection sub-element of a property or constructor-arg element.
static java.lang.Object	parsePropertySubElement(org.springframework.beans.factory.xml.ParserContext parserContext, org.w3c.dom.Element ele, org.springframework.beans.factory.config.BeanDefinition bd)
private java.lang.Object	parsePropertyValue(org.w3c.dom.Element ele, org.springframework.beans.factory.config.BeanDefinition bd, java.lang.String propertyName)
java.util.Properties	parsePropsElement(org.w3c.dom.Element propsEle) Parse a props element.
private java.lang.Object	parseRefElement(org.w3c.dom.Element ele)
java.util.Set<?>	parseSetElement(org.w3c.dom.Element collectionEle, org.springframework.beans.factory.config.BeanDefinition bd) Parse a set element.
private java.lang.Object	parseValueElement(org.w3c.dom.Element ele, java.lang.String defaultTypeName) Return a typed String value Object for the given value element.

Methods inherited from class java.lang.Object

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

Field Detail

log

private static final org.apache.commons.logging.Log log

logger

BEAN

public static final java.lang.String BEAN

See Also:

Constant Field Values

COMPONENT_ID_ATTR

public static final java.lang.String COMPONENT_ID_ATTR

See Also:

Constant Field Values

CONSTRUCTOR_ARG

public static final java.lang.String CONSTRUCTOR_ARG

See Also:

Constant Field Values

FACTORY_REF_ATTR

private static final java.lang.String FACTORY_REF_ATTR

See Also:

Constant Field Values

LAZY_INIT_ATTR

private static final java.lang.String LAZY_INIT_ATTR

See Also:

Constant Field Values

LAZY_INIT_VALUE

private static final java.lang.String LAZY_INIT_VALUE

See Also:

Constant Field Values

EAGER_INIT_VALUE

private static final java.lang.String EAGER_INIT_VALUE

See Also:

Constant Field Values

NAMESPACE_URI

public static final java.lang.String NAMESPACE_URI

See Also:

Constant Field Values

DECLARED_SCOPE

public static final java.lang.String DECLARED_SCOPE

See Also:

Constant Field Values

parseState

private final org.springframework.beans.factory.parsing.ParseState parseState

usedNames

private final java.util.Collection<java.lang.String> usedNames

parserContext

private org.springframework.beans.factory.xml.ParserContext parserContext

defaults

private BlueprintDefaultsDefinition defaults

Constructor Detail

BlueprintParser

public BlueprintParser()

BlueprintParser

private BlueprintParser(org.springframework.beans.factory.xml.ParserContext parserContext)

Constructs a new ComponentParser instance. Used by certain reusable static methods.

Parameters:

parserContext -

BlueprintParser

public BlueprintParser(org.springframework.beans.factory.parsing.ParseState parseState,
                       java.util.Collection<java.lang.String> usedNames)

Method Detail

parseAsHolder

public org.springframework.beans.factory.config.BeanDefinitionHolder parseAsHolder(org.w3c.dom.Element componentElement,
                                                                                   org.springframework.beans.factory.xml.ParserContext parserContext)

parse

public org.springframework.beans.factory.config.BeanDefinition parse(org.w3c.dom.Element componentElement,
                                                                     org.springframework.beans.factory.xml.ParserContext parserContext)

parseComponentDefinitionElement

private org.springframework.beans.factory.config.BeanDefinitionHolder parseComponentDefinitionElement(org.w3c.dom.Element ele,
                                                                                                      org.springframework.beans.factory.config.BeanDefinition containingBean)

Parses the supplied <bean> element. May return null if there were errors during parse. Errors are reported to the ProblemReporter.

parseBeanDefinitionElement

private org.springframework.beans.factory.support.AbstractBeanDefinition parseBeanDefinitionElement(org.w3c.dom.Element ele,
                                                                                                    java.lang.String beanName,
                                                                                                    org.springframework.beans.factory.config.BeanDefinition containingBean)

Parse the bean definition itself, without regard to name or aliases. May return null if problems occurred during the parse of the bean definition.

parseAttributes

private org.springframework.beans.factory.support.AbstractBeanDefinition parseAttributes(org.w3c.dom.Element ele,
                                                                                         java.lang.String beanName,
                                                                                         org.springframework.beans.factory.support.AbstractBeanDefinition beanDefinition)

checkNameUniqueness

private boolean checkNameUniqueness(java.lang.String beanName,
                                    java.util.Collection<java.lang.String> aliases,
                                    java.util.Collection<java.lang.String> usedNames)

Validate that the specified bean name and aliases have not been used already.

parseConstructorArgElements

private void parseConstructorArgElements(org.w3c.dom.Element ele,
                                         org.springframework.beans.factory.support.AbstractBeanDefinition beanDefinition)

Parsers contructor arguments.

Parameters:

ele -

beanDefinition -

parserContext -

parseConstructorArgElement

private void parseConstructorArgElement(org.w3c.dom.Element ele,
                                        org.springframework.beans.factory.support.AbstractBeanDefinition beanDefinition)

parsePropertyElements

private void parsePropertyElements(org.w3c.dom.Element ele,
                                   org.springframework.beans.factory.support.AbstractBeanDefinition beanDefinition)

Parses property elements.

Parameters:

ele -

beanDefinition -

parserContext -

parsePropertyElement

private void parsePropertyElement(org.w3c.dom.Element ele,
                                  org.springframework.beans.factory.config.BeanDefinition bd)

parsePropertyValue

private java.lang.Object parsePropertyValue(org.w3c.dom.Element ele,
                                            org.springframework.beans.factory.config.BeanDefinition bd,
                                            java.lang.String propertyName)

parsePropertySubElement

public static java.lang.Object parsePropertySubElement(org.springframework.beans.factory.xml.ParserContext parserContext,
                                                       org.w3c.dom.Element ele,
                                                       org.springframework.beans.factory.config.BeanDefinition bd)

parsePropertyMapElement

public static java.util.Map<?,?> parsePropertyMapElement(org.springframework.beans.factory.xml.ParserContext parserContext,
                                                         org.w3c.dom.Element ele,
                                                         org.springframework.beans.factory.config.BeanDefinition bd)

parsePropertySetElement

public static java.util.Set<?> parsePropertySetElement(org.springframework.beans.factory.xml.ParserContext parserContext,
                                                       org.w3c.dom.Element ele,
                                                       org.springframework.beans.factory.config.BeanDefinition bd)

parsePropertySubElement

private java.lang.Object parsePropertySubElement(org.w3c.dom.Element ele,
                                                 org.springframework.beans.factory.config.BeanDefinition bd,
                                                 java.lang.String defaultValueType)

Parse a value, ref or collection sub-element of a property or constructor-arg element. This method is called from several places to handle reusable elements such as idref, ref, null, value and so on. In fact, this method is the main reason why the BeanDefinitionParserDelegate is not used in full since the element namespace becomes important as mixed rfc124/bean content can coexist.

Parameters:

ele - subelement of property element; we don't know which yet

defaultValueType - the default type (class name) for any <value> tag that might be created

parseRefElement

private java.lang.Object parseRefElement(org.w3c.dom.Element ele)

parseIdRefElement

private java.lang.Object parseIdRefElement(org.w3c.dom.Element ele)

parseValueElement

private java.lang.Object parseValueElement(org.w3c.dom.Element ele,
                                           java.lang.String defaultTypeName)

Return a typed String value Object for the given value element.

Parameters:

ele - element

defaultTypeName - type class name

Returns:

typed String value Object

buildTypedStringValue

private org.springframework.beans.factory.config.TypedStringValue buildTypedStringValue(java.lang.String value,
                                                                                        java.lang.String targetTypeName)
                                                                                 throws java.lang.ClassNotFoundException

Build a typed String value Object for the given raw value.

Throws:

java.lang.ClassNotFoundException

See Also:

TypedStringValue

parseArrayElement

public java.lang.Object parseArrayElement(org.w3c.dom.Element arrayEle,
                                          org.springframework.beans.factory.config.BeanDefinition bd)

Parse an array element.

parseListElement

public java.util.List<?> parseListElement(org.w3c.dom.Element collectionEle,
                                          org.springframework.beans.factory.config.BeanDefinition bd)

Parse a list element.

parseSetElement

public java.util.Set<?> parseSetElement(org.w3c.dom.Element collectionEle,
                                        org.springframework.beans.factory.config.BeanDefinition bd)

Parse a set element.

parseCollectionElements

protected void parseCollectionElements(org.w3c.dom.NodeList elementNodes,
                                       java.util.Collection<java.lang.Object> target,
                                       org.springframework.beans.factory.config.BeanDefinition bd,
                                       java.lang.String defaultElementType)

parseMapElement

public java.util.Map<?,?> parseMapElement(org.w3c.dom.Element mapEle,
                                          org.springframework.beans.factory.config.BeanDefinition bd)

Parse a map element.

parsePropsElement

public java.util.Properties parsePropsElement(org.w3c.dom.Element propsEle)

Parse a props element.

parseMergeAttribute

private boolean parseMergeAttribute(org.w3c.dom.Element element)

buildTypedStringValueForMap

private java.lang.Object buildTypedStringValueForMap(java.lang.String value,
                                                     java.lang.String defaultTypeName,
                                                     org.w3c.dom.Element entryEle)

Build a typed String value Object for the given raw value.

See Also:

TypedStringValue

parseKeyElement

private java.lang.Object parseKeyElement(org.w3c.dom.Element keyEle,
                                         org.springframework.beans.factory.config.BeanDefinition bd,
                                         java.lang.String defaultKeyTypeName)

Parse a key sub-element of a map element.

extractSource

private java.lang.Object extractSource(org.w3c.dom.Element ele)

error

private void error(java.lang.String message,
                   org.w3c.dom.Node source)

Reports an error with the given message for the given source element.

error

private void error(java.lang.String message,
                   org.w3c.dom.Node source,
                   java.lang.Throwable cause)

Reports an error with the given message for the given source element.

getDefaults

private BlueprintDefaultsDefinition getDefaults(org.w3c.dom.Element ele)