Impala
Impalaistheopensource,nativeanalyticdatabaseforApacheHadoop.
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros
Classes | Public Member Functions | Static Public Member Functions | Private Member Functions | Private Attributes | List of all members
com.cloudera.impala.catalog.Function Class Reference
Inheritance diagram for com.cloudera.impala.catalog.Function:
Collaboration diagram for com.cloudera.impala.catalog.Function:

Classes

enum  CompareMode
 

Public Member Functions

 Function (FunctionName name, Type[] argTypes, Type retType, boolean varArgs)
 
 Function (FunctionName name, List< Type > args, Type retType, boolean varArgs)
 
FunctionName getFunctionName ()
 
String functionName ()
 
String dbName ()
 
Type getReturnType ()
 
Type[] getArgs ()
 
int getNumArgs ()
 
HdfsUri getLocation ()
 
TFunctionBinaryType getBinaryType ()
 
boolean hasVarArgs ()
 
boolean userVisible ()
 
Type getVarArgsType ()
 
void setName (FunctionName name)
 
void setLocation (HdfsUri loc)
 
void setBinaryType (TFunctionBinaryType type)
 
void setHasVarArgs (boolean v)
 
void setUserVisible (boolean b)
 
String signatureString ()
 
boolean equals (Object o)
 
boolean compare (Function other, CompareMode mode)
 
Function promoteCharsToStrings ()
 
Function selectClosestSuperType (List< Function > candidates)
 
TCatalogObjectType getCatalogObjectType ()
 
long getCatalogVersion ()
 
void setCatalogVersion (long newVersion)
 
String getName ()
 
TFunction toThrift ()
 
boolean isLoaded ()
 
String lookupSymbol (String symbol, TSymbolType symbolType, Type retArgType, boolean hasVarArgs, Type...argTypes) throws AnalysisException
 
String lookupSymbol (String symbol, TSymbolType symbolType) throws AnalysisException
 

Static Public Member Functions

static Function fromThrift (TFunction fn)
 
static String getUdfType (Type t)
 

Private Member Functions

boolean isSuperTypeOf (Function other)
 
boolean isIdentical (Function o)
 
boolean isIndistinguishable (Function o)
 

Private Attributes

FunctionName name_
 
final Type retType_
 
Type[] argTypes_
 
boolean hasVarArgs_
 
boolean userVisible_
 
HdfsUri location_
 
TFunctionBinaryType binaryType_
 
long catalogVersion_ = Catalog.INITIAL_CATALOG_VERSION
 

Detailed Description

Base class for all functions.

Definition at line 41 of file Function.java.

Constructor & Destructor Documentation

com.cloudera.impala.catalog.Function.Function ( FunctionName  name,
Type[]  argTypes,
Type  retType,
boolean  varArgs 
)
inline

Definition at line 92 of file Function.java.

References com.cloudera.impala.catalog.Function.argTypes_, and impala.name.

Referenced by com.cloudera.impala.catalog.Function.fromThrift(), and com.cloudera.impala.catalog.Function.promoteCharsToStrings().

com.cloudera.impala.catalog.Function.Function ( FunctionName  name,
List< Type >  args,
Type  retType,
boolean  varArgs 
)
inline

Definition at line 105 of file Function.java.

References com.cloudera.impala.catalog.Function.argTypes_, and impala.name.

Member Function Documentation

boolean com.cloudera.impala.catalog.Function.compare ( Function  other,
CompareMode  mode 
)
inline

Definition at line 157 of file Function.java.

References com.cloudera.impala.catalog.Function.isIdentical(), com.cloudera.impala.catalog.Function.isIndistinguishable(), and com.cloudera.impala.catalog.Function.isSuperTypeOf().

Referenced by com.cloudera.impala.catalog.Function.equals().

String com.cloudera.impala.catalog.Function.dbName ( )
inline

Definition at line 117 of file Function.java.

Referenced by com.cloudera.impala.catalog.Catalog.addFunction(), com.cloudera.impala.service.MetadataOp.createFunctionResultRow(), com.cloudera.impala.catalog.Catalog.getFunction(), and com.cloudera.impala.catalog.Catalog.removeFunction().

boolean com.cloudera.impala.catalog.Function.equals ( Object  o)
inline

Definition at line 151 of file Function.java.

References com.cloudera.impala.catalog.Function.compare(), and com.cloudera.impala.catalog.Function.CompareMode.IS_IDENTICAL.

static Function com.cloudera.impala.catalog.Function.fromThrift ( TFunction  fn)
inlinestatic

Definition at line 308 of file Function.java.

References com.cloudera.impala.analysis.FunctionName.fromThrift(), com.cloudera.impala.catalog.Type.fromThrift(), and com.cloudera.impala.catalog.Function.Function().

String com.cloudera.impala.catalog.Function.functionName ( )
inline

Definition at line 116 of file Function.java.

Referenced by com.cloudera.impala.service.MetadataOp.createFunctionResultRow(), and com.cloudera.impala.catalog.Db.removeFunction().

Type [] com.cloudera.impala.catalog.Function.getArgs ( )
inline

Definition at line 119 of file Function.java.

References com.cloudera.impala.catalog.Function.argTypes_.

Referenced by com.cloudera.impala.catalog.ScalarFunction.createBuiltin().

TFunctionBinaryType com.cloudera.impala.catalog.Function.getBinaryType ( )
inline

Definition at line 123 of file Function.java.

References com.cloudera.impala.catalog.Function.binaryType_.

Referenced by com.cloudera.impala.analysis.FunctionCallExpr.analyze().

TCatalogObjectType com.cloudera.impala.catalog.Function.getCatalogObjectType ( )
inline

Implements com.cloudera.impala.catalog.CatalogObject.

Definition at line 283 of file Function.java.

long com.cloudera.impala.catalog.Function.getCatalogVersion ( )
inline

Implements com.cloudera.impala.catalog.CatalogObject.

Definition at line 286 of file Function.java.

References com.cloudera.impala.catalog.Function.catalogVersion_.

Referenced by com.cloudera.impala.catalog.ImpaladCatalog.addFunction(), and com.cloudera.impala.catalog.ImpaladCatalog.removeFunction().

FunctionName com.cloudera.impala.catalog.Function.getFunctionName ( )
inline

Definition at line 115 of file Function.java.

References com.cloudera.impala.catalog.Function.name_.

Referenced by com.cloudera.impala.catalog.CatalogServiceCatalog.addFunction(), and com.cloudera.impala.catalog.Function.getName().

HdfsUri com.cloudera.impala.catalog.Function.getLocation ( )
inline

Definition at line 122 of file Function.java.

References com.cloudera.impala.catalog.Function.location_.

String com.cloudera.impala.catalog.Function.getName ( )
inline

Implements com.cloudera.impala.catalog.CatalogObject.

Definition at line 292 of file Function.java.

References com.cloudera.impala.catalog.Function.getFunctionName().

int com.cloudera.impala.catalog.Function.getNumArgs ( )
inline

Definition at line 121 of file Function.java.

Referenced by com.cloudera.impala.analysis.CreateUdaStmt.analyze(), com.cloudera.impala.catalog.Function.isIndistinguishable(), and com.cloudera.impala.analysis.Expr.treeToThriftHelper().

Type com.cloudera.impala.catalog.Function.getReturnType ( )
inline

Definition at line 118 of file Function.java.

References com.cloudera.impala.catalog.Function.retType_.

Referenced by com.cloudera.impala.analysis.CreateUdaStmt.analyze(), com.cloudera.impala.catalog.AggregateFunction.toThrift(), and com.cloudera.impala.catalog.Function.toThrift().

static String com.cloudera.impala.catalog.Function.getUdfType ( Type  t)
inlinestatic

Definition at line 401 of file Function.java.

References com.cloudera.impala.catalog.Type.getPrimitiveType().

Type com.cloudera.impala.catalog.Function.getVarArgsType ( )
inline

Definition at line 126 of file Function.java.

References com.cloudera.impala.catalog.Function.argTypes_, com.cloudera.impala.catalog.Function.hasVarArgs_, and com.cloudera.impala.catalog.Type.INVALID.

Referenced by com.cloudera.impala.catalog.Function.isIndistinguishable().

boolean com.cloudera.impala.catalog.Function.hasVarArgs ( )
inline

Definition at line 124 of file Function.java.

References com.cloudera.impala.catalog.Function.hasVarArgs_.

Referenced by com.cloudera.impala.analysis.CreateUdaStmt.analyze(), com.cloudera.impala.catalog.Function.lookupSymbol(), and com.cloudera.impala.analysis.Expr.treeToThriftHelper().

boolean com.cloudera.impala.catalog.Function.isIdentical ( Function  o)
inlineprivate

Definition at line 226 of file Function.java.

References com.cloudera.impala.catalog.Function.argTypes_, com.cloudera.impala.analysis.FunctionName.equals(), com.cloudera.impala.catalog.Function.hasVarArgs_, com.cloudera.impala.catalog.Type.matchesType(), and com.cloudera.impala.catalog.Function.name_.

Referenced by com.cloudera.impala.catalog.Function.compare().

boolean com.cloudera.impala.catalog.Function.isIndistinguishable ( Function  o)
inlineprivate

Definition at line 236 of file Function.java.

References com.cloudera.impala.catalog.Function.argTypes_, com.cloudera.impala.analysis.FunctionName.equals(), com.cloudera.impala.catalog.Function.getNumArgs(), com.cloudera.impala.catalog.Function.getVarArgsType(), com.cloudera.impala.catalog.Function.hasVarArgs_, com.cloudera.impala.catalog.Type.isNull(), com.cloudera.impala.catalog.Type.matchesType(), and com.cloudera.impala.catalog.Function.name_.

Referenced by com.cloudera.impala.catalog.Function.compare(), and com.cloudera.impala.catalog.Function.selectClosestSuperType().

boolean com.cloudera.impala.catalog.Function.isLoaded ( )
inline

Implements com.cloudera.impala.catalog.CatalogObject.

Definition at line 342 of file Function.java.

boolean com.cloudera.impala.catalog.Function.isSuperTypeOf ( Function  other)
inlineprivate

Returns true if 'this' is a supertype of 'other'. Each argument in other must be implicitly castable to the matching argument in this. TODO: look into how we resolve implicitly castable functions. Is there a rule for "most" compatible or maybe return an error if it is ambiguous?

Definition at line 173 of file Function.java.

References com.cloudera.impala.catalog.Function.argTypes_, com.cloudera.impala.analysis.FunctionName.equals(), com.cloudera.impala.catalog.Function.hasVarArgs_, com.cloudera.impala.catalog.Type.isImplicitlyCastable(), com.cloudera.impala.catalog.Type.matchesType(), and com.cloudera.impala.catalog.Function.name_.

Referenced by com.cloudera.impala.catalog.Function.compare().

String com.cloudera.impala.catalog.Function.lookupSymbol ( String  symbol,
TSymbolType  symbolType,
Type  retArgType,
boolean  hasVarArgs,
Type...  argTypes 
) throws AnalysisException
inline

Definition at line 348 of file Function.java.

References com.cloudera.impala.catalog.Function.binaryType_, com.cloudera.impala.analysis.HdfsUri.getLocation(), com.cloudera.impala.catalog.Function.hasVarArgs(), and com.cloudera.impala.catalog.Function.location_.

Referenced by com.cloudera.impala.catalog.Function.lookupSymbol().

String com.cloudera.impala.catalog.Function.lookupSymbol ( String  symbol,
TSymbolType  symbolType 
) throws AnalysisException
inline

Definition at line 394 of file Function.java.

References com.cloudera.impala.catalog.Function.lookupSymbol().

Function com.cloudera.impala.catalog.Function.promoteCharsToStrings ( )
inline

Converts any CHAR arguments to be STRING arguments

Definition at line 200 of file Function.java.

References com.cloudera.impala.catalog.PrimitiveType.CHAR, com.cloudera.impala.catalog.Function.Function(), com.cloudera.impala.catalog.Function.hasVarArgs_, com.cloudera.impala.catalog.Function.name_, com.cloudera.impala.catalog.Function.retType_, and com.cloudera.impala.catalog.Type.STRING.

Referenced by com.cloudera.impala.catalog.Function.selectClosestSuperType().

Function com.cloudera.impala.catalog.Function.selectClosestSuperType ( List< Function >  candidates)
inline

Given a list of functions which are a super type of this function, select the best match. This is the one which requires the fewest type promotions.

Definition at line 212 of file Function.java.

References com.cloudera.impala.catalog.Function.isIndistinguishable(), and com.cloudera.impala.catalog.Function.promoteCharsToStrings().

void com.cloudera.impala.catalog.Function.setBinaryType ( TFunctionBinaryType  type)
inline

Definition at line 134 of file Function.java.

References com.cloudera.impala.catalog.Function.binaryType_.

void com.cloudera.impala.catalog.Function.setCatalogVersion ( long  newVersion)
inline

Implements com.cloudera.impala.catalog.CatalogObject.

Definition at line 289 of file Function.java.

References com.cloudera.impala.catalog.Function.catalogVersion_.

void com.cloudera.impala.catalog.Function.setHasVarArgs ( boolean  v)
inline

Definition at line 135 of file Function.java.

References com.cloudera.impala.catalog.Function.hasVarArgs_.

void com.cloudera.impala.catalog.Function.setLocation ( HdfsUri  loc)
inline

Definition at line 133 of file Function.java.

References com.cloudera.impala.catalog.Function.location_.

Referenced by com.cloudera.impala.catalog.AggregateFunction.AggregateFunction(), and com.cloudera.impala.catalog.ScalarFunction.ScalarFunction().

void com.cloudera.impala.catalog.Function.setName ( FunctionName  name)
inline

Definition at line 132 of file Function.java.

References impala.name, and com.cloudera.impala.catalog.Function.name_.

void com.cloudera.impala.catalog.Function.setUserVisible ( boolean  b)
inline

Definition at line 136 of file Function.java.

References com.cloudera.impala.catalog.Function.userVisible_.

String com.cloudera.impala.catalog.Function.signatureString ( )
inline

Definition at line 140 of file Function.java.

References com.cloudera.impala.catalog.Function.argTypes_, and com.cloudera.impala.catalog.Function.hasVarArgs_.

Referenced by com.cloudera.impala.analysis.CreateFunctionStmtBase.analyze(), com.cloudera.impala.service.MetadataOp.createFunctionResultRow(), com.cloudera.impala.service.CatalogOpExecutor.dropFunction(), com.cloudera.impala.service.Frontend.getFunctions(), and com.cloudera.impala.catalog.Function.toThrift().

TFunction com.cloudera.impala.catalog.Function.toThrift ( )
inline

Definition at line 294 of file Function.java.

References com.cloudera.impala.catalog.Function.argTypes_, com.cloudera.impala.catalog.Function.binaryType_, com.cloudera.impala.catalog.Function.getReturnType(), com.cloudera.impala.catalog.Function.hasVarArgs_, com.cloudera.impala.catalog.Function.location_, and com.cloudera.impala.catalog.Function.signatureString().

Referenced by com.cloudera.impala.analysis.CreateFunctionStmtBase.toThrift().

boolean com.cloudera.impala.catalog.Function.userVisible ( )
inline

Definition at line 125 of file Function.java.

References com.cloudera.impala.catalog.Function.userVisible_.

Referenced by com.cloudera.impala.analysis.FunctionCallExpr.analyze(), and com.cloudera.impala.catalog.ScalarFunction.createBuiltin().

Member Data Documentation

Type [] com.cloudera.impala.catalog.Function.argTypes_
private

Definition at line 75 of file Function.java.

Referenced by com.cloudera.impala.catalog.Function.Function(), com.cloudera.impala.catalog.Function.getArgs(), com.cloudera.impala.catalog.Function.getVarArgsType(), com.cloudera.impala.catalog.Function.isIdentical(), com.cloudera.impala.catalog.Function.isIndistinguishable(), com.cloudera.impala.catalog.Function.isSuperTypeOf(), com.cloudera.impala.catalog.Function.signatureString(), and com.cloudera.impala.catalog.Function.toThrift().

TFunctionBinaryType com.cloudera.impala.catalog.Function.binaryType_
private

Definition at line 89 of file Function.java.

Referenced by com.cloudera.impala.catalog.Function.getBinaryType(), com.cloudera.impala.catalog.Function.lookupSymbol(), com.cloudera.impala.catalog.Function.setBinaryType(), and com.cloudera.impala.catalog.Function.toThrift().

long com.cloudera.impala.catalog.Function.catalogVersion_ = Catalog.INITIAL_CATALOG_VERSION
private

Definition at line 90 of file Function.java.

Referenced by com.cloudera.impala.catalog.Function.getCatalogVersion(), and com.cloudera.impala.catalog.Function.setCatalogVersion().

boolean com.cloudera.impala.catalog.Function.hasVarArgs_
private

Definition at line 79 of file Function.java.

Referenced by com.cloudera.impala.catalog.Function.getVarArgsType(), com.cloudera.impala.catalog.Function.hasVarArgs(), com.cloudera.impala.catalog.Function.isIdentical(), com.cloudera.impala.catalog.Function.isIndistinguishable(), com.cloudera.impala.catalog.Function.isSuperTypeOf(), com.cloudera.impala.catalog.Function.promoteCharsToStrings(), com.cloudera.impala.catalog.Function.setHasVarArgs(), com.cloudera.impala.catalog.Function.signatureString(), and com.cloudera.impala.catalog.Function.toThrift().

HdfsUri com.cloudera.impala.catalog.Function.location_
private

Definition at line 88 of file Function.java.

Referenced by com.cloudera.impala.catalog.Function.getLocation(), com.cloudera.impala.catalog.Function.lookupSymbol(), com.cloudera.impala.catalog.Function.setLocation(), and com.cloudera.impala.catalog.Function.toThrift().

FunctionName com.cloudera.impala.catalog.Function.name_
private

Definition at line 71 of file Function.java.

Referenced by com.cloudera.impala.catalog.Function.getFunctionName(), com.cloudera.impala.catalog.Function.isIdentical(), com.cloudera.impala.catalog.Function.isIndistinguishable(), com.cloudera.impala.catalog.Function.isSuperTypeOf(), com.cloudera.impala.catalog.Function.promoteCharsToStrings(), and com.cloudera.impala.catalog.Function.setName().

final Type com.cloudera.impala.catalog.Function.retType_
private

Definition at line 73 of file Function.java.

Referenced by com.cloudera.impala.catalog.Function.getReturnType(), and com.cloudera.impala.catalog.Function.promoteCharsToStrings().

boolean com.cloudera.impala.catalog.Function.userVisible_
private

Definition at line 84 of file Function.java.

Referenced by com.cloudera.impala.catalog.Function.setUserVisible(), and com.cloudera.impala.catalog.Function.userVisible().

The documentation for this class was generated from the following file: