Package com.spotfire.ws.im.ds

Class ProcedureMetadata.Parameter

java.lang.Object

com.spotfire.ws.im.ds.ProcedureMetadata.Parameter

Enclosing class:

ProcedureMetadata

public static final class ProcedureMetadata.Parameter
extends Object

This class implements a representation of metadata for an in-parameter for a stored procedure.

Field Summary

Fields

Modifier and Type	Field	Description
static int	NO_NULLS
static int	NULLABLE
static String	NULLABLE_ATTR
static int	NULLABLE_UNKNOWN
static String	PARAMETER_DATA_TYPE_ATTR
static String	TYPE_ATTR

Constructor Summary

Constructors

Constructor	Description
Parameter(String name, String type, String description, String dataType, int nullable)	Creates a new metadata representation for a stored procedure parameter.

Method Summary

Modifier and Type	Method	Description
String	getDataType()	Returns data type.
String	getDescription()	Returns parameter description.
String	getName()	Returns parameter name.
int	getNullable()	Returns one of the following values: NULLABLE, NO_NULLS or NULLABLE_UNKNOWN.
String	getNullableString()	Returns nullable value as string.
String	getType()	Returns parameter type.

Methods inherited from class java.lang.Object

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

Field Detail

NULLABLE

public static final int NULLABLE

See Also:

Constant Field Values

NO_NULLS

public static final int NO_NULLS

See Also:

Constant Field Values

NULLABLE_UNKNOWN

public static final int NULLABLE_UNKNOWN

See Also:

Constant Field Values

TYPE_ATTR

public static final String TYPE_ATTR

See Also:

Constant Field Values

PARAMETER_DATA_TYPE_ATTR

public static final String PARAMETER_DATA_TYPE_ATTR

See Also:

Constant Field Values

NULLABLE_ATTR

public static final String NULLABLE_ATTR

See Also:

Constant Field Values

Constructor Detail

Parameter

public Parameter(String name,
                 String type,
                 String description,
                 String dataType,
                 int nullable)

Creates a new metadata representation for a stored procedure parameter.

Parameters:

name - The name of the parameter

type - The parameter type;

description - Description text. May be null.

dataType - Data type.

nullable - NULLABLE, NO_NULLS or NULLABLE_UNKNOWN.

Method Detail

getName

public String getName()

Returns parameter name.

Returns:

the name

getType

public String getType()

Returns parameter type.

Returns:

the type

getDataType

public String getDataType()

Returns data type.

Returns:

the data type

getDescription

public String getDescription()

Returns parameter description.

Returns:

the description

getNullable

public int getNullable()

Returns one of the following values: NULLABLE, NO_NULLS or NULLABLE_UNKNOWN.

Returns:

the nullable value

getNullableString

public String getNullableString()

Returns nullable value as string.

Returns:

the nullable string