org.databene.formats.xml

Class AbstractXMLElementParser<E>

java.lang.Object

org.databene.formats.xml.AbstractXMLElementParser<E>

Type Parameters:

E - the type of the objects to provide

All Implemented Interfaces:

XMLElementParser<E>

public abstract class AbstractXMLElementParser<E>
extends Object
implements XMLElementParser<E>

Abstract implementation of the XMLElementParser interface. Created: 05.12.2010 10:46:38

Since:

0.5.4

Author:

Volker Bergmann

Field Summary

Fields

Modifier and Type	Field and Description
protected String	elementName
protected org.slf4j.Logger	logger
protected Set<String>	optionalAttributes
protected Set<String>	requiredAttributes
protected Set<Class<?>>	supportedParentTypes

Constructor Summary

Constructors

Constructor and Description
AbstractXMLElementParser(String elementName, Set<String> requiredAttributes, Set<String> optionalAttributes, Class<?>... supportedParentTypes)

Method Summary

Modifier and Type	Method and Description
protected void	assertAtLeastOneAttributeIsSet(Element element, String... attributeNames)
protected void	assertAttributeIsNotSet(Element element, String attributeName)
protected void	assertAttributeIsSet(Element element, String attributeName)
protected void	assertElementName(String expectedName, Element element)
protected void	checkAttributes(Element element, Set<String> supportedAttributes)
protected void	checkAttributeSupport(Element element)
protected void	checkSupportedAttributes(Element element, String... supportedAttributes)
protected static org.databene.commons.SyntaxError	createSyntaxError(String message, Element element)
protected static org.databene.commons.SyntaxError	createSyntaxError(String message, Element element, Exception cause)
protected abstract E	doParse(Element element, E[] parentPath, ParseContext<E> context)
protected void	excludeAttributes(Element element, String... attributeNames)
protected String	getOptionalAttribute(String name, Element element)
String	getRequiredAttribute(String name, Element element)
protected Object	parent(E[] parentPath)
E	parse(Element element, E[] parentPath, ParseContext<E> context)
protected Boolean	parseOptionalBoolean(String attributeName, Element element)
protected Integer	parseOptionalInteger(String attributeName, Element element)
protected Long	parseOptionalLong(String attributeName, Element element)
protected String	parseOptionalName(Element element)
protected String	parseRequiredName(Element element)
boolean	supports(Element element, E[] parentPath)
protected static void	syntaxError(String message, Element element)
protected void	syntaxWarning(String message, Element element)

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected final org.slf4j.Logger logger

elementName

protected final String elementName

supportedParentTypes

protected final Set<Class<?>> supportedParentTypes

requiredAttributes

protected Set<String> requiredAttributes

optionalAttributes

protected Set<String> optionalAttributes

Constructor Detail

AbstractXMLElementParser

public AbstractXMLElementParser(String elementName,
                                Set<String> requiredAttributes,
                                Set<String> optionalAttributes,
                                Class<?>... supportedParentTypes)

Method Detail

supports

public boolean supports(Element element,
                        E[] parentPath)

Specified by:

supports in interface XMLElementParser<E>

parse

public final E parse(Element element,
                     E[] parentPath,
                     ParseContext<E> context)

Specified by:

parse in interface XMLElementParser<E>

doParse

protected abstract E doParse(Element element,
                             E[] parentPath,
                             ParseContext<E> context)

checkAttributeSupport

protected void checkAttributeSupport(Element element)

checkSupportedAttributes

protected void checkSupportedAttributes(Element element,
                                        String... supportedAttributes)

assertElementName

protected void assertElementName(String expectedName,
                                 Element element)

excludeAttributes

protected void excludeAttributes(Element element,
                                 String... attributeNames)

assertAtLeastOneAttributeIsSet

protected void assertAtLeastOneAttributeIsSet(Element element,
                                              String... attributeNames)

assertAttributeIsSet

protected void assertAttributeIsSet(Element element,
                                    String attributeName)

assertAttributeIsNotSet

protected void assertAttributeIsNotSet(Element element,
                                       String attributeName)

parent

protected Object parent(E[] parentPath)

parseRequiredName

protected String parseRequiredName(Element element)

parseOptionalName

protected String parseOptionalName(Element element)

parseOptionalInteger

protected Integer parseOptionalInteger(String attributeName,
                                       Element element)

parseOptionalBoolean

protected Boolean parseOptionalBoolean(String attributeName,
                                       Element element)

parseOptionalLong

protected Long parseOptionalLong(String attributeName,
                                 Element element)

getRequiredAttribute

public String getRequiredAttribute(String name,
                                   Element element)

getOptionalAttribute

protected String getOptionalAttribute(String name,
                                      Element element)

checkAttributes

protected void checkAttributes(Element element,
                               Set<String> supportedAttributes)

createSyntaxError

protected static org.databene.commons.SyntaxError createSyntaxError(String message,
                                                                    Element element)

createSyntaxError

protected static org.databene.commons.SyntaxError createSyntaxError(String message,
                                                                    Element element,
                                                                    Exception cause)

syntaxError

protected static void syntaxError(String message,
                                  Element element)

syntaxWarning

protected void syntaxWarning(String message,
                             Element element)