RelCompositeTrait (Calcite Core 1.16.0 API)

java.lang.Object
- org.apache.calcite.plan.RelCompositeTrait<T>

Type Parameters:

T - Member trait

All Implemented Interfaces:

RelTrait

Direct Known Subclasses:

RelCompositeTrait.EmptyCompositeTrait
```
class RelCompositeTrait<T extends RelMultipleTrait>
extends Object
implements RelTrait
```
A trait that consists of a list of traits, all of the same type.
It exists so that multiple traits of the same type (RelTraitDef) can be stored in the same RelTraitSet.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

private static class RelCompositeTrait.EmptyCompositeTrait<T extends RelMultipleTrait>
Composite trait with 0 elements.

Nested Classes
Modifier and Type	Class and Description
`private static class`	`RelCompositeTrait.EmptyCompositeTrait<T extends RelMultipleTrait>` Composite trait with 0 elements.

Field Summary

Fields
Modifier and Type Field and Description

private RelTraitDef traitDef

private T[] traits

Fields
Modifier and Type	Field and Description
`private RelTraitDef`	`traitDef`
`private T[]`	`traits`

Constructor Summary

Constructors
Modifier Constructor and Description

private RelCompositeTrait(RelTraitDef traitDef, T[] traits)
Creates a RelCompositeTrait.

Constructors
Modifier	Constructor and Description
`private`	`RelCompositeTrait(RelTraitDef traitDef, T[] traits)` Creates a RelCompositeTrait.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`(package private) RelCompositeTrait<T>`	`canonize(RelTraitDef<T> traitDef)`
`boolean`	`equals(Object obj)` See note about equals() and hashCode().
`RelTraitDef`	`getTraitDef()` Returns the RelTraitDef that defines this RelTrait.
`int`	`hashCode()` See note about equals() and hashCode().
`(package private) static <T extends RelMultipleTrait> RelCompositeTrait<T>`	`of(RelTraitDef def, List<T> traitList)` Creates a RelCompositeTrait.
`void`	`register(RelOptPlanner planner)` Registers a trait instance with the planner.
`boolean`	`satisfies(RelTrait trait)` Returns whether this trait satisfies a given trait.
`int`	`size()`
`String`	`toString()` Returns a succinct name for this trait.
`T`	`trait(int i)`
`List<T>`	`traitList()` Returns an immutable list of the traits in this composite trait.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - traitDef
```
private final RelTraitDef traitDef
```
  - traits
```
private final T extends RelMultipleTrait[] traits
```
- Constructor Detail
  - RelCompositeTrait
```
private RelCompositeTrait(RelTraitDef traitDef,
                          T[] traits)
```
    Creates a RelCompositeTrait.
- Method Detail
  - of
```
static <T extends RelMultipleTrait> RelCompositeTrait<T> of(RelTraitDef def,
                                                            List<T> traitList)
```
    Creates a RelCompositeTrait. The constituent traits are canonized.
  - getTraitDef
```
public RelTraitDef getTraitDef()
```
    Description copied from interface: RelTrait
    
    Returns the RelTraitDef that defines this RelTrait.
    
    Specified by:
    
    getTraitDef in interface RelTrait
    
    Returns:
    
    the RelTraitDef that defines this RelTrait
  - hashCode
```
public int hashCode()
```
    Description copied from interface: RelTrait
    
    See note about equals() and hashCode().
    
    Specified by:
    
    hashCode in interface RelTrait
    
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Description copied from interface: RelTrait
    
    See note about equals() and hashCode().
    
    Specified by:
    
    equals in interface RelTrait
    
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Description copied from interface: RelTrait
    
    Returns a succinct name for this trait. The planner may use this String to describe the trait.
    
    Specified by:
    
    toString in interface RelTrait
    
    Overrides:
    
    toString in class Object
  - satisfies
```
public boolean satisfies(RelTrait trait)
```
    Description copied from interface: RelTrait
    
    Returns whether this trait satisfies a given trait.
    A trait satisfies another if it is the same or stricter. For example, ORDER BY x, y satisfies ORDER BY x.
    A trait's satisfies relation must be a partial order (reflexive, anti-symmetric, transitive). Many traits cannot be "loosened"; their satisfies is an equivalence relation, where only X satisfies X.
    If a trait has multiple values (see RelCompositeTrait) a collection (T0, T1, ...) satisfies T if any Ti satisfies T.
    
    Specified by:
    
    satisfies in interface RelTrait
    
    Parameters:
    
    trait - Given trait
    
    Returns:
    
    Whether this trait subsumes a given trait
  - register
```
public void register(RelOptPlanner planner)
```
    Description copied from interface: RelTrait
    
    Registers a trait instance with the planner.
    This is an opportunity to add rules that relate to that trait. However, typical implementations will do nothing.
    
    Specified by:
    
    register in interface RelTrait
    
    Parameters:
    
    planner - Planner
  - traitList
```
public List<T> traitList()
```
    Returns an immutable list of the traits in this composite trait.
  - canonize
```
RelCompositeTrait<T> canonize(RelTraitDef<T> traitDef)
```
  - trait
```
public T trait(int i)
```
  - size
```
public int size()
```

Class RelCompositeTrait<T extends RelMultipleTrait>

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

traitDef

traits

Constructor Detail

RelCompositeTrait

Method Detail

of

getTraitDef

hashCode

equals

toString

satisfies

register

traitList

canonize

trait

size