Package com.spotfire.ws.im.ds.sql

Interface JDBCMetadataProvider

All Known Implementing Classes:

BasicJDBCMetadataProvider

public interface JDBCMetadataProvider

This interface should be used when full control over the handling of data source metadata is required. An implementation of this class can be specified in a data source template.

Since:

3.0

See Also:

• JDBCContext
• JDBCTypeSettings
• BasicJDBCMetadataProvider

Method Summary

Modifier and Type	Method	Description
MetadataItem[]	getMetadata(MetadataItem[] path)	Returns a list of MetadataItem objects that corresponds to the given path.
void	setContext(JDBCContext c)	Sets the JDBCContext.
Class	toJavaType(int jdbcType, String typeName, int precision, int scale)	Converts a JDBC type to a Java type.
int	toJDBCType(Class type)	Converts a Java type to a JDBC type.

Method Details

getMetadata

MetadataItem[] getMetadata(MetadataItem[] path)
                    throws InvalidMetadataPath,
SQLException

Returns a list of MetadataItem objects that corresponds to the given path.

Parameters:

path - a path of MetadataItem objects.

Returns:

a list of MetadataItem objects.

Throws:

InvalidMetadataPath - if the given path is invalid

SQLException - if a database error occurs

Since:

3.0

toJavaType

Class toJavaType(int jdbcType,
 String typeName,
 int precision,
 int scale)

Converts a JDBC type to a Java type.

The following Java types are supported:

• String
• Integer
• Long
• Float
• Double
• com.spotfire.ws.dat.Date
• com.spotfire.ws.dat.Time
• com.spotfire.ws.dat.DateTime
• com.spotfire.ws.dat.Clob
• com.spotfire.ws.dat.Blob

Parameters:

jdbcType - a JDBC type

typeName - data source dependent type name

precision - a precision used for numeric types

scale - a scale used for numeric types

Returns:

a Java type

Since:

3.0

See Also:

• Types

toJDBCType

int toJDBCType(Class type)

Converts a Java type to a JDBC type.

The following Java types must be supported:

• String
• Integer
• Long
• Float
• Double
• com.spotfire.ws.dat.Date
• com.spotfire.ws.dat.Time
• com.spotfire.ws.dat.DateTime
• com.spotfire.ws.dat.Clob
• com.spotfire.ws.dat.Blob

Parameters:

type - a Java type

Returns:

a JDBC type

Since:

3.0

See Also:

• Types

setContext

void setContext(JDBCContext c)

Sets the JDBCContext.

Parameters:

c - JDBCContext

Since:

3.0