Package org.apache.calcite.model

Class ModelHandler

java.lang.Object

org.apache.calcite.model.ModelHandler

public class ModelHandler
extends Object

Reads a model and creates schema objects accordingly.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ModelHandler.ExtraOperand	Extra operands automatically injected into a JsonCustomSchema.operand, as extra context for the adapter.

Constructor Summary

Constructors

Constructor	Description
ModelHandler(CalciteConnection connection, String uri)	Deprecated.
ModelHandler(SchemaPlus rootSchema, String uri)	Creates a ModelHandler that uses the standard class-name filter.
ModelHandler(SchemaPlus rootSchema, String uri, org.apache.calcite.model.ClassNameFilter classNameFilter)	Creates a ModelHandler that validates every class loaded by reflection from the model against classNameFilter.

Method Summary

Modifier and Type	Method	Description
static void	addFunctions(org.apache.calcite.model.ClassNameFilter filter, SchemaPlus schema, @Nullable String functionName, String className, @Nullable String methodName, boolean upCase)	Creates and validates a ScalarFunctionImpl and adds it to a schema, after asking filter to accept className.
static void	addFunctions(SchemaPlus schema, @Nullable String functionName, List<String> unusedPath, String className, @Nullable String methodName, boolean upCase)	Creates and validates a ScalarFunctionImpl, and adds it to a schema, using the standard class-name filter.
static void	create(SchemaPlus schema, String functionName, List<String> path, String className, String methodName)	Deprecated. Use addFunctions(org.apache.calcite.schema.SchemaPlus, java.lang.String, java.util.List<java.lang.String>, java.lang.String, java.lang.String, boolean).
@Nullable String	defaultSchemaName()
protected Map<String,Object>	operandMap(@Nullable JsonSchema jsonSchema, @Nullable Map<String,Object> operand)	Adds extra entries to an operand to a custom schema.
void	visit(JsonColumn jsonColumn)
void	visit(JsonCustomSchema jsonSchema)
void	visit(JsonCustomTable jsonTable)
void	visit(JsonFunction jsonFunction)
void	visit(JsonJdbcSchema jsonSchema)
void	visit(JsonLattice jsonLattice)
void	visit(JsonMapSchema jsonSchema)
void	visit(JsonMaterialization jsonMaterialization)
void	visit(JsonMeasure jsonMeasure)
void	visit(JsonRoot jsonRoot)
void	visit(JsonTile jsonTile)
void	visit(JsonType jsonType)
void	visit(JsonView jsonView)

Methods inherited from class java.lang.Object

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

Constructor Details

ModelHandler

public ModelHandler(SchemaPlus rootSchema,
 String uri)
             throws IOException

Creates a ModelHandler that uses the standard class-name filter.

Throws:

IOException

ModelHandler

public ModelHandler(SchemaPlus rootSchema,
 String uri,
 org.apache.calcite.model.ClassNameFilter classNameFilter)
             throws IOException

Creates a ModelHandler that validates every class loaded by reflection from the model against classNameFilter. Use this to apply a stricter (or more permissive) filter than the standard one.

Throws:

IOException

ModelHandler

@Deprecated
public ModelHandler(CalciteConnection connection,
 String uri)
             throws IOException

Deprecated.

Throws:

IOException

Method Details

create

@Deprecated
public static void create(SchemaPlus schema,
 String functionName,
 List<String> path,
 String className,
 String methodName)

Deprecated.

Use addFunctions(org.apache.calcite.schema.SchemaPlus, java.lang.String, java.util.List<java.lang.String>, java.lang.String, java.lang.String, boolean).

addFunctions

public static void addFunctions(SchemaPlus schema,
 @Nullable String functionName,
 List<String> unusedPath,
 String className,
 @Nullable String methodName,
 boolean upCase)

Creates and validates a ScalarFunctionImpl, and adds it to a schema, using the standard class-name filter. Kept for backwards compatibility; prefer the filter-taking overload of addFunctions, which lets callers supply their own filter.

If methodName is "*", may add more than one function.

Parameters:

schema - Schema to add to

functionName - Name of function; null to derived from method name

unusedPath - Path to look for functions (currently ignored)

className - Class to inspect for methods that may be user-defined functions

methodName - Method name; null means use the class as a UDF; "*" means add all methods

upCase - Whether to convert method names to upper case, so that they can be called without using quotes

addFunctions

public static void addFunctions(org.apache.calcite.model.ClassNameFilter filter,
 SchemaPlus schema,
 @Nullable String functionName,
 String className,
 @Nullable String methodName,
 boolean upCase)

Creates and validates a ScalarFunctionImpl and adds it to a schema, after asking filter to accept className.

visit

public void visit(JsonRoot jsonRoot)

visit

public void visit(JsonMapSchema jsonSchema)

visit

public void visit(JsonCustomSchema jsonSchema)

operandMap

protected Map<String,Object> operandMap(@Nullable JsonSchema jsonSchema,
 @Nullable Map<String,Object> operand)

Adds extra entries to an operand to a custom schema.

visit

public void visit(JsonJdbcSchema jsonSchema)

visit

public void visit(JsonMaterialization jsonMaterialization)

visit

public void visit(JsonLattice jsonLattice)

visit

public void visit(JsonCustomTable jsonTable)

visit

public void visit(JsonColumn jsonColumn)

visit

public void visit(JsonView jsonView)

defaultSchemaName

public @Nullable String defaultSchemaName()

visit

public void visit(JsonType jsonType)

visit

public void visit(JsonFunction jsonFunction)

visit

public void visit(JsonMeasure jsonMeasure)

visit

public void visit(JsonTile jsonTile)