org.smooks.cartridges.yaml

Class YamlReaderConfigurator

java.lang.Object

org.smooks.cartridges.yaml.YamlReaderConfigurator

All Implemented Interfaces:

org.smooks.api.resource.config.ReaderConfigurator

public class YamlReaderConfigurator
extends Object
implements org.smooks.api.resource.config.ReaderConfigurator

YAML Reader configurator.

Supports programmatic YamlReader configuration on a Smooks instance.

Author:

maurice@zeijen.net

Constructor Summary

Constructors

Constructor and Description
YamlReaderConfigurator()

Method Summary

Modifier and Type	Method and Description
YamlReaderConfigurator	setAliasAttributeName(String aliasAttributeName) The name of the alias attribute when the aliasStrategy is REFER or REFER_RESOLVER.
YamlReaderConfigurator	setAliasStrategy(AliasStrategy aliasStrategy) The strategy how to handle YAML anchors and aliases.
YamlReaderConfigurator	setAnchorAttributeName(String anchorAttributeName) The name of the anchor attribute when the aliasStrategy is REFER or REFER_RESOLVER.
YamlReaderConfigurator	setArrayElementName(String arrayElementName) The element name of a array element.
YamlReaderConfigurator	setDocumentName(String documentName) The element name of the yaml document declaration.
YamlReaderConfigurator	setIllegalElementNameCharReplacement(String illegalElementNameCharReplacement) If illegal characters are encountered in a YAML element name then they are replaced with this value.
YamlReaderConfigurator	setIndent(boolean indent) Add indentation character data to the generated event stream.
YamlReaderConfigurator	setKeyMap(Map<String,String> keyMap) Defines a YAML element name mapping.
YamlReaderConfigurator	setKeyPrefixOnNumeric(String keyPrefixOnNumeric) The prefix character to add if the YAML node name starts with a number.
YamlReaderConfigurator	setKeyWhitspaceReplacement(String keyWhitspaceReplacement) The replacement character for whitespaces in a YAML map key.
YamlReaderConfigurator	setRootName(String rootName) The element name of the document root.
YamlReaderConfigurator	setTargetProfile(String targetProfile) The profile on which this reader is used
List<org.smooks.api.resource.config.ResourceConfig>	toConfig() Creates the SmooksResourceConfiguration from the defined settings.

Methods inherited from class java.lang.Object

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

Constructor Detail

YamlReaderConfigurator

public YamlReaderConfigurator()

Method Detail

setRootName

public YamlReaderConfigurator setRootName(String rootName)

The element name of the document root. Default: yaml

Parameters:

rootName -

Returns:

This configurator (for chain calls)

setDocumentName

public YamlReaderConfigurator setDocumentName(String documentName)

The element name of the yaml document declaration. Default: document

Parameters:

documentName -

Returns:

This configurator (for chain calls)

setArrayElementName

public YamlReaderConfigurator setArrayElementName(String arrayElementName)

The element name of a array element. Default: element

Parameters:

arrayElementName -

Returns:

This configurator (for chain calls)

setKeyWhitspaceReplacement

public YamlReaderConfigurator setKeyWhitspaceReplacement(String keyWhitspaceReplacement)

The replacement character for whitespaces in a YAML map key. By default this not defined, so that the reader doesn't search for whitespaces.

Parameters:

keyWhitspaceReplacement -

Returns:

This configurator (for chain calls)

setKeyPrefixOnNumeric

public YamlReaderConfigurator setKeyPrefixOnNumeric(String keyPrefixOnNumeric)

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.

Parameters:

keyPrefixOnNumeric -

Returns:

This configurator (for chain calls)

setIllegalElementNameCharReplacement

public YamlReaderConfigurator setIllegalElementNameCharReplacement(String illegalElementNameCharReplacement)

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.

Parameters:

illegalElementNameCharReplacement -

Returns:

This configurator (for chain calls)

setKeyMap

public YamlReaderConfigurator setKeyMap(Map<String,String> keyMap)

Defines a YAML element name mapping.

Parameters:

keyMap -

Returns:

This configurator (for chain calls)

setTargetProfile

public YamlReaderConfigurator setTargetProfile(String targetProfile)

The profile on which this reader is used

Parameters:

targetProfile -

Returns:

This configurator (for chain calls)

setAliasStrategy

public YamlReaderConfigurator setAliasStrategy(AliasStrategy aliasStrategy)

The strategy how to handle YAML anchors and aliases. Default: REFER

Parameters:

aliasStrategy - The strategy to use

Returns:

This configurator (for chain calls)

See Also:

AliasStrategy

setAnchorAttributeName

public YamlReaderConfigurator setAnchorAttributeName(String anchorAttributeName)

The name of the anchor attribute when the aliasStrategy is REFER or REFER_RESOLVER. Default: id

Parameters:

anchorAttributeName -

Returns:

This configurator (for chain calls)

setAliasAttributeName

public YamlReaderConfigurator setAliasAttributeName(String aliasAttributeName)

The name of the alias attribute when the aliasStrategy is REFER or REFER_RESOLVER. Default: ref

Parameters:

aliasAttributeName -

Returns:

This configurator (for chain calls)

setIndent

public YamlReaderConfigurator setIndent(boolean indent)

Add indentation character data to the generated event stream. This simply makes the generated event stream easier to read in its serialized form. Useful for testing etc. Default: false

Parameters:

indent -

Returns:

This configurator (for chain calls)

toConfig

public List<org.smooks.api.resource.config.ResourceConfig> toConfig()

Creates the SmooksResourceConfiguration from the defined settings.

Specified by:

toConfig in interface org.smooks.api.resource.config.ReaderConfigurator

Returns:

The SmooksResourceConfiguration