org.apache.flink.compiler.dataproperties

Class RequestedGlobalProperties

java.lang.Object

org.apache.flink.compiler.dataproperties.RequestedGlobalProperties

All Implemented Interfaces:

Cloneable

public final class RequestedGlobalProperties
extends Object
implements Cloneable

This class represents global properties of the data that an operator is interested in, because it needs those properties for its contract.

Currently, the properties are the following: A partitioning type (ANY, HASH, RANGE), and EITHER an ordering (for range partitioning) or an FieldSet with the hash partitioning columns.

Constructor Summary

Constructors

Constructor and Description
RequestedGlobalProperties() Initializes the global properties with no partitioning.

Method Summary

Modifier and Type	Method and Description
RequestedGlobalProperties	clone()
boolean	equals(Object obj)
RequestedGlobalProperties	filterByNodesConstantSet(OptimizerNode node, int input) Filters these properties by what can be preserved by the given node when propagated down to the given input.
DataDistribution	getDataDistribution() Gets the data distribution.
Ordering	getOrdering() Gets the key order.
FieldSet	getPartitionedFields() Gets the fields on which the data is partitioned.
PartitioningProperty	getPartitioning() Gets the partitioning property.
int	hashCode()
boolean	isMetBy(GlobalProperties props) Checks, if this set of interesting properties, is met by the given produced properties.
boolean	isTrivial() Checks, if the properties in this object are trivial, i.e.
void	parameterizeChannel(Channel channel, boolean globalDopChange) Parameterizes the ship strategy fields of a channel such that the channel produces the desired global properties.
void	reset() This method resets the properties to a state where no properties are given.
void	setAnyPartitioning(FieldSet partitionedFields)
void	setForceRebalancing()
void	setFullyReplicated()
void	setHashPartitioned(FieldSet partitionedFields) Sets the partitioning property for the global properties.
void	setRandomDistribution()
void	setRangePartitioned(Ordering ordering)
void	setRangePartitioned(Ordering ordering, DataDistribution dataDistribution)
String	toString()

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

RequestedGlobalProperties

public RequestedGlobalProperties()

Initializes the global properties with no partitioning.

Method Detail

setHashPartitioned

public void setHashPartitioned(FieldSet partitionedFields)

Sets the partitioning property for the global properties.

Parameters:

partitionedFields -

setRangePartitioned

public void setRangePartitioned(Ordering ordering)

setRangePartitioned

public void setRangePartitioned(Ordering ordering,
                                DataDistribution dataDistribution)

setAnyPartitioning

public void setAnyPartitioning(FieldSet partitionedFields)

setRandomDistribution

public void setRandomDistribution()

setFullyReplicated

public void setFullyReplicated()

setForceRebalancing

public void setForceRebalancing()

getPartitioning

public PartitioningProperty getPartitioning()

Gets the partitioning property.

Returns:

The partitioning property.

getPartitionedFields

public FieldSet getPartitionedFields()

Gets the fields on which the data is partitioned.

Returns:

The partitioning fields.

getOrdering

public Ordering getOrdering()

Gets the key order.

Returns:

The key order.

getDataDistribution

public DataDistribution getDataDistribution()

Gets the data distribution.

Returns:

The data distribution.

isTrivial

public boolean isTrivial()

Checks, if the properties in this object are trivial, i.e. only standard values.

reset

public void reset()

This method resets the properties to a state where no properties are given.

filterByNodesConstantSet

public RequestedGlobalProperties filterByNodesConstantSet(OptimizerNode node,
                                                          int input)

Filters these properties by what can be preserved by the given node when propagated down to the given input.

Parameters:

node - The node representing the contract.

input - The index of the input.

Returns:

True, if any non-default value is preserved, false otherwise.

isMetBy

public boolean isMetBy(GlobalProperties props)

Checks, if this set of interesting properties, is met by the given produced properties.

Parameters:

props - The properties for which to check whether they meet these properties.

Returns:

True, if the properties are met, false otherwise.

parameterizeChannel

public void parameterizeChannel(Channel channel,
                                boolean globalDopChange)

Parameterizes the ship strategy fields of a channel such that the channel produces the desired global properties.

Parameters:

channel - The channel to parameterize.

globalDopChange -

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

clone

public RequestedGlobalProperties clone()

Overrides:

clone in class Object