Package org.apache.orc

Class DataMask.Factory

java.lang.Object

org.apache.orc.DataMask.Factory

Enclosing interface:

DataMask

public static class DataMask.Factory
extends Object

To create a DataMask, the users should come through this API. It supports extension via additional DataMask.Provider implementations that are accessed through Java's ServiceLoader API.

Constructor Summary

Constructors

Constructor	Description
Factory()

Method Summary

Modifier and Type	Method	Description
static DataMask	build(DataMaskDescription mask, TypeDescription schema, DataMask.MaskOverrides overrides)	Build a new DataMask instance.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Factory

public Factory()

Method Details

build

public static DataMask build(DataMaskDescription mask,
 TypeDescription schema,
 DataMask.MaskOverrides overrides)

Build a new DataMask instance.

Parameters:

mask - the description of the data mask

schema - the type of the field

overrides - sub-columns where the mask is overridden

Returns:

a new DataMask

Throws:

IllegalArgumentException - if no such kind of data mask was found

See Also:

• for the standard provider