org.compass.core.xml.jdom.converter
Class SAXBuilderXmlContentConverter

java.lang.Object
  org.compass.core.xml.jdom.converter.AbstractXmlOutputterXmlContentConverter
      org.compass.core.xml.jdom.converter.SAXBuilderXmlContentConverter

All Implemented Interfaces:

CompassConfigurable, SupportsXmlContentWrapper, XmlContentConverter

public class SAXBuilderXmlContentConverter
extends AbstractXmlOutputterXmlContentConverter
implements SupportsXmlContentWrapper, CompassConfigurable

A JDOM content mapping converter, which uses JDOM SAXBuilder to convert the xml string into a JDomAliasedXmlObject.

Author:

kimchy

Nested Class Summary

Nested classes/interfaces inherited from interface org.compass.core.converter.xsem.SupportsXmlContentWrapper

SupportsXmlContentWrapper.NotSupportedXmlContentWrapperException

Constructor Summary

SAXBuilderXmlContentConverter()

Method Summary

void	configure(CompassSettings settings) Configure using the given settings.
protected org.jdom.input.SAXBuilder	doCreateSAXBuilder(CompassSettings settings)
AliasedXmlObject	fromXml(String alias, Reader xml) Uses JDOM SAXBuilder to convert the given xml string into a JDomAliasedXmlObject.
boolean	supports(String wrapper) This converter does not support a singleton wrapper strategy.

Methods inherited from class org.compass.core.xml.jdom.converter.AbstractXmlOutputterXmlContentConverter

toXml

Methods inherited from class java.lang.Object

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

Constructor Detail

SAXBuilderXmlContentConverter

public SAXBuilderXmlContentConverter()

Method Detail

configure

public void configure(CompassSettings settings)
               throws CompassException

Description copied from interface: CompassConfigurable

Configure using the given settings.

Specified by:

configure in interface CompassConfigurable

Parameters:

settings - The settings for the configured object

Throws:

CompassException

doCreateSAXBuilder

protected org.jdom.input.SAXBuilder doCreateSAXBuilder(CompassSettings settings)

supports

public boolean supports(String wrapper)

This converter does not support a singleton wrapper strategy.

Specified by:

supports in interface SupportsXmlContentWrapper

fromXml

public AliasedXmlObject fromXml(String alias,
                                Reader xml)
                         throws ConversionException

Uses JDOM SAXBuilder to convert the given xml string into a JDomAliasedXmlObject.

Specified by:

fromXml in interface XmlContentConverter

Parameters:

alias - The alias that will be associated with the AliasedXmlObject

xml - The xml string to convert into an JDomAliasedXmlObject

Returns:

A JDomAliasedXmlObject parsed from the given xml string and associated with the given alias

Throws:

ConversionException - In case the xml parsing failed