org.teiid.metadata
Class FunctionParameter

java.lang.Object
  org.teiid.metadata.FunctionParameter

All Implemented Interfaces:

Serializable

public class FunctionParameter
extends Object
implements Serializable

A function parameter defines the name and description of an input or output parameter for a function. The name should not be null, but that is not verified by this class. Validation of this object can be done with the FunctionMetadataValidator. The type string used in the function parameter should be one of the standard type names defined in DataTypeManager.DefaultDataTypes.

See Also:

Serialized Form

Field Summary

static String

OUTPUT_PARAMETER_NAME

Constructor Summary

FunctionParameter()
Construct a function parameter with no attributes.

FunctionParameter(String name, String type)
Construct a function parameter with no description.

FunctionParameter(String name, String type, String description)
Construct a function parameter with all attributes.

FunctionParameter(String name, String type, String description, boolean vararg)

Method Summary

boolean	equals(Object obj) Compare with other object for equality.
String	getDescription() Get description of parameter
String	getName() Return name of parameter.
String	getType() Get type of parameter
int	hashCode() Return hash code for this parameter.
boolean	isVarArg()
void	setDescription(String description) Set description of parameter
void	setName(String name) Set name
void	setType(String type) Set type of parameter
void	setVarArg(boolean isVarArg)
String	toString() Return string version for debugging purposes

Methods inherited from class java.lang.Object

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

Field Detail

OUTPUT_PARAMETER_NAME

public static final String OUTPUT_PARAMETER_NAME

See Also:

Constant Field Values

Constructor Detail

FunctionParameter

public FunctionParameter()

Construct a function parameter with no attributes.

FunctionParameter

public FunctionParameter(String name,
                         String type)

Construct a function parameter with no description.

Parameters:

name - Name

type - Type from standard set of types

FunctionParameter

public FunctionParameter(String name,
                         String type,
                         String description)

Construct a function parameter with all attributes.

Parameters:

name - Name

type - Type from standard set of types

description - Description

FunctionParameter

public FunctionParameter(String name,
                         String type,
                         String description,
                         boolean vararg)

Method Detail

getName

public String getName()

Return name of parameter.

Returns:

Name

setName

public void setName(String name)

Set name

Parameters:

name - Name

getDescription

public String getDescription()

Get description of parameter

Returns:

Description

setDescription

public void setDescription(String description)

Set description of parameter

Parameters:

description - Description

getType

public String getType()

Get type of parameter

Returns:

Type name

See Also:

DataTypeManager.DefaultDataTypes

setType

public void setType(String type)

Set type of parameter

Parameters:

type - Type of parameter

See Also:

DataTypeManager.DefaultDataTypes

hashCode

public int hashCode()

Return hash code for this parameter. The hash code is based only on the type of the parameter. Changing the type of the parameter after placing this object in a hashed collection will likely cause the object to be lost.

Overrides:

hashCode in class Object

Returns:

Hash code

equals

public boolean equals(Object obj)

Compare with other object for equality. Equality is based on whether the type is the same as the other parameter.

Overrides:

equals in class Object

Returns:

True if equal to obj

toString

public String toString()

Return string version for debugging purposes

Overrides:

toString in class Object

Returns:

String representation of function parameter

setVarArg

public void setVarArg(boolean isVarArg)

isVarArg

public boolean isVarArg()