Package org.apache.hop.pipeline

Class BasePartitioner

java.lang.Object

org.apache.hop.pipeline.BasePartitioner

All Implemented Interfaces:

IPartitioner

Direct Known Subclasses:

ModPartitioner

public abstract class BasePartitioner
extends Object
implements IPartitioner

Implements common functionality needed by partitioner plugins.

Field Summary

Fields

Modifier and Type	Field	Description
protected String	description
protected String	id
protected TransformPartitioningMeta	meta
protected int	nrPartitions

Constructor Summary

Constructors

Constructor	Description
BasePartitioner()	Instantiates a new base partitioner.

Method Summary

Modifier and Type	Method	Description
IPartitioner	clone()	Clone.
String	getDescription()	Gets the description.
String	getId()	Gets the id.
abstract IPartitioner	getInstance()	Gets the single instance of IPartitioner.
TransformPartitioningMeta	getMeta()	Gets the meta.
int	getNrPartitions()	Gets the nr partitions.
void	init(IVariables variables, IRowMeta rowMeta)	Initialises the partitioner.
void	setDescription(String description)	Sets the description.
void	setId(String id)	Sets the id.
void	setMeta(TransformPartitioningMeta meta)	Sets the meta.
void	setNrPartitions(int nrPartitions)	Sets the nr partitions.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.hop.pipeline.IPartitioner

getDialogClassName, getPartition, getXml, loadXml

Field Detail

meta

protected TransformPartitioningMeta meta

nrPartitions

protected int nrPartitions

id

protected String id

description

protected String description

Constructor Detail

BasePartitioner

public BasePartitioner()

Instantiates a new base partitioner.

Method Detail

clone

public IPartitioner clone()

Description copied from interface: IPartitioner

Clone.

Specified by:

clone in interface IPartitioner

Overrides:

clone in class Object

Returns:

the partitioner

getNrPartitions

public int getNrPartitions()

Gets the nr partitions.

Returns:

the nr partitions

setNrPartitions

public void setNrPartitions(int nrPartitions)

Sets the nr partitions.

Parameters:

nrPartitions - the new nr partitions

init

public void init(IVariables variables,
                 IRowMeta rowMeta)
          throws HopException

Initialises the partitioner.

Parameters:

variables - the variables to use to resolve variables expressions

rowMeta - the row meta

Throws:

HopException - the hop exception

getMeta

public TransformPartitioningMeta getMeta()

Gets the meta.

Returns:

the meta

setMeta

public void setMeta(TransformPartitioningMeta meta)

Description copied from interface: IPartitioner

Sets the meta.

Specified by:

setMeta in interface IPartitioner

Parameters:

meta - the new meta

getInstance

public abstract IPartitioner getInstance()

Description copied from interface: IPartitioner

Gets the single instance of IPartitioner.

Specified by:

getInstance in interface IPartitioner

Returns:

single instance of IPartitioner

getDescription

public String getDescription()

Description copied from interface: IPartitioner

Gets the description.

Specified by:

getDescription in interface IPartitioner

Returns:

the description

setDescription

public void setDescription(String description)

Description copied from interface: IPartitioner

Sets the description.

Specified by:

setDescription in interface IPartitioner

Parameters:

description - the new description

getId

public String getId()

Description copied from interface: IPartitioner

Gets the id.

Specified by:

getId in interface IPartitioner

Returns:

the id

setId

public void setId(String id)

Description copied from interface: IPartitioner

Sets the id.

Specified by:

setId in interface IPartitioner

Parameters:

id - the new id