import XMLTransformer from 'atscm/src/lib/transform/XMLTransformer.js'

public class | source

XMLTransformer

src/lib/transform/PartialTransformer.js~PartialTransformer → SplittingTransformer → XMLTransformer

A transformer used to transform XML documents.

Constructor Summary

Public Constructor
public	constructor(options: Object) Creates a new XMLTransformer based on some options.

Public Members
public get	builder: function(object: Object): string Returns the XML builder to use based on the current Transformer#direction.

Private Members
private	_fromDBBuilder: function(object: Object): string The builder to use with direction TransformDirection.FromDB.
private	_fromFilesystemBuilder: function(object: Object): string The builder to use with direction TransformDirection.FromFilesystem.

Public Methods
public	decodeContents(node: Node): * Parses XML in a node's contents.
public	encodeContents(object: Object): * Builds an XML string from an object.

From class SplittingTransformer
public static get abstract	extension: string The extension to add to container node names when they are pulled.
public static get abstract	sourceExtensions: string[] The source file extensions to allow.
public static	splitFile(node: Node, newExtension: string): Node Splits a Node: The resulting is a clone of the input file, with a different path.
public abstract	combineNodes(node: BrowsedNode, sourceNodes: Map<string, BrowsedNode>, context: any) Combines the container node and the source nodes to one single node.
public	readNodeFile(node: BrowsedNode): boolean Returns `false` for all container nodes, so they don't get read.
public	async transformFromDB(node: BrowsedNode, context: any) Renames a container node, should be called by all subclasses.
public	async transformFromFilesystem(node: BrowsedNode, context: Object) Reads a given container nodes source nodes and combines them.
private	_combineNodes(node: BrowsedNode, sourceNodes: {[extension: string]}, context: any) Combines the container node and the source nodes to one single node by calling SplittingTransformer#combineNodes.

Creates a new XMLTransformer based on some options.

Name	Type	Attribute	Description
options	Object	optional	The options to use.

Returns the XML builder to use based on the current Transformer#direction.

The builder to use with direction TransformDirection.FromDB.

The builder to use with direction TransformDirection.FromFilesystem.

Parses XML in a node's contents.

Name	Type	Attribute	Description
node	Node		The node to process.

Builds an XML string from an object.

Name	Type	Attribute	Description
object	Object		The object to encode.