de.hybris.bootstrap.xml

Class SimpleValueTagListener

java.lang.Object

de.hybris.bootstrap.xml.DefaultTagListener

de.hybris.bootstrap.xml.SimpleValueTagListener

All Implemented Interfaces:

TagListener

Direct Known Subclasses:

BooleanValueTagListener, ClassValueTagListener, DateTagListener, DoubleValueTagListener, IntegerValueTagListener, StringValueTagListener

public abstract class SimpleValueTagListener
extends DefaultTagListener

Base class for simple value tags. This class translates either the character content or the content of a specified value attriute. The returned value is either the translated value or a map which maps the content of a specified mapping attribute to the translated value.

Some examples:

 <foo> value </foo>
 ... would translate into plain 'value', no value attribute 
    or mapping attribute must be defined
    
 <foo bar="value"/>
 ... would translate into 'value' if 'bar' is specified value attribute      
 
 <foo key="k1" bar="value"/>
 ... would translate into { 'k1'=>'value'} if 'bar' is specified value attribute
     and 'key' the specified mapping attribute
 

Field Summary

Fields

Modifier and Type	Field and Description
static String	UNSPECIFIED_TYPE

Constructor Summary

Constructors

Constructor and Description
SimpleValueTagListener(TagListener parent, String tagName)
SimpleValueTagListener(TagListener parent, String tagName, String valueAttribute, String mappingAttribute)

Method Summary

Modifier and Type	Method and Description
String	getCharacters() Superclass method overridden to get characters from value attribute if such is specified.
String	getTagName() The tag name which this listener is bound to.
abstract Object	getValue() Translation method.
boolean	isMapped()
Object	processEndElement(ObjectProcessor processor) To be overridden.

Methods inherited from class de.hybris.bootstrap.xml.DefaultTagListener

addResult, addSubTagListener, addSubTagValue, characters, clearValues, createSubTagListeners, endElement, getAttribute, getEndLineNumber, getParent, getParents, getPartentTags, getResult, getStartLineNumber, getSubListenerMap, getSubTagDoubleValue, getSubTagIntValue, getSubTagListener, getSubTagValue, getSubTagValueCollection, getSubTagValueMap, isRoot, processError, processStartElement, readAttributes, setEndLineNumber, setStartLineNumber, startElement

Methods inherited from class java.lang.Object

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

Field Detail

UNSPECIFIED_TYPE

public static final String UNSPECIFIED_TYPE

See Also:

Constant Field Values

Constructor Detail

SimpleValueTagListener

public SimpleValueTagListener(TagListener parent,
                              String tagName)

Parameters:

parent - the parent tag listener

tagName - the tag name which this listener is bound to

SimpleValueTagListener

public SimpleValueTagListener(TagListener parent,
                              String tagName,
                              String valueAttribute,
                              String mappingAttribute)

Parameters:

parent - the parent tag listener

tagName - the tag name this listener is bound to

valueAttribute - the xml attribute which contains the value to translate (optional)

mappingAttribute - the xml attribute name which contains the key for the translated value (optional)

Method Detail

getTagName

public String getTagName()

The tag name which this listener is bound to.

isMapped

public boolean isMapped()

Returns:

true if a mapping attribute was specified

getValue

public abstract Object getValue()
                         throws ParseAbortException

Translation method. Must be implemented by subclasses.

Throws:

ParseAbortException

getCharacters

public String getCharacters()

Superclass method overridden to get characters from value attribute if such is specified.

Overrides:

getCharacters in class DefaultTagListener

processEndElement

public Object processEndElement(ObjectProcessor processor)
                         throws ParseAbortException

Description copied from class: DefaultTagListener

To be overridden.

Specified by:

processEndElement in class DefaultTagListener

Returns:

Object

Throws:

ParseAbortException