Package org.apache.hop.pipeline

Class ModPartitioner

java.lang.Object

org.apache.hop.pipeline.BasePartitioner

org.apache.hop.pipeline.ModPartitioner

All Implemented Interfaces:

IPartitioner

@PartitionerPlugin(id="ModPartitioner",
                   name="Remainder of division",
                   description="Mod")
public class ModPartitioner
extends BasePartitioner

Field Summary

Fields

Modifier and Type	Field	Description
protected int	partitionColumnIndex

Fields inherited from class org.apache.hop.pipeline.BasePartitioner

description, id, meta, nrPartitions

Constructor Summary

Constructors

Constructor	Description
ModPartitioner()

Method Summary

Modifier and Type	Method	Description
ModPartitioner	clone()	Clone.
String	getDescription()	Gets the description.
String	getDialogClassName()	Gets the dialog class name.
String	getFieldName()
IPartitioner	getInstance()	Gets the single instance of IPartitioner.
int	getPartition(IVariables variables, IRowMeta rowMeta, Object[] row)	Gets the partition.
String	getXml()	Gets the xml.
void	loadXml(Node partitioningMethodNode)	Load xml.
void	setFieldName(String fieldName)

Methods inherited from class org.apache.hop.pipeline.BasePartitioner

getId, getMeta, getNrPartitions, init, setDescription, setId, setMeta, setNrPartitions

Methods inherited from class java.lang.Object

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

Field Detail

partitionColumnIndex

protected int partitionColumnIndex

Constructor Detail

ModPartitioner

public ModPartitioner()

Method Detail

getInstance

public IPartitioner getInstance()

Description copied from interface: IPartitioner

Gets the single instance of IPartitioner.

Specified by:

getInstance in interface IPartitioner

Specified by:

getInstance in class BasePartitioner

Returns:

single instance of IPartitioner

clone

public ModPartitioner clone()

Description copied from interface: IPartitioner

Clone.

Specified by:

clone in interface IPartitioner

Overrides:

clone in class BasePartitioner

Returns:

the partitioner

getDialogClassName

public String getDialogClassName()

Description copied from interface: IPartitioner

Gets the dialog class name.

Returns:

the dialog class name

getPartition

public int getPartition(IVariables variables,
                        IRowMeta rowMeta,
                        Object[] row)
                 throws HopException

Description copied from interface: IPartitioner

Gets the partition.

Parameters:

variables - the variables to resolve variable expressions with

rowMeta - the row meta

row - the r

Returns:

the partition

Throws:

HopException - the hop exception

getDescription

public String getDescription()

Description copied from interface: IPartitioner

Gets the description.

Specified by:

getDescription in interface IPartitioner

Overrides:

getDescription in class BasePartitioner

Returns:

the description

getXml

public String getXml()

Description copied from interface: IPartitioner

Gets the xml.

Returns:

the xml

loadXml

public void loadXml(Node partitioningMethodNode)
             throws HopXmlException

Description copied from interface: IPartitioner

Load xml.

Parameters:

partitioningMethodNode - the partitioning method node

Throws:

HopXmlException - the hop xml exception

getFieldName

public String getFieldName()

setFieldName

public void setFieldName(String fieldName)