org.apache.pig

Class FuncSpec

java.lang.Object

org.apache.pig.FuncSpec

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

@InterfaceAudience.Public
@InterfaceStability.Stable
public class FuncSpec
extends java.lang.Object
implements java.io.Serializable, java.lang.Cloneable

Class to represent a UDF specification. Encapsulates the class name and the arguments to the constructor.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
FuncSpec(java.lang.String funcSpec)
FuncSpec(java.lang.String funcSpec, Schema inputArgsSchema)
FuncSpec(java.lang.String className, java.lang.String ctorArg)
FuncSpec(java.lang.String className, java.lang.String[] ctorArgs)
FuncSpec(java.lang.String className, java.lang.String[] ctorArgs, Schema inputArgsSchema)

Method Summary

Methods

Modifier and Type	Method and Description
FuncSpec	clone()
boolean	equals(java.lang.Object other)
static java.lang.String	getArgStringFromSpec(java.lang.String funcSpec) Get the argument values passed to the func spec.
java.lang.String	getClassName()
static java.lang.String	getClassNameFromSpec(java.lang.String funcSpec) Parse the class name out of a function specification string.
java.lang.String[]	getCtorArgs()
Schema	getInputArgsSchema()
int	hashCode()
static java.util.List<java.lang.String>	parseArguments(java.lang.String argString) Parse the argument values out of a function specification string.
void	setClassName(java.lang.String className)
void	setCtorArgs(java.lang.String[] ctorArgs)
void	setInputArgsSchema(Schema inputArgsSchema)
java.lang.String	toString()

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

FuncSpec

public FuncSpec(java.lang.String className,
        java.lang.String ctorArg)

Parameters:

className - the name of the class for the udf

ctorArg - the argument to pass the constructor for the above class. Constructors can only take strings.

FuncSpec

public FuncSpec(java.lang.String className,
        java.lang.String[] ctorArgs)

Parameters:

className - the name of the class for the udf

ctorArgs - the arguments to pass to the constructor for the above class. Constructors can only take strings.

FuncSpec

public FuncSpec(java.lang.String className,
        java.lang.String[] ctorArgs,
        Schema inputArgsSchema)

Parameters:

className - the name of the class for the udf

ctorArgs - the arguments to pass to the constructor for the above class. Constructors can only take strings.

inputArgsSchema - schema for input args taken by this Function

FuncSpec

public FuncSpec(java.lang.String funcSpec)

Parameters:

funcSpec - the name of the function and any arguments. It should have the form: classname('arg1', 'arg2', ...)

FuncSpec

public FuncSpec(java.lang.String funcSpec,
        Schema inputArgsSchema)

Parameters:

funcSpec - funcSpec the name of the function and any arguments. It should have the form: classname('arg1', 'arg2', ...)

inputArgsSchema - schema for input args taken by this Function

Method Detail

getClassNameFromSpec

public static java.lang.String getClassNameFromSpec(java.lang.String funcSpec)

Parse the class name out of a function specification string.

Returns:

name of the class.

getArgStringFromSpec

public static java.lang.String getArgStringFromSpec(java.lang.String funcSpec)

Get the argument values passed to the func spec.

Returns:

argument values. Format will be arg1, arg2, ... )

parseArguments

public static java.util.List<java.lang.String> parseArguments(java.lang.String argString)

Parse the argument values out of a function specification string.

Parameters:

argString - should be of the form "'arg1', 'arg2', ..."

Returns:

List of the different argument strings

getClassName

public java.lang.String getClassName()

Returns:

the className

setClassName

public void setClassName(java.lang.String className)

Parameters:

className - the className to set

getCtorArgs

public java.lang.String[] getCtorArgs()

Returns:

the ctorArgs

setCtorArgs

public void setCtorArgs(java.lang.String[] ctorArgs)

Parameters:

ctorArgs - the ctorArgs to set

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getInputArgsSchema

public Schema getInputArgsSchema()

Returns:

the inputArgsSchema

setInputArgsSchema

public void setInputArgsSchema(Schema inputArgsSchema)

Parameters:

inputArgsSchema - the inputArgsSchema to set

equals

public boolean equals(java.lang.Object other)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

clone

public FuncSpec clone()
               throws java.lang.CloneNotSupportedException

Overrides:

clone in class java.lang.Object

Throws:

java.lang.CloneNotSupportedException