org.apache.beam.sdk.io.xml

Class XmlIO.Write<T>

java.lang.Object

org.apache.beam.sdk.transforms.PTransform<PCollection<T>,PDone>

org.apache.beam.sdk.io.xml.XmlIO.Write<T>

All Implemented Interfaces:

java.io.Serializable, HasDisplayData

Enclosing class:

XmlIO

public abstract static class XmlIO.Write<T>
extends PTransform<PCollection<T>,PDone>

Implementation of XmlIO.write().

See Also:

Serialized Form

Field Summary

Fields inherited from class org.apache.beam.sdk.transforms.PTransform

name

Constructor Summary

Constructors

Constructor and Description
Write()

Method Summary

Modifier and Type	Method and Description
PDone	expand(PCollection<T> input) Override this method to specify how this PTransform should be expanded on the given InputT.
void	populateDisplayData(DisplayData.Builder builder) Register display data for the given transform or component.
XmlIO.Write<T>	to(java.lang.String filenamePrefix) Writes to files with the given path prefix.
void	validate(PipelineOptions options) Called before running the Pipeline to verify this transform is fully and correctly specified.
XmlIO.Write<T>	withCharset(java.nio.charset.Charset charset) Sets the charset used to write the file.
XmlIO.Write<T>	withRecordClass(java.lang.Class<T> recordClass) Writes objects of the given class mapped to XML elements using JAXB.
XmlIO.Write<T>	withRootElement(java.lang.String rootElement) Sets the enclosing root element for the generated XML files.

Methods inherited from class org.apache.beam.sdk.transforms.PTransform

getAdditionalInputs, getDefaultOutputCoder, getDefaultOutputCoder, getDefaultOutputCoder, getKindString, getName, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

Write

public Write()

Method Detail

to

public XmlIO.Write<T> to(java.lang.String filenamePrefix)

Writes to files with the given path prefix.

Output files will have the name {filenamePrefix}-0000i-of-0000n.xml where n is the number of output bundles.

withRecordClass

public XmlIO.Write<T> withRecordClass(java.lang.Class<T> recordClass)

Writes objects of the given class mapped to XML elements using JAXB.

The specified class must be able to be used to create a JAXB context.

withRootElement

public XmlIO.Write<T> withRootElement(java.lang.String rootElement)

Sets the enclosing root element for the generated XML files.

withCharset

public XmlIO.Write<T> withCharset(java.nio.charset.Charset charset)

Sets the charset used to write the file.

validate

public void validate(PipelineOptions options)

Description copied from class: PTransform

Called before running the Pipeline to verify this transform is fully and correctly specified.

By default, does nothing.

Overrides:

validate in class PTransform<PCollection<T>,PDone>

expand

public PDone expand(PCollection<T> input)

Description copied from class: PTransform

Override this method to specify how this PTransform should be expanded on the given InputT.

NOTE: This method should not be called directly. Instead apply the PTransform should be applied to the InputT using the apply method.

Composite transforms, which are defined in terms of other transforms, should return the output of one of the composed transforms. Non-composite transforms, which do not apply any transforms internally, should return a new unbound output and register evaluators (via backend-specific registration methods).

Specified by:

expand in class PTransform<PCollection<T>,PDone>

populateDisplayData

public void populateDisplayData(DisplayData.Builder builder)

Description copied from class: PTransform

Register display data for the given transform or component.

populateDisplayData(DisplayData.Builder) is invoked by Pipeline runners to collect display data via DisplayData.from(HasDisplayData). Implementations may call super.populateDisplayData(builder) in order to register display data in the current namespace, but should otherwise use subcomponent.populateDisplayData(builder) to use the namespace of the subcomponent.

By default, does not register any display data. Implementors may override this method to provide their own display data.

Specified by:

populateDisplayData in interface HasDisplayData

Overrides:

populateDisplayData in class PTransform<PCollection<T>,PDone>

Parameters:

builder - The builder to populate with display data.

See Also:

HasDisplayData