org.milyn.yaml

Class YamlReader

java.lang.Object

org.milyn.yaml.YamlReader

All Implemented Interfaces:

ContentHandler, SmooksXMLReader, XMLReader

public class YamlReader
extends Object
implements SmooksXMLReader

YAML to SAX event reader.

This YAML Reader can be plugged into Smooks in order to convert a YAML based message stream into a stream of SAX events to be consumed by the other Smooks resources.

Configuration

 <resource-config selector="org.xml.sax.driver">
  <resource>org.milyn.yaml.YamlReader</resource>
  <!--
      (Optional) The element name of the SAX document root. Default of 'yaml'.
  -->
  <param name="rootName"><root-name></param>
  <!--
      (Optional) The element name of a array element. Default of 'element'.
  -->
  <param name="arrayElementName"><array-element-name></param>
  <!--
      (Optional) The replacement string for YAML NULL values. Default is an empty string.
  -->
  <param name="nullValueReplacement"><null-value-replacement></param>
  <!--
      (Optional) The replacement character for whitespaces in a YAML map key. By default this not defined, so that the reader doesn't search for whitespaces.
  -->
  <param name="keyWhitspaceReplacement"><key-whitspace-replacement></param>
  <!--
      (Optional) The prefix character to add if the YAML node name starts with a number. By default this is not defined, so that the reader doesn't search for element names that start with a number.
  -->
  <param name="keyPrefixOnNumeric"><key-prefix-on-numeric></param>
  <!--
      (Optional) If illegal characters are encountered in a YAML element name then they are replaced with this value. By default this is not defined, so that the reader doesn't doesn't search for illegal characters.
  -->
  <param name="illegalElementNameCharReplacement"><illegal-element-name-char-replacement></param>
  <!--
      (Optional) Defines a map of keys and there replacement. The from key will be replaced with the to key or the contents of the element.
  -->
  <param name="keyMap">
   <key from="fromKey" to="toKey" />
   <key from="fromKey"><to></key>
  </param>
  <!--
      (Optional) The strategy how to handle YAML anchors and aliases. Possible values:
          - REFER: Adds a 'id' attribute to the element with the anchor and the 'ref' attribute to the elements with the alias.
                   The value of these attributes is the name of the anchor. The reference needs to be handled within the Smooks config.
                   The attribute names can be set via the 'anchorAttributeName' and 'aliasAttributeName' properties
          - RESOLVE: The elements or value from the anchor are resolved (copied) under the element with the alias.
                     Smooks doesn't see that there was a reference.
          - REFER_RESOLVE: A combination of REFER and RESOLVE. The element of the anchor are resolved and the attributes are set.
                           You should use this if you want to resolve the element but also need the alias name because it has a
                           business meaning.

         Default: 'REFER'
  -->
  <param name="aliasStrategy"><alias-strategy></param>
  <!--
      (Optional) The name of the anchor attribute when the aliasStrategy is REFER or REFER_RESOLVER. Default of 'id'
  -->
  <param name="anchorAttributeName"><anchor-attribute-name></param>
  <!--
      (Optional) The name of the alias attribute when the aliasStrategy is REFER or REFER_RESOLVER. Default of 'ref'
  -->
  <param name="aliasAttributeName"><alias-attribute-name></param>
 </resource-config>
 

Author:

maurice@zeijen.net

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONFIG_PARAM_KEY_MAP
static String	DEFAULT_ALIAS_NAME
static String	DEFAULT_ANCHOR_NAME
static String	XML_ARRAY_ELEMENT_NAME
static String	XML_DOCUMENT
static String	XML_ROOT

Constructor Summary

Constructors

Constructor and Description
YamlReader()

Method Summary

Modifier and Type	Method and Description
String	getArrayElementName()
ContentHandler	getContentHandler()
DTDHandler	getDTDHandler()
EntityResolver	getEntityResolver()
ErrorHandler	getErrorHandler()
boolean	getFeature(String name)
String	getIllegalElementNameCharReplacement()
String	getKeyPrefixOnNumeric()
String	getKeyWhitspaceReplacement()
Object	getProperty(String name)
String	getRootName()
void	initialize()
void	parse(InputSource yamlInputSource)
void	parse(String systemId) The following methods are currently unimplemented...
void	setArrayElementName(String arrayElementName)
void	setContentHandler(ContentHandler contentHandler)
void	setDTDHandler(DTDHandler arg0)
void	setEntityResolver(EntityResolver arg0)
void	setErrorHandler(ErrorHandler arg0)
void	setExecutionContext(ExecutionContext request) Set the Smooks ExecutionContext on the implementing class.
void	setFeature(String name, boolean value)
void	setIllegalElementNameCharReplacement(String illegalElementNameCharReplacement)
void	setIndent(boolean indent)
void	setKeyPrefixOnNumeric(String keyPrefixOnNumeric)
void	setKeyWhitspaceReplacement(String keyWhitspaceReplacement)
void	setProperty(String name, Object value)
void	setRootName(String rootName)

Methods inherited from class java.lang.Object

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

Field Detail

CONFIG_PARAM_KEY_MAP

public static final String CONFIG_PARAM_KEY_MAP

See Also:

Constant Field Values

XML_ROOT

public static final String XML_ROOT

See Also:

Constant Field Values

XML_DOCUMENT

public static final String XML_DOCUMENT

See Also:

Constant Field Values

XML_ARRAY_ELEMENT_NAME

public static final String XML_ARRAY_ELEMENT_NAME

See Also:

Constant Field Values

DEFAULT_ANCHOR_NAME

public static final String DEFAULT_ANCHOR_NAME

See Also:

Constant Field Values

DEFAULT_ALIAS_NAME

public static final String DEFAULT_ALIAS_NAME

See Also:

Constant Field Values

Constructor Detail

YamlReader

public YamlReader()

Method Detail

initialize

@Initialize
public void initialize()

setExecutionContext

public void setExecutionContext(ExecutionContext request)

Description copied from interface: SmooksXMLReader

Set the Smooks ExecutionContext on the implementing class.

Specified by:

setExecutionContext in interface SmooksXMLReader

Parameters:

request - The Smooks ExecutionContext.

parse

public void parse(InputSource yamlInputSource)
           throws IOException,
                  SAXException

Specified by:

parse in interface XMLReader

Throws:

IOException

SAXException

setContentHandler

public void setContentHandler(ContentHandler contentHandler)

Specified by:

setContentHandler in interface XMLReader

getContentHandler

public ContentHandler getContentHandler()

Specified by:

getContentHandler in interface XMLReader

getRootName

public String getRootName()

Returns:

the rootName

setRootName

public void setRootName(String rootName)

Parameters:

rootName - the rootName to set

getArrayElementName

public String getArrayElementName()

Returns:

the arrayElementName

setArrayElementName

public void setArrayElementName(String arrayElementName)

Parameters:

arrayElementName - the arrayElementName to set

getKeyWhitspaceReplacement

public String getKeyWhitspaceReplacement()

Returns:

the keyWhitspaceReplacement

setKeyWhitspaceReplacement

public void setKeyWhitspaceReplacement(String keyWhitspaceReplacement)

Parameters:

keyWhitspaceReplacement - the keyWhitspaceReplacement to set

getKeyPrefixOnNumeric

public String getKeyPrefixOnNumeric()

Returns:

the keyPrefixOnNumeric

setKeyPrefixOnNumeric

public void setKeyPrefixOnNumeric(String keyPrefixOnNumeric)

Parameters:

keyPrefixOnNumeric - the keyPrefixOnNumeric to set

getIllegalElementNameCharReplacement

public String getIllegalElementNameCharReplacement()

Returns:

the illegalElementNameCharReplacement

setIllegalElementNameCharReplacement

public void setIllegalElementNameCharReplacement(String illegalElementNameCharReplacement)

Parameters:

illegalElementNameCharReplacement - the illegalElementNameCharReplacement to set

setIndent

public void setIndent(boolean indent)

parse

public void parse(String systemId)
           throws IOException,
                  SAXException

The following methods are currently unimplemented...

Specified by:

parse in interface XMLReader

Throws:

IOException

SAXException

getFeature

public boolean getFeature(String name)
                   throws SAXNotRecognizedException,
                          SAXNotSupportedException

Specified by:

getFeature in interface XMLReader

Throws:

SAXNotRecognizedException

SAXNotSupportedException

setFeature

public void setFeature(String name,
                       boolean value)
                throws SAXNotRecognizedException,
                       SAXNotSupportedException

Specified by:

setFeature in interface XMLReader

Throws:

SAXNotRecognizedException

SAXNotSupportedException

getDTDHandler

public DTDHandler getDTDHandler()

Specified by:

getDTDHandler in interface XMLReader

setDTDHandler

public void setDTDHandler(DTDHandler arg0)

Specified by:

setDTDHandler in interface XMLReader

getEntityResolver

public EntityResolver getEntityResolver()

Specified by:

getEntityResolver in interface XMLReader

setEntityResolver

public void setEntityResolver(EntityResolver arg0)

Specified by:

setEntityResolver in interface XMLReader

getErrorHandler

public ErrorHandler getErrorHandler()

Specified by:

getErrorHandler in interface XMLReader

setErrorHandler

public void setErrorHandler(ErrorHandler arg0)

Specified by:

setErrorHandler in interface XMLReader

getProperty

public Object getProperty(String name)
                   throws SAXNotRecognizedException,
                          SAXNotSupportedException

Specified by:

getProperty in interface XMLReader

Throws:

SAXNotRecognizedException

SAXNotSupportedException

setProperty

public void setProperty(String name,
                        Object value)
                 throws SAXNotRecognizedException,
                        SAXNotSupportedException

Specified by:

setProperty in interface XMLReader

Throws:

SAXNotRecognizedException

SAXNotSupportedException