Transforms (client-java 0.9.1 API)

java.lang.Object
- org.apache.gravitino.rel.expressions.transforms.Transforms

```
public class Transforms
extends java.lang.Object
```
Helper methods to create logical transforms to pass into Apache Gravitino.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`Transforms.ApplyTransform` A transform that applies a function to the input value.
`static class`	`Transforms.BucketTransform` A transform that returns the bucket of the input value.
`static class`	`Transforms.DayTransform` A transform that returns the day of the input value.
`static class`	`Transforms.HourTransform` A transform that returns the hour of the input value.
`static class`	`Transforms.IdentityTransform` A transform that returns the input value.
`static class`	`Transforms.ListTransform` A transform that includes multiple fields in a list.
`static class`	`Transforms.MonthTransform` A transform that returns the month of the input value.
`static class`	`Transforms.RangeTransform` A transform that returns the range of the input value.
`static class`	`Transforms.TruncateTransform` A transform that returns the truncated value of the input value with the given width.
`static class`	`Transforms.YearTransform` A transform that returns the year of the input value.

Field Summary

Fields
Modifier and Type	Field and Description
`static Transform[]`	`EMPTY_TRANSFORM` An empty array of transforms.
`static java.lang.String`	`NAME_OF_BUCKET` The name of the bucket transform.
`static java.lang.String`	`NAME_OF_DAY` The name of the day transform.
`static java.lang.String`	`NAME_OF_HOUR` The name of the hour transform.
`static java.lang.String`	`NAME_OF_IDENTITY` The name of the identity transform.
`static java.lang.String`	`NAME_OF_LIST` The name of the list transform.
`static java.lang.String`	`NAME_OF_MONTH` The name of the month transform.
`static java.lang.String`	`NAME_OF_RANGE` The name of the range transform.
`static java.lang.String`	`NAME_OF_TRUNCATE` The name of the truncate transform.
`static java.lang.String`	`NAME_OF_YEAR` The name of the year transform.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static Transforms.ApplyTransform`	`apply(java.lang.String name, Expression[] arguments)` Create a transform that applies a function to the input value.
`static Transforms.BucketTransform`	`bucket(int numBuckets, java.lang.String[]... fieldNames)` Create a transform that returns the bucket of the input value.
`static Transforms.DayTransform`	`day(java.lang.String columnName)` Create a transform that returns the day of the input value.
`static Transforms.DayTransform`	`day(java.lang.String[] fieldName)` Create a transform that returns the day of the input value.
`static Transforms.HourTransform`	`hour(java.lang.String columnName)` Create a transform that returns the hour of the input value.
`static Transforms.HourTransform`	`hour(java.lang.String[] fieldName)` Create a transform that returns the hour of the input value.
`static Transforms.IdentityTransform`	`identity(java.lang.String columnName)` Create a transform that returns the input value.
`static Transforms.IdentityTransform`	`identity(java.lang.String[] fieldName)` Create a transform that returns the input value.
`static Transforms.ListTransform`	`list(java.lang.String[]... fieldNames)` Create a transform that includes multiple fields in a list.
`static Transforms.ListTransform`	`list(java.lang.String[][] fieldNames, ListPartition[] assignments)` Create a transform that includes multiple fields in a list with preassigned list partitions.
`static Transforms.MonthTransform`	`month(java.lang.String columnName)` Create a transform that returns the month of the input value.
`static Transforms.MonthTransform`	`month(java.lang.String[] fieldName)` Create a transform that returns the month of the input value.
`static Transforms.RangeTransform`	`range(java.lang.String[] fieldName)` Create a transform that returns the range of the input value.
`static Transforms.RangeTransform`	`range(java.lang.String[] fieldName, RangePartition[] assignments)` Create a transform that returns the range of the input value with preassigned range partitions.
`static Transforms.TruncateTransform`	`truncate(int width, java.lang.String columnName)` Create a transform that returns the truncated value of the input value with the given width.
`static Transforms.TruncateTransform`	`truncate(int width, java.lang.String[] fieldName)` Create a transform that returns the truncated value of the input value with the given width.
`static Transforms.YearTransform`	`year(java.lang.String columnName)` Create a transform that returns the year of the input value.
`static Transforms.YearTransform`	`year(java.lang.String[] fieldName)` Create a transform that returns the year of the input value.

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

- Field Detail
  - EMPTY_TRANSFORM
```
public static final Transform[] EMPTY_TRANSFORM
```
    An empty array of transforms.
  - NAME_OF_IDENTITY
```
public static final java.lang.String NAME_OF_IDENTITY
```
    The name of the identity transform.
    
    See Also:
    
    Constant Field Values
  - NAME_OF_YEAR
```
public static final java.lang.String NAME_OF_YEAR
```
    The name of the year transform. The year transform returns the year of the input value.
    
    See Also:
    
    Constant Field Values
  - NAME_OF_MONTH
```
public static final java.lang.String NAME_OF_MONTH
```
    The name of the month transform. The month transform returns the month of the input value.
    
    See Also:
    
    Constant Field Values
  - NAME_OF_DAY
```
public static final java.lang.String NAME_OF_DAY
```
    The name of the day transform. The day transform returns the day of the input value.
    
    See Also:
    
    Constant Field Values
  - NAME_OF_HOUR
```
public static final java.lang.String NAME_OF_HOUR
```
    The name of the hour transform. The hour transform returns the hour of the input value.
    
    See Also:
    
    Constant Field Values
  - NAME_OF_BUCKET
```
public static final java.lang.String NAME_OF_BUCKET
```
    The name of the bucket transform. The bucket transform returns the bucket of the input value.
    
    See Also:
    
    Constant Field Values
  - NAME_OF_TRUNCATE
```
public static final java.lang.String NAME_OF_TRUNCATE
```
    The name of the truncate transform. The truncate transform returns the truncated value of the
    
    See Also:
    
    Constant Field Values
  - NAME_OF_LIST
```
public static final java.lang.String NAME_OF_LIST
```
    The name of the list transform. The list transform includes multiple fields in a list.
    
    See Also:
    
    Constant Field Values
  - NAME_OF_RANGE
```
public static final java.lang.String NAME_OF_RANGE
```
    The name of the range transform. The range transform returns the range of the input value.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - identity
```
public static Transforms.IdentityTransform identity(java.lang.String[] fieldName)
```
    Create a transform that returns the input value.
    
    Parameters:
    
    fieldName - The field name to transform
    
    Returns:
    
    The created transform
  - identity
```
public static Transforms.IdentityTransform identity(java.lang.String columnName)
```
    Create a transform that returns the input value.
    
    Parameters:
    
    columnName - The column name to transform
    
    Returns:
    
    The created transform
  - year
```
public static Transforms.YearTransform year(java.lang.String[] fieldName)
```
    Create a transform that returns the year of the input value.
    
    Parameters:
    
    fieldName - The field name to transform
    
    Returns:
    
    The created transform
  - year
```
public static Transforms.YearTransform year(java.lang.String columnName)
```
    Create a transform that returns the year of the input value.
    
    Parameters:
    
    columnName - The column name to transform
    
    Returns:
    
    The created transform
  - month
```
public static Transforms.MonthTransform month(java.lang.String[] fieldName)
```
    Create a transform that returns the month of the input value.
    
    Parameters:
    
    fieldName - The field name to transform
    
    Returns:
    
    The created transform
  - month
```
public static Transforms.MonthTransform month(java.lang.String columnName)
```
    Create a transform that returns the month of the input value.
    
    Parameters:
    
    columnName - The column name to transform
    
    Returns:
    
    The created transform
  - day
```
public static Transforms.DayTransform day(java.lang.String[] fieldName)
```
    Create a transform that returns the day of the input value.
    
    Parameters:
    
    fieldName - The field name to transform
    
    Returns:
    
    The created transform
  - day
```
public static Transforms.DayTransform day(java.lang.String columnName)
```
    Create a transform that returns the day of the input value.
    
    Parameters:
    
    columnName - The column name to transform
    
    Returns:
    
    The created transform
  - hour
```
public static Transforms.HourTransform hour(java.lang.String[] fieldName)
```
    Create a transform that returns the hour of the input value.
    
    Parameters:
    
    fieldName - The field name to transform
    
    Returns:
    
    The created transform
  - hour
```
public static Transforms.HourTransform hour(java.lang.String columnName)
```
    Create a transform that returns the hour of the input value.
    
    Parameters:
    
    columnName - The column name to transform
    
    Returns:
    
    The created transform
  - bucket
```
public static Transforms.BucketTransform bucket(int numBuckets,
                                                java.lang.String[]... fieldNames)
```
    Create a transform that returns the bucket of the input value.
    
    Parameters:
    
    numBuckets - The number of buckets to use
    
    fieldNames - The field names to transform
    
    Returns:
    
    The created transform
  - list
```
public static Transforms.ListTransform list(java.lang.String[]... fieldNames)
```
    Create a transform that includes multiple fields in a list.
    
    Parameters:
    
    fieldNames - The field names to include in the list
    
    Returns:
    
    The created transform
  - list
```
public static Transforms.ListTransform list(java.lang.String[][] fieldNames,
                                            ListPartition[] assignments)
```
    Create a transform that includes multiple fields in a list with preassigned list partitions.
    
    Parameters:
    
    fieldNames - The field names to include in the list
    
    assignments - The preassigned list partitions
    
    Returns:
    
    The created transform
  - range
```
public static Transforms.RangeTransform range(java.lang.String[] fieldName)
```
    Create a transform that returns the range of the input value.
    
    Parameters:
    
    fieldName - The field name to transform
    
    Returns:
    
    The created transform
  - range
```
public static Transforms.RangeTransform range(java.lang.String[] fieldName,
                                              RangePartition[] assignments)
```
    Create a transform that returns the range of the input value with preassigned range partitions.
    
    Parameters:
    
    fieldName - The field name to transform
    
    assignments - The preassigned range partitions
    
    Returns:
    
    The created transform
  - truncate
```
public static Transforms.TruncateTransform truncate(int width,
                                                    java.lang.String[] fieldName)
```
    Create a transform that returns the truncated value of the input value with the given width.
    
    Parameters:
    
    width - The width to truncate to
    
    fieldName - The field name to transform
    
    Returns:
    
    The created transform
  - truncate
```
public static Transforms.TruncateTransform truncate(int width,
                                                    java.lang.String columnName)
```
    Create a transform that returns the truncated value of the input value with the given width.
    
    Parameters:
    
    width - The width to truncate to
    
    columnName - The column name to transform
    
    Returns:
    
    The created transform
  - apply
```
public static Transforms.ApplyTransform apply(java.lang.String name,
                                              Expression[] arguments)
```
    Create a transform that applies a function to the input value.
    
    Parameters:
    
    name - The name of the function to apply
    
    arguments - The arguments to the function
    
    Returns:
    
    The created transform

Class Transforms

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

EMPTY_TRANSFORM

NAME_OF_IDENTITY

NAME_OF_YEAR

NAME_OF_MONTH

NAME_OF_DAY

NAME_OF_HOUR

NAME_OF_BUCKET

NAME_OF_TRUNCATE

NAME_OF_LIST

NAME_OF_RANGE

Method Detail

identity

identity

year

year

month

month

day

day

hour

hour

bucket

list

list

range

range

truncate

truncate

apply