org.apache.flink.optimizer.dataproperties

Class GlobalProperties

java.lang.Object

org.apache.flink.optimizer.dataproperties.GlobalProperties

All Implemented Interfaces:

Cloneable

public class GlobalProperties
extends Object
implements Cloneable

This class represents global properties of the data at a certain point in the plan. Global properties are properties that describe data across different partitions, such as whether the data is hash partitioned, range partitioned, replicated, etc.

Field Summary

Fields

Modifier and Type	Field and Description
static org.slf4j.Logger	LOG

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	addUniqueFieldCombination(FieldSet fields)
void	clearUniqueFieldCombinations()
GlobalProperties	clone()
static GlobalProperties	combine(GlobalProperties gp1, GlobalProperties gp2)
boolean	equals(Object obj)
GlobalProperties	filterBySemanticProperties(SemanticProperties props, int input) Filters these GlobalProperties by the fields that are forwarded to the output as described by the SemanticProperties.
Partitioner<?>	getCustomPartitioner()
DataDistribution	getDataDistribution()
PartitioningProperty	getPartitioning()
FieldList	getPartitioningFields()
Ordering	getPartitioningOrdering()
Set<FieldSet>	getUniqueFieldCombination()
int	hashCode()
boolean	isExactlyPartitionedOnFields(FieldList fields)
boolean	isFullyReplicated()
boolean	isPartitionedOnFields(FieldSet fields)
boolean	isTrivial() Checks, if the properties in this object are trivial, i.e.
boolean	matchesOrderedPartitioning(Ordering o)
void	parameterizeChannel(Channel channel, boolean globalDopChange, ExecutionMode exchangeMode, boolean breakPipeline)
void	reset() This method resets the properties to a state where no properties are given.
void	setAnyPartitioning(FieldList partitionedFields)
void	setCustomPartitioned(FieldList partitionedFields, Partitioner<?> partitioner)
void	setForcedRebalanced()
void	setFullyReplicated()
void	setHashPartitioned(FieldList partitionedFields) Sets this global properties to represent a hash partitioning.
void	setRandomPartitioned()
void	setRangePartitioned(Ordering ordering) Set the parameters for range partition.
void	setRangePartitioned(Ordering ordering, DataDistribution distribution) Set the parameters for range partition.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

LOG

public static final org.slf4j.Logger LOG

Constructor Detail

GlobalProperties

public GlobalProperties()

Initializes the global properties with no partitioning.

Method Detail

setHashPartitioned

public void setHashPartitioned(FieldList partitionedFields)

Sets this global properties to represent a hash partitioning.

Parameters:

partitionedFields - The key fields on which the data is hash partitioned.

setRangePartitioned

public void setRangePartitioned(Ordering ordering)

Set the parameters for range partition.

Parameters:

ordering - Order of the partitioned fields

setRangePartitioned

public void setRangePartitioned(Ordering ordering,
                                DataDistribution distribution)

Set the parameters for range partition.

Parameters:

ordering - Order of the partitioned fields

distribution - The data distribution for range partition. User can supply a customized data distribution, also the data distribution can be null.

setAnyPartitioning

public void setAnyPartitioning(FieldList partitionedFields)

setRandomPartitioned

public void setRandomPartitioned()

setFullyReplicated

public void setFullyReplicated()

setForcedRebalanced

public void setForcedRebalanced()

setCustomPartitioned

public void setCustomPartitioned(FieldList partitionedFields,
                                 Partitioner<?> partitioner)

addUniqueFieldCombination

public void addUniqueFieldCombination(FieldSet fields)

clearUniqueFieldCombinations

public void clearUniqueFieldCombinations()

getUniqueFieldCombination

public Set<FieldSet> getUniqueFieldCombination()

getPartitioningFields

public FieldList getPartitioningFields()

getPartitioningOrdering

public Ordering getPartitioningOrdering()

getPartitioning

public PartitioningProperty getPartitioning()

getCustomPartitioner

public Partitioner<?> getCustomPartitioner()

getDataDistribution

public DataDistribution getDataDistribution()

isPartitionedOnFields

public boolean isPartitionedOnFields(FieldSet fields)

isExactlyPartitionedOnFields

public boolean isExactlyPartitionedOnFields(FieldList fields)

matchesOrderedPartitioning

public boolean matchesOrderedPartitioning(Ordering o)

isFullyReplicated

public boolean isFullyReplicated()

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.

filterBySemanticProperties

public GlobalProperties filterBySemanticProperties(SemanticProperties props,
                                                   int input)

Filters these GlobalProperties by the fields that are forwarded to the output as described by the SemanticProperties.

Parameters:

props - The semantic properties holding information about forwarded fields.

input - The index of the input.

Returns:

The filtered GlobalProperties

parameterizeChannel

public void parameterizeChannel(Channel channel,
                                boolean globalDopChange,
                                ExecutionMode exchangeMode,
                                boolean breakPipeline)

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 GlobalProperties clone()

Overrides:

clone in class Object

combine

public static GlobalProperties combine(GlobalProperties gp1,
                                       GlobalProperties gp2)