ArrayPositionFunction (Flink : 2.0-SNAPSHOT API)

java.lang.Object
- org.apache.flink.table.functions.UserDefinedFunction
- - org.apache.flink.table.functions.ScalarFunction
  - - org.apache.flink.table.runtime.functions.scalar.BuiltInScalarFunction
    - - org.apache.flink.table.runtime.functions.scalar.ArrayPositionFunction

All Implemented Interfaces:

Serializable, FunctionDefinition
```
@Internal
public class ArrayPositionFunction
extends BuiltInScalarFunction
```
Implementation of BuiltInFunctionDefinitions.ARRAY_POSITION.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor Description

ArrayPositionFunction(SpecializedFunction.SpecializedContext context)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`close()`	Tear-down method for user-defined function.
`Integer`	`eval(ArrayData haystack, Object needle)`
`void`	`open(FunctionContext context)`	Setup method for user-defined function.

Methods inherited from class org.apache.flink.table.runtime.functions.scalar.BuiltInScalarFunction
getArgumentDataTypes, getOutputDataType, getRequirements, getTypeInference, isDeterministic

Methods inherited from class org.apache.flink.table.functions.ScalarFunction
getKind, getParameterTypes, getResultType

Methods inherited from class org.apache.flink.table.functions.UserDefinedFunction
functionIdentifier, toString

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

Methods inherited from interface org.apache.flink.table.functions.FunctionDefinition
supportsConstantFolding

- Constructor Detail
  - ArrayPositionFunction
```
public ArrayPositionFunction(SpecializedFunction.SpecializedContext context)
```
- Method Detail
  - open
```
public void open(FunctionContext context)
          throws Exception
```
    Description copied from class: UserDefinedFunction
    
    Setup method for user-defined function. It can be used for initialization work. By default, this method does nothing.
    
    Overrides:
    
    open in class UserDefinedFunction
    
    Throws:
    
    Exception
  - eval
```
@Nullable
public Integer eval(ArrayData haystack,
                    Object needle)
```
  - close
```
public void close()
           throws Exception
```
    Description copied from class: UserDefinedFunction
    
    Tear-down method for user-defined function. It can be used for clean up work. By default, this method does nothing.
    
    Overrides:
    
    close in class UserDefinedFunction
    
    Throws:
    
    Exception