io.cdap.transformation.api

Interface MutableRowSchema

public interface MutableRowSchema

Schema of a row. It's a mutable version of

Method Summary

Modifier and Type	Method and Description
Schema.Field	getField(String columnName) Get the Schema.Field of a column by its name.
void	renameField(String originalName, String newName) Rename a field.
void	setField(Schema.Field field) Set the Schema.Field of a column by its name in the Schema.Field.
Schema	toSchema()

Method Detail

getField

Schema.Field getField(String columnName)
               throws NotFoundException

Get the Schema.Field of a column by its name. if the column was once renamed , the new name should be used to get the Schema.Field.

Parameters:

columnName - the name of the column. Once renamed , new name should be used to get the Schema.Field.

Returns:

the Schema.Field of the corresponding column.

Throws:

NotFoundException - if the given column name doesn't exist.

setField

void setField(Schema.Field field)

Set the Schema.Field of a column by its name in the Schema.Field. Once renamed, new name should be used to set the Schema.Field again. If the given name doesn't exist , a new field will be added.

Parameters:

field - the new Schema.Field of the column.

Throws:

IllegalArgumentException - if the specified field is null or the specified field doesn't have a name associated with it.

renameField

void renameField(String originalName,
                 String newName)

Rename a field.

Parameters:

originalName - the original name of the field to be renamed.

newName - the new name of the field.

Throws:

IllegalArgumentException - if the original field name doesn't exist or the new field name already exists.

toSchema

Schema toSchema()

Returns:

the corresponding which is immutable.