com.endeca.soleng.eac.toolkit.parsing

Class EacElementDefinitionParser

java.lang.Object

org.springframework.beans.factory.xml.AbstractBeanDefinitionParser

com.endeca.soleng.eac.toolkit.parsing.EacElementDefinitionParser

All Implemented Interfaces:

org.springframework.beans.factory.xml.BeanDefinitionParser

public class EacElementDefinitionParser
extends org.springframework.beans.factory.xml.AbstractBeanDefinitionParser

Class used to parse Elements in the App Configuration document. This object is used to parse all elements, relying on the namespace handler to pre-define what object is to be created by the parser and to specify which elements and attributes to parse. This makes it easy for us to re-use code that parses similar/identical attributes and elements on different elements.

Author:

mhansen

Field Summary

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

ID_ATTRIBUTE, NAME_ATTRIBUTE

Constructor Summary

Constructors

Constructor and Description
EacElementDefinitionParser()

Method Summary

Modifier and Type	Method and Description
protected void	doParse(Element element, org.springframework.beans.factory.support.BeanDefinitionBuilder bean) Does the parsing of the element, and inserts information about the element into the passed BeanDefinitionBuilder.
protected Class<?>	getBeanClass(Element element)
String[]	getCustomAttrs()
String[]	getCustomBeanReferenceAttrs()
String[]	getCustomElements()
String[]	getCustomListElements()
String	getId()
boolean	getIsAbstract()
String	getParentBeanId()
boolean	isElementIdApplicable()
protected void	parseArgElements(String elemName, Element element, org.springframework.beans.factory.support.BeanDefinitionBuilder bean) Element parsing method for multi-assign elements, which are passed using a List (e.g.
protected void	parseAttributes(String[] attributeNames, Element element, org.springframework.beans.factory.support.BeanDefinitionBuilder bean) Parses attributes from an element, setting them as properties in a bean definition builder.
protected void	parseAttributesAsBeanReferences(String[] attributeNames, Element element, org.springframework.beans.factory.support.BeanDefinitionBuilder bean) Parses attributes from an element, setting them as bean references in a bean definition builder.
protected void	parseAttributesAsBeanReferences(String attributeName, String propertyName, Element element, org.springframework.beans.factory.support.BeanDefinitionBuilder bean) Parses attributes from an element, setting them as bean references in a bean definition builder.
protected void	parseChildElementReferences(String elemName, Element element, org.springframework.beans.factory.support.BeanDefinitionBuilder bean) Element parsing method for child elements containing object references.
protected void	parseChildElements(String elemName, Element element, org.springframework.beans.factory.support.BeanDefinitionBuilder bean) Element parsing method for child elements.
protected void	parseClasspath(Element element, org.springframework.beans.factory.support.BeanDefinitionBuilder bean) Element parsing method for multi-assign elements, which are passed using a List (e.g.
protected void	parseElements(String[] elementNames, Element element, org.springframework.beans.factory.support.BeanDefinitionBuilder bean) Parses child elements from an element, setting them as properties in a bean definition builder.
protected org.springframework.beans.factory.support.AbstractBeanDefinition	parseInternal(Element element, org.springframework.beans.factory.xml.ParserContext parserContext) Creates a BeanDefinitionBuilder instance for the bean Class and passes it to the doParse(org.w3c.dom.Element, org.springframework.beans.factory.support.BeanDefinitionBuilder) strategy method.
protected void	parseListElements(String listName, String elemName, Element element, org.springframework.beans.factory.support.BeanDefinitionBuilder bean) Element parsing method for multi-assign elements, which are passed using a List
protected void	parsePropertyElements(String elemName, Element element, org.springframework.beans.factory.support.BeanDefinitionBuilder bean) Element parsing method for multi-assign elements that are passed using a Map (e.g.
protected void	parsePropertyElements(String elemName, Element element, org.springframework.beans.factory.support.BeanDefinitionBuilder bean, boolean mapType) Element parsing method for elements using as child elements and also for multi-assign are passed using a Map (e.g.
protected String	resolveId(Element element, org.springframework.beans.factory.support.AbstractBeanDefinition definition, org.springframework.beans.factory.xml.ParserContext parserContext) Resolve the ID for the supplied BeanDefinition.
void	setBeanClass(Class<?> newClass)
void	setCustomAttrs(String[] attrs)
void	setCustomBeanReferenceAttrs(String[] customBeanReferenceAttrs)
void	setCustomElements(String[] elems)
void	setCustomListElements(String[] customListElements)
void	setElementIdApplicable(boolean applicable)
void	setId(String ID)
void	setIsAbstract(boolean ab)
void	setParentBeanId(String parent)

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

EacElementDefinitionParser

public EacElementDefinitionParser()

Method Detail

setId

public void setId(String ID)

getId

public String getId()

setParentBeanId

public void setParentBeanId(String parent)

getParentBeanId

public String getParentBeanId()

setElementIdApplicable

public void setElementIdApplicable(boolean applicable)

isElementIdApplicable

public boolean isElementIdApplicable()

setBeanClass

public void setBeanClass(Class<?> newClass)

getBeanClass

protected Class<?> getBeanClass(Element element)

setIsAbstract

public void setIsAbstract(boolean ab)

getIsAbstract

public boolean getIsAbstract()

setCustomAttrs

public void setCustomAttrs(String[] attrs)

getCustomAttrs

public String[] getCustomAttrs()

setCustomElements

public void setCustomElements(String[] elems)

getCustomElements

public String[] getCustomElements()

getCustomListElements

public String[] getCustomListElements()

setCustomListElements

public void setCustomListElements(String[] customListElements)

getCustomBeanReferenceAttrs

public String[] getCustomBeanReferenceAttrs()

setCustomBeanReferenceAttrs

public void setCustomBeanReferenceAttrs(String[] customBeanReferenceAttrs)

parseInternal

protected org.springframework.beans.factory.support.AbstractBeanDefinition parseInternal(Element element,
                                                                                         org.springframework.beans.factory.xml.ParserContext parserContext)

Creates a BeanDefinitionBuilder instance for the bean Class and passes it to the doParse(org.w3c.dom.Element, org.springframework.beans.factory.support.BeanDefinitionBuilder) strategy method.

Specified by:

parseInternal in class org.springframework.beans.factory.xml.AbstractBeanDefinitionParser

Parameters:

element - the element that is to be parsed into a single BeanDefinition

parserContext - the object encapsulating the current state of the parsing process

Returns:

the BeanDefinition resulting from the parsing of the supplied Element

Throws:

IllegalStateException - if the bean Class returned from getBeanClass(org.w3c.dom.Element) is null

See Also:

doParse(org.w3c.dom.Element, org.springframework.beans.factory.support.BeanDefinitionBuilder)

doParse

protected void doParse(Element element,
                       org.springframework.beans.factory.support.BeanDefinitionBuilder bean)

Does the parsing of the element, and inserts information about the element into the passed BeanDefinitionBuilder.

parseAttributes

protected void parseAttributes(String[] attributeNames,
                               Element element,
                               org.springframework.beans.factory.support.BeanDefinitionBuilder bean)

Parses attributes from an element, setting them as properties in a bean definition builder.

Parameters:

attributeNames - Array of attribute names to parse from the element.

element - Element to parse.

bean - BeanDefinitionBuilder to which parsed properties are added.

parseAttributesAsBeanReferences

protected void parseAttributesAsBeanReferences(String[] attributeNames,
                                               Element element,
                                               org.springframework.beans.factory.support.BeanDefinitionBuilder bean)

Parses attributes from an element, setting them as bean references in a bean definition builder.

Parameters:

attributeNames - Array of attribute names to parse from the element.

element - Element to parse.

bean - BeanDefinitionBuilder to which parsed properties are added.

parseAttributesAsBeanReferences

protected void parseAttributesAsBeanReferences(String attributeName,
                                               String propertyName,
                                               Element element,
                                               org.springframework.beans.factory.support.BeanDefinitionBuilder bean)

Parses attributes from an element, setting them as bean references in a bean definition builder.

Parameters:

attributeName - Array of attribute names to parse from the element.

element - Element to parse.

bean - BeanDefinitionBuilder to which parsed properties are added.

parseElements

protected void parseElements(String[] elementNames,
                             Element element,
                             org.springframework.beans.factory.support.BeanDefinitionBuilder bean)

Parses child elements from an element, setting them as properties in a bean definition builder.

Parameters:

elementNames - Array of element names to parse from the element.

element - Element to parse.

bean - BeanDefinitionBuilder to which parsed properties are added.

parsePropertyElements

protected void parsePropertyElements(String elemName,
                                     Element element,
                                     org.springframework.beans.factory.support.BeanDefinitionBuilder bean)

Element parsing method for multi-assign elements that are passed using a Map (e.g. "properties" and "customDirectories")

Parameters:

elemName - Name of the child element to parse.

element - Element to parse

bean - BeanDefinitionBuilder to which parsed properties are added.

parsePropertyElements

protected void parsePropertyElements(String elemName,
                                     Element element,
                                     org.springframework.beans.factory.support.BeanDefinitionBuilder bean,
                                     boolean mapType)

Element parsing method for elements using as child elements and also for multi-assign are passed using a Map (e.g. "properties" and "customDirectories")

Parameters:

elemName - Name of the child element to parse.

element - Element to parse

bean - BeanDefinitionBuilder to which parsed properties are added.

mapType - Boolean value to identify whether elements are passed as map or passed directly.

parseArgElements

protected void parseArgElements(String elemName,
                                Element element,
                                org.springframework.beans.factory.support.BeanDefinitionBuilder bean)

Element parsing method for multi-assign elements, which are passed using a List (e.g. "args" and "java-options")

Parameters:

elemName - Name of the child element to parse.

element - Element to parse

bean - BeanDefinitionBuilder to which parsed properties are added.

parseClasspath

protected void parseClasspath(Element element,
                              org.springframework.beans.factory.support.BeanDefinitionBuilder bean)

Element parsing method for multi-assign elements, which are passed using a List (e.g. "args" and "java-options")

Parameters:

element - Element to parse

bean - BeanDefinitionBuilder to which parsed properties are added.

parseListElements

protected void parseListElements(String listName,
                                 String elemName,
                                 Element element,
                                 org.springframework.beans.factory.support.BeanDefinitionBuilder bean)

Element parsing method for multi-assign elements, which are passed using a List

Parameters:

listName - Name of the parent element to parse.

elemName - Name of the child element to parse.

element - Element to parse

bean - BeanDefinitionBuilder to which parsed properties are added.

parseChildElements

protected void parseChildElements(String elemName,
                                  Element element,
                                  org.springframework.beans.factory.support.BeanDefinitionBuilder bean)

Element parsing method for child elements.

Parameters:

element - Element to parse

bean - BeanDefinitionBuilder to which parsed child object references are added.

parseChildElementReferences

protected void parseChildElementReferences(String elemName,
                                           Element element,
                                           org.springframework.beans.factory.support.BeanDefinitionBuilder bean)

Element parsing method for child elements containing object references.

Parameters:

elemName - Name of the child element to parse

element - Element to parse

bean - BeanDefinitionBuilder to which parsed child object references are added.

resolveId

protected String resolveId(Element element,
                           org.springframework.beans.factory.support.AbstractBeanDefinition definition,
                           org.springframework.beans.factory.xml.ParserContext parserContext)
                    throws org.springframework.beans.factory.BeanDefinitionStoreException

Resolve the ID for the supplied BeanDefinition.

When using generation, a name is generated automatically. Otherwise, the ID is extracted from the "id" attribute, potentially with a fallback to a generated id.

Overrides:

resolveId in class org.springframework.beans.factory.xml.AbstractBeanDefinitionParser

Parameters:

element - the element that the bean definition has been built from

definition - the bean definition to be registered

parserContext - the object encapsulating the current state of the parsing process; provides access to a BeanDefinitionRegistry

Returns:

the resolved id

Throws:

org.springframework.beans.factory.BeanDefinitionStoreException - if no unique name could be generated for the given bean definition