org.apache.flink.api.common.operators.util

Class FieldList

java.lang.Object

org.apache.flink.api.common.operators.util.FieldSet

org.apache.flink.api.common.operators.util.FieldList

All Implemented Interfaces:

Iterable<Integer>

@Internal
public class FieldList
extends FieldSet

Immutable ordered list of fields IDs.

Field Summary

Fields

Modifier and Type	Field and Description
static FieldList	EMPTY_LIST

Fields inherited from class org.apache.flink.api.common.operators.util.FieldSet

collection, EMPTY_SET

Constructor Summary

Constructors

Constructor and Description
FieldList()
FieldList(int... columnIndexes)
FieldList(int fieldId)
FieldList(Integer fieldId)

Method Summary

Modifier and Type	Method and Description
FieldList	addField(Integer fieldID)
FieldList	addFields(FieldSet set)
FieldList	addFields(int... fieldIDs)
Integer	get(int pos)
protected String	getDescriptionPrefix()
protected String	getDescriptionSuffix()
boolean	isExactMatch(FieldList list)
boolean	isValidSubset(FieldList list)
boolean	isValidSubset(FieldSet set) Checks if the given set of fields is a valid subset of this set of fields.
boolean	isValidUnorderedPrefix(FieldSet set)
FieldList	toFieldList() Turns the FieldSet into an ordered FieldList.

Methods inherited from class org.apache.flink.api.common.operators.util.FieldSet

clone, contains, equals, hashCode, iterator, size, toArray, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

EMPTY_LIST

public static final FieldList EMPTY_LIST

Constructor Detail

FieldList

public FieldList()

FieldList

public FieldList(int fieldId)

FieldList

public FieldList(Integer fieldId)

FieldList

public FieldList(int... columnIndexes)

Method Detail

addField

public FieldList addField(Integer fieldID)

Overrides:

addField in class FieldSet

addFields

public FieldList addFields(int... fieldIDs)

Overrides:

addFields in class FieldSet

addFields

public FieldList addFields(FieldSet set)

Overrides:

addFields in class FieldSet

get

public Integer get(int pos)

toFieldList

public FieldList toFieldList()

Description copied from class: FieldSet

Turns the FieldSet into an ordered FieldList.

Overrides:

toFieldList in class FieldSet

Returns:

An ordered FieldList.

isValidSubset

public boolean isValidSubset(FieldSet set)

Description copied from class: FieldSet

Checks if the given set of fields is a valid subset of this set of fields. For unordered sets, this is the case if all of the given set's fields are also part of this field.

Subclasses that describe field sets where the field order matters must override this method to implement a field ordering sensitive check.

Overrides:

isValidSubset in class FieldSet

Parameters:

set - The set that is a candidate subset.

Returns:

True, if the given set is a subset of this set, false otherwise.

isValidSubset

public boolean isValidSubset(FieldList list)

isValidUnorderedPrefix

public boolean isValidUnorderedPrefix(FieldSet set)

isExactMatch

public boolean isExactMatch(FieldList list)

getDescriptionPrefix

protected String getDescriptionPrefix()

Overrides:

getDescriptionPrefix in class FieldSet

getDescriptionSuffix

protected String getDescriptionSuffix()

Overrides:

getDescriptionSuffix in class FieldSet