org.staticioc.parser

Class ParserHelper

java.lang.Object

org.staticioc.parser.ParserHelper

All Implemented Interfaces:

ParserConstants

public class ParserHelper
extends Object
implements ParserConstants

Commonly used methods for configuration parsing

Author:

charles

Field Summary

Fields

Modifier and Type	Field and Description
protected static org.slf4j.Logger	logger

Fields inherited from interface org.staticioc.parser.ParserConstants

ABSTRACT, ALIAS, BEAN, BEAN_PROPERTY_PREFIX, BEAN_PROPERTY_REF_SUFFIX, CLASS, CONSTRUCTOR_ARGS, DESTROY_METHOD, ENTRY, FACTORY_BEAN, FACTORY_METHOD, ID, IDREF, INDEX, INIT_METHOD, KEY, KEY_REF, LIST, LOCAL, MAP, NAME, NULL, PARENT, PROP, PROPS, PROTOTYPE, REF, RESOURCE, SCOPE, SET, SINGLETON, TYPE, VALUE, VALUE_REF, XML_NAMESPACE_DEF, XML_NAMESPACE_DELIMITER, XPATH_BEAN, XPATH_BEANS_NODE, XPATH_IMPORT, XPATH_PROPERTY

Constructor Summary

Constructors

Constructor and Description
ParserHelper()

Method Summary

Methods

Modifier and Type	Method and Description
static Property	buildContructorArgument(int index, String value, String ref)
static Boolean	extractAttributeValueAsBoolean(String attributeName, NamedNodeMap attributes, Boolean defaultValue) Extract an attribute value as Boolean
static String	extractAttributeValueAsString(String attributeName, NamedNodeMap attributes, String defaultValue) Extract an attribute value as text
static org.apache.commons.lang3.tuple.Pair<String,String>	extractBeanId(Node beanNode) Extract the name and id attributes of a node a resolve it as an Pair
static String	extractFirstChildValue(Node node) Extract text value for nodes like text
static Node	extractFirstNodeByName(NodeList nodes, String name, String namespacePrefix) Go through a node list a extract the first matching node given its name
static Map<String,String>	extractNamespacePrefix(NodeList nodes) Parse a NodeList for XML namespace declaration attributes and build a mapping associating each namespace with its prefix
static Collection<Node>	extractNodesByName(NodeList nodes, String name, String namespacePrefix) Go through a node list a extract the first matching node given its name
static Property	getRef(String propertyName, String ref) Builds a ref property
static Property	getVal(String propertyName, String value) Builds a value property
static Property	handleValueRefAttributes(String propName, Node node) Handle value, ref and idref attribute of an XML node and builds the corresponding property
static boolean	match(String expectedName, String nodeName, String prefix) Check whether a node has the expected name after prefix resolution
static String	prefixedName(String prefix, String name) Build full name of an element given the prefix of its namespace

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected static final org.slf4j.Logger logger

Constructor Detail

ParserHelper

public ParserHelper()

Method Detail

getVal

public static Property getVal(String propertyName,
              String value)

Builds a value property

Parameters:

propertyName - name of the Property to build

value - of the Property to build

Returns:

the built Property if value is not null, null otherwise

getRef

public static Property getRef(String propertyName,
              String ref)

Builds a ref property

Parameters:

propertyName - name of the Property to build

ref - of the Property to build

Returns:

the built Property if ref is not null, null otherwise

handleValueRefAttributes

public static Property handleValueRefAttributes(String propName,
                                Node node)

Handle value, ref and idref attribute of an XML node and builds the corresponding property

Parameters:

propName - name of the Property to build

node - to analyze

Returns:

the built Property, if value, ref or idref is found, null otherwise

buildContructorArgument

public static Property buildContructorArgument(int index,
                               String value,
                               String ref)

Parameters:

index - of the constructor argument

value - of the argument

ref - (for ref argument)

Returns:

a Property representing the

extractBeanId

public static org.apache.commons.lang3.tuple.Pair<String,String> extractBeanId(Node beanNode)

Extract the name and id attributes of a node a resolve it as an Pair

Parameters:

beanNode - to parse

Returns:

an Pair

extractAttributeValueAsString

public static String extractAttributeValueAsString(String attributeName,
                                   NamedNodeMap attributes,
                                   String defaultValue)

Extract an attribute value as text

Parameters:

attributeName - name of the attribute to extract

attributes - Map of the node

Returns:

the String value of the attribute, if it exists, or null otherwise

extractAttributeValueAsBoolean

public static Boolean extractAttributeValueAsBoolean(String attributeName,
                                     NamedNodeMap attributes,
                                     Boolean defaultValue)

Extract an attribute value as Boolean

Parameters:

attributeName - name of the attribute to extract

attributes - Map of the node

Returns:

the Boolean value of the attribute, if it exists, or null otherwise

extractFirstChildValue

public static String extractFirstChildValue(Node node)

Extract text value for nodes like text

Parameters:

node -

Returns:

the content of the first subnode of a node, expressed as a String, or null otherwise

extractFirstNodeByName

public static Node extractFirstNodeByName(NodeList nodes,
                          String name,
                          String namespacePrefix)

Go through a node list a extract the first matching node given its name

Parameters:

nodes -

name -

Returns:

the first matching node given in the NodeList, or null if not matching Node is found

extractNodesByName

public static Collection<Node> extractNodesByName(NodeList nodes,
                                  String name,
                                  String namespacePrefix)

Go through a node list a extract the first matching node given its name

Parameters:

nodes -

name -

Returns:

the first matching node given in the NodeList, or null if not matching Node is found

extractNamespacePrefix

public static Map<String,String> extractNamespacePrefix(NodeList nodes)

Parse a NodeList for XML namespace declaration attributes and build a mapping associating each namespace with its prefix

Parameters:

nodes - to analyze

Returns:

a Map for each namespace definition attached to any nodes in the passed NodeList

prefixedName

public static String prefixedName(String prefix,
                  String name)

Build full name of an element given the prefix of its namespace

Parameters:

prefix - of the namespace the element belongs to

name - of the element

Returns:

exact name of the element as it is expected in present document

match

public static boolean match(String expectedName,
            String nodeName,
            String prefix)

Check whether a node has the expected name after prefix resolution

Parameters:

expectedName - unprefixed expected name

nodeName - full name of the element to compare

prefix - of the namespace the expected element belongs to

Returns:

true if nodeName is equals to expectedName after prefix resolution