java.lang.Object
- org.apache.hop.pipeline.transform.TransformMeta

All Implemented Interfaces:

Cloneable, Comparable<TransformMeta>, IBaseMeta, IGuiPosition, IAttributes, ICheckResultSource, IResourceExport, IResourceHolder
```
public class TransformMeta
extends Object
implements Cloneable, Comparable<TransformMeta>, IGuiPosition, ICheckResultSource, IResourceExport, IResourceHolder, IAttributes, IBaseMeta
```
This class contains everything that is needed to define a transform.

Field Summary

Fields
Modifier and Type	Field	Description
`protected Map<String,Map<String,String>>`	`attributesMap`
`static String`	`STRING_ID_ETL_META_INJECT`
`static String`	`STRING_ID_MAPPING`
`static String`	`STRING_ID_MAPPING_INPUT`
`static String`	`STRING_ID_MAPPING_OUTPUT`
`static String`	`STRING_ID_SINGLE_THREADER`
`static String`	`STRING_ID_WORKFLOW_EXECUTOR`
`static String`	`XML_TAG`

Constructor Summary

Constructors
Constructor	Description
`TransformMeta()`
`TransformMeta(String transformId, String transformName, ITransformMeta transform)`
`TransformMeta(String transformName, ITransformMeta transform)`
`TransformMeta(Node transformNode, IHopMetadataProvider metadataProvider)`	Read the transform data from XML

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`check(List<ICheckResult> remarks, PipelineMeta pipelineMeta, IRowMeta prev, String[] input, String[] output, IRowMeta info, IVariables variables, IHopMetadataProvider metadataProvider)`
`boolean`	`chosesTargetTransforms()`
`Object`	`clone()`
`int`	`compareTo(TransformMeta o)`
`boolean`	`equals(Object obj)`	Two transforms are equal if their names are equal.
`String`	`exportResources(IVariables variables, Map<String,ResourceDefinition> definitions, IResourceNaming iResourceNaming, IHopMetadataProvider metadataProvider)`	Exports the object to a flat-file system, adding content with filename keys to a set of definitions.
`static TransformMeta`	`findTransform(List<TransformMeta> transforms, String transformName)`	Find a transform with its name in a given ArrayList of transforms
`void`	`flipSelected()`
`static TransformMeta`	`fromXml(String metaXml)`
`String`	`getAttribute(String groupName, String key)`
`Map<String,String>`	`getAttributes(String groupName)`
`Map<String,Map<String,String>>`	`getAttributesMap()`
`int`	`getCopies(IVariables variables)`	Get the number of copies to start of a transform.
`String`	`getCopiesString()`
`String`	`getDescription()`
`Point`	`getLocation()`
`String`	`getName()`
`PipelineMeta`	`getParentPipelineMeta()`
`String`	`getPluginId()`
`List<ResourceReference>`	`getResourceDependencies(IVariables variables)`	Get a list of all the resource dependencies that the transform is depending on.
`IRowDistribution`	`getRowDistribution()`
`String`	`getSuggestion()`
`TransformPartitioningMeta`	`getTargetTransformPartitioningMeta()`
`ITransformMeta`	`getTransform()`
`TransformErrorMeta`	`getTransformErrorMeta()`
`TransformPartitioningMeta`	`getTransformPartitioningMeta()`
`String`	`getTransformPluginId()`
`String`	`getTypeId()`	Support for ICheckResultSource
`String`	`getXml()`
`boolean`	`hasChanged()`
`int`	`hashCode()`
`boolean`	`hasTerminator()`
`boolean`	`isDeprecated()`
`boolean`	`isDistributes()`
`boolean`	`isDoingErrorHandling()`
`boolean`	`isEtlMetaInject()`
`boolean`	`isMapping()`
`boolean`	`isMappingInput()`
`boolean`	`isMappingOutput()`
`boolean`	`isMissing()`
`boolean`	`isPartitioned()`
`boolean`	`isRepartitioning()`
`boolean`	`isSelected()`
`boolean`	`isSendingErrorRowsToTransform(TransformMeta targetTransform)`
`boolean`	`isSingleThreader()`
`boolean`	`isTargetPartitioned()`
`boolean`	`isWorkflowExecutor()`
`void`	`replaceMeta(TransformMeta transformMeta)`
`void`	`setAttribute(String groupName, String key, String value)`
`void`	`setAttributes(String groupName, Map<String,String> attributes)`
`void`	`setAttributesMap(Map<String,Map<String,String>> attributesMap)`
`void`	`setChanged()`
`void`	`setChanged(boolean ch)`
`void`	`setCopies(int c)`	Sets the number of parallel copies that this transform will be launched with.
`void`	`setCopiesString(String copiesString)`
`void`	`setDescription(String description)`
`void`	`setDistributes(boolean distributes)`
`void`	`setLocation(int x, int y)`
`void`	`setLocation(Point loc)`
`void`	`setName(String sname)`
`void`	`setParentPipelineMeta(PipelineMeta parentPipelineMeta)`
`void`	`setRowDistribution(IRowDistribution rowDistribution)`
`void`	`setSelected(boolean sel)`
`void`	`setTargetTransformPartitioningMeta(TransformPartitioningMeta targetTransformPartitioningMeta)`
`void`	`setTerminator()`
`void`	`setTerminator(boolean t)`
`void`	`setTransform(ITransformMeta transform)`
`void`	`setTransformErrorMeta(TransformErrorMeta transformErrorMeta)`
`void`	`setTransformPartitioningMeta(TransformPartitioningMeta transformPartitioningMeta)`
`void`	`setTransformPluginId(String transformPluginId)`	Set the plugin transform id (code)
`boolean`	`supportsErrorHandling()`
`String`	`toString()`

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - XML_TAG
```
public static final String XML_TAG
```
    See Also:
    
    Constant Field Values
  - STRING_ID_MAPPING
```
public static final String STRING_ID_MAPPING
```
    See Also:
    
    Constant Field Values
  - STRING_ID_SINGLE_THREADER
```
public static final String STRING_ID_SINGLE_THREADER
```
    See Also:
    
    Constant Field Values
  - STRING_ID_ETL_META_INJECT
```
public static final String STRING_ID_ETL_META_INJECT
```
    See Also:
    
    Constant Field Values
  - STRING_ID_WORKFLOW_EXECUTOR
```
public static final String STRING_ID_WORKFLOW_EXECUTOR
```
    See Also:
    
    Constant Field Values
  - STRING_ID_MAPPING_INPUT
```
public static final String STRING_ID_MAPPING_INPUT
```
    See Also:
    
    Constant Field Values
  - STRING_ID_MAPPING_OUTPUT
```
public static final String STRING_ID_MAPPING_OUTPUT
```
    See Also:
    
    Constant Field Values
  - attributesMap
```
protected Map<String,Map<String,String>> attributesMap
```
- Constructor Detail
  - TransformMeta
```
public TransformMeta(String transformId,
                     String transformName,
                     ITransformMeta transform)
```
    Parameters:
    
    transformId - The plugin ID of the transform
    
    transformName - The name of the new transform
    
    transform - The transform metadata interface to use (TextFileInputMeta, etc)
  - TransformMeta
```
public TransformMeta(String transformName,
                     ITransformMeta transform)
```
    Parameters:
    
    transformName - The name of the new transform
    
    transform - The transform metadata interface to use (TextFileInputMeta, etc)
  - TransformMeta
```
public TransformMeta()
```
  - TransformMeta
```
public TransformMeta(Node transformNode,
                     IHopMetadataProvider metadataProvider)
              throws HopXmlException,
                     HopPluginLoaderException
```
    Read the transform data from XML
    
    Parameters:
    
    transformNode - The XML transform node.
    
    metadataProvider - where to get the metadata.
    
    Throws:
    
    HopXmlException
    
    HopPluginLoaderException
- Method Detail
  - getXml
```
public String getXml()
              throws HopException
```
    Throws:
    
    HopException
  - fromXml
```
public static TransformMeta fromXml(String metaXml)
```
  - setCopies
```
public void setCopies(int c)
```
    Sets the number of parallel copies that this transform will be launched with.
    
    Parameters:
    
    c - The number of copies.
  - getCopies
```
public int getCopies(IVariables variables)
```
    Get the number of copies to start of a transform. This takes into account the partitioning logic.
    
    Returns:
    
    the number of transform copies to start.
  - equals
```
public boolean equals(Object obj)
```
    Two transforms are equal if their names are equal.
    
    Overrides:
    
    equals in class Object
    
    Returns:
    
    true if the two transforms are equal.
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - compareTo
```
public int compareTo(TransformMeta o)
```
    Specified by:
    
    compareTo in interface Comparable<TransformMeta>
  - hasChanged
```
public boolean hasChanged()
```
  - setChanged
```
public void setChanged(boolean ch)
```
  - setChanged
```
public void setChanged()
```
  - chosesTargetTransforms
```
public boolean chosesTargetTransforms()
```
  - clone
```
public Object clone()
```
    Overrides:
    
    clone in class Object
  - replaceMeta
```
public void replaceMeta(TransformMeta transformMeta)
```
  - getTransform
```
public ITransformMeta getTransform()
```
  - setTransform
```
public void setTransform(ITransformMeta transform)
```
  - getTransformPluginId
```
public String getTransformPluginId()
```
  - getName
```
public String getName()
```
    Specified by:
    
    getName in interface ICheckResultSource
    
    Specified by:
    
    getName in interface IResourceHolder
    
    Returns:
    
    The name of the holder of the resource
  - setName
```
public void setName(String sname)
```
  - getDescription
```
public String getDescription()
```
    Specified by:
    
    getDescription in interface ICheckResultSource
    
    Specified by:
    
    getDescription in interface IResourceHolder
    
    Returns:
    
    The description of the holder of the resource
  - setDescription
```
public void setDescription(String description)
```
  - setSelected
```
public void setSelected(boolean sel)
```
    Specified by:
    
    setSelected in interface IGuiPosition
  - flipSelected
```
public void flipSelected()
```
  - isSelected
```
public boolean isSelected()
```
    Specified by:
    
    isSelected in interface IGuiPosition
  - setTerminator
```
public void setTerminator()
```
  - setTerminator
```
public void setTerminator(boolean t)
```
  - hasTerminator
```
public boolean hasTerminator()
```
  - setLocation
```
public void setLocation(int x,
                        int y)
```
    Specified by:
    
    setLocation in interface IGuiPosition
  - setLocation
```
public void setLocation(Point loc)
```
    Specified by:
    
    setLocation in interface IGuiPosition
  - getLocation
```
public Point getLocation()
```
    Specified by:
    
    getLocation in interface IBaseMeta
    
    Specified by:
    
    getLocation in interface IGuiPosition
  - check
```
public void check(List<ICheckResult> remarks,
                  PipelineMeta pipelineMeta,
                  IRowMeta prev,
                  String[] input,
                  String[] output,
                  IRowMeta info,
                  IVariables variables,
                  IHopMetadataProvider metadataProvider)
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - isPartitioned
```
public boolean isPartitioned()
```
    Returns:
    
    true is the transform is partitioned
  - isTargetPartitioned
```
public boolean isTargetPartitioned()
```
    Returns:
    
    true is the transform is partitioned
  - getTransformPartitioningMeta
```
public TransformPartitioningMeta getTransformPartitioningMeta()
```
    Returns:
    
    the transformPartitioningMeta
  - setTransformPartitioningMeta
```
public void setTransformPartitioningMeta(TransformPartitioningMeta transformPartitioningMeta)
```
    Parameters:
    
    transformPartitioningMeta - the transformPartitioningMeta to set
  - isDistributes
```
public boolean isDistributes()
```
    Returns:
    
    the distributes
  - setDistributes
```
public void setDistributes(boolean distributes)
```
    Parameters:
    
    distributes - the distributes to set
  - getTransformErrorMeta
```
public TransformErrorMeta getTransformErrorMeta()
```
    Returns:
    
    the TransformErrorMeta error handling metadata for this transform
  - setTransformErrorMeta
```
public void setTransformErrorMeta(TransformErrorMeta transformErrorMeta)
```
    Parameters:
    
    transformErrorMeta - the error handling metadata for this transform
  - findTransform
```
public static final TransformMeta findTransform(List<TransformMeta> transforms,
                                                String transformName)
```
    Find a transform with its name in a given ArrayList of transforms
    
    Parameters:
    
    transforms - The List of transforms to search
    
    transformName - The name of the transform
    
    Returns:
    
    The transform if it was found, null if nothing was found
  - supportsErrorHandling
```
public boolean supportsErrorHandling()
```
  - isDoingErrorHandling
```
public boolean isDoingErrorHandling()
```
    Returns:
    
    if error handling is supported for this transform, if error handling is defined and a target transform is set
  - isSendingErrorRowsToTransform
```
public boolean isSendingErrorRowsToTransform(TransformMeta targetTransform)
```
  - getTypeId
```
public String getTypeId()
```
    Support for ICheckResultSource
    
    Specified by:
    
    getTypeId in interface IResourceHolder
    
    Returns:
    
    JOBENTRY, TRANSFORM, etc.
  - getPluginId
```
public String getPluginId()
```
    Specified by:
    
    getPluginId in interface IResourceHolder
    
    Returns:
    
    The Type ID of the resource holder. The Type ID is the system-defined type identifier (like PIPELINE or SORT).
  - isMapping
```
public boolean isMapping()
```
  - isSingleThreader
```
public boolean isSingleThreader()
```
  - isEtlMetaInject
```
public boolean isEtlMetaInject()
```
  - isWorkflowExecutor
```
public boolean isWorkflowExecutor()
```
  - isMappingInput
```
public boolean isMappingInput()
```
  - isMappingOutput
```
public boolean isMappingOutput()
```
  - getResourceDependencies
```
public List<ResourceReference> getResourceDependencies(IVariables variables)
```
    Get a list of all the resource dependencies that the transform is depending on.
    
    Returns:
    
    a list of all the resource dependencies that the transform is depending on
  - exportResources
```
public String exportResources(IVariables variables,
                              Map<String,ResourceDefinition> definitions,
                              IResourceNaming iResourceNaming,
                              IHopMetadataProvider metadataProvider)
                       throws HopException
```
    Description copied from interface: IResourceExport
    
    Exports the object to a flat-file system, adding content with filename keys to a set of definitions. The supplied resource naming interface allows the object to name appropriately without worrying about those parts of the implementation specific details.
    
    Specified by:
    
    exportResources in interface IResourceExport
    
    Parameters:
    
    variables - The variable variables to resolve (environment) variables with.
    
    definitions - The map containing the filenames and content
    
    iResourceNaming - The resource naming interface allows the object to name appropriately
    
    metadataProvider - the central metadata to load non-hop specific metadata from
    
    Returns:
    
    The filename for this object. (also contained in the definitions map)
    
    Throws:
    
    HopException - in case something goes wrong during the export
  - getTargetTransformPartitioningMeta
```
public TransformPartitioningMeta getTargetTransformPartitioningMeta()
```
    Returns:
    
    the targetTransformPartitioningMeta
  - setTargetTransformPartitioningMeta
```
public void setTargetTransformPartitioningMeta(TransformPartitioningMeta targetTransformPartitioningMeta)
```
    Parameters:
    
    targetTransformPartitioningMeta - the targetTransformPartitioningMeta to set
  - isRepartitioning
```
public boolean isRepartitioning()
```
  - setTransformPluginId
```
public void setTransformPluginId(String transformPluginId)
```
    Set the plugin transform id (code)
    
    Parameters:
    
    transformPluginId -
  - setParentPipelineMeta
```
public void setParentPipelineMeta(PipelineMeta parentPipelineMeta)
```
  - getParentPipelineMeta
```
public PipelineMeta getParentPipelineMeta()
```
  - getRowDistribution
```
public IRowDistribution getRowDistribution()
```
  - setRowDistribution
```
public void setRowDistribution(IRowDistribution rowDistribution)
```
  - getCopiesString
```
public String getCopiesString()
```
    Returns:
    
    the copiesString
  - setCopiesString
```
public void setCopiesString(String copiesString)
```
    Parameters:
    
    copiesString - the copiesString to set
  - setAttributesMap
```
public void setAttributesMap(Map<String,Map<String,String>> attributesMap)
```
    Specified by:
    
    setAttributesMap in interface IAttributes
  - getAttributesMap
```
public Map<String,Map<String,String>> getAttributesMap()
```
    Specified by:
    
    getAttributesMap in interface IAttributes
  - setAttribute
```
public void setAttribute(String groupName,
                         String key,
                         String value)
```
    Specified by:
    
    setAttribute in interface IAttributes
  - setAttributes
```
public void setAttributes(String groupName,
                          Map<String,String> attributes)
```
    Specified by:
    
    setAttributes in interface IAttributes
  - getAttributes
```
public Map<String,String> getAttributes(String groupName)
```
    Specified by:
    
    getAttributes in interface IAttributes
  - getAttribute
```
public String getAttribute(String groupName,
                           String key)
```
    Specified by:
    
    getAttribute in interface IAttributes
  - isMissing
```
public boolean isMissing()
```
  - isDeprecated
```
public boolean isDeprecated()
```
  - getSuggestion
```
public String getSuggestion()
```

Class TransformMeta

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

XML_TAG

STRING_ID_MAPPING

STRING_ID_SINGLE_THREADER

STRING_ID_ETL_META_INJECT

STRING_ID_WORKFLOW_EXECUTOR

STRING_ID_MAPPING_INPUT

STRING_ID_MAPPING_OUTPUT

attributesMap

Constructor Detail

TransformMeta

TransformMeta

TransformMeta

TransformMeta

Method Detail

getXml

fromXml

setCopies

getCopies

equals

hashCode

compareTo

hasChanged

setChanged

setChanged

chosesTargetTransforms

clone

replaceMeta

getTransform

setTransform

getTransformPluginId

getName

setName

getDescription

setDescription

setSelected

flipSelected

isSelected

setTerminator

setTerminator

hasTerminator

setLocation

setLocation

getLocation

check

toString

isPartitioned

isTargetPartitioned

getTransformPartitioningMeta

setTransformPartitioningMeta

isDistributes

setDistributes

getTransformErrorMeta

setTransformErrorMeta

findTransform

supportsErrorHandling

isDoingErrorHandling

isSendingErrorRowsToTransform

getTypeId

getPluginId

isMapping

isSingleThreader

isEtlMetaInject

isWorkflowExecutor

isMappingInput

isMappingOutput

getResourceDependencies

exportResources

getTargetTransformPartitioningMeta

setTargetTransformPartitioningMeta

isRepartitioning

setTransformPluginId

setParentPipelineMeta

getParentPipelineMeta

getRowDistribution