io.cdap.cdap.api.dataset.lib

Class PartitionFilter

java.lang.Object

io.cdap.cdap.api.dataset.lib.PartitionFilter

public class PartitionFilter
extends Object

Describes a filter over partition keys.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PartitionFilter.Builder A builder for partition filters.
static class	PartitionFilter.Condition<T extends Comparable<T>> Represents a condition on a partitioning field, by means of an inclusive lower bound and an exclusive upper bound.

Field Summary

Fields

Modifier and Type	Field and Description
static PartitionFilter	ALWAYS_MATCH

Method Summary

Modifier and Type	Method and Description
static PartitionFilter.Builder	builder() Use this to create PartitionFilters.
boolean	equals(Object o)
PartitionFilter.Condition<? extends Comparable>	getCondition(String fieldName)
Map<String,PartitionFilter.Condition<? extends Comparable>>	getConditions() This should be used for inspection or debugging only.
int	hashCode()
boolean	match(PartitionKey partitionKey) Match this filter against a partition key.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

ALWAYS_MATCH

public static final PartitionFilter ALWAYS_MATCH

Method Detail

getConditions

public Map<String,PartitionFilter.Condition<? extends Comparable>> getConditions()

This should be used for inspection or debugging only. To match this filter, use the match(io.cdap.cdap.api.dataset.lib.PartitionKey) method.

Returns:

the individual conditions of this filter.

getCondition

public PartitionFilter.Condition<? extends Comparable> getCondition(String fieldName)

Returns:

the condition for a particular field.

match

public boolean match(PartitionKey partitionKey)

Match this filter against a partition key. The key matches iff it matches all conditions.

Throws:

IllegalArgumentException - if one of the field types in the partition key are incompatible

toString

public String toString()

Overrides:

toString in class Object

builder

public static PartitionFilter.Builder builder()

Use this to create PartitionFilters.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object