com.hardcode.gdbms.engine.data.metadata
Interface DriverMetadata

All Known Subinterfaces:

SpatialDriverMetadata

All Known Implementing Classes:

DefaultDriverMetadata, DefaultSpatialDriverMetadata, JDBCSupport.Spatial2AlphaMetadata, MetadataEditionSupport.ModifiedDriverMetadata, MetadataEditionSupport.SpatialModifiedDriverMetadata

public interface DriverMetadata

Defines the schema of a source in driver specific terms

Author:

Fernando González Cortés

Method Summary

int	getFieldCount() Gets the number of fields
java.lang.String	getFieldName(int fieldId) Gets the name of the field.
java.lang.String	getFieldParam(int fieldId, java.lang.String paramName)
java.util.HashMap<java.lang.String,java.lang.String>	getFieldParams(int fieldId) Gets the parameters for the specified field
java.lang.String	getFieldType(int fieldId) Gets the name of the field type.
java.lang.String[]	getParamNames(int fieldId) Gets the param names for the specified field
java.lang.String[]	getParamValues(int fieldId) Gets the param values for the specified field
java.lang.String[]	getPrimaryKeys() Gets the names of the fields which are primary key.

Method Detail

getFieldCount

int getFieldCount()
                  throws DriverException

Gets the number of fields

Returns:

Throws:

DriverException

getFieldName

java.lang.String getFieldName(int fieldId)
                              throws DriverException

Gets the name of the field.

Parameters:

fieldId -

Returns:

Throws:

DriverException

getFieldType

java.lang.String getFieldType(int fieldId)
                              throws DriverException

Gets the name of the field type. It should be one of the values returned by the getAvailableTypes method in the driver

Returns:

Throws:

DriverException

getFieldParam

java.lang.String getFieldParam(int fieldId,
                               java.lang.String paramName)
                               throws DriverException

Returns:

Throws:

DriverException

getParamNames

java.lang.String[] getParamNames(int fieldId)
                                 throws DriverException

Gets the param names for the specified field

Parameters:

fieldId -

Returns:

Throws:

DriverException

getParamValues

java.lang.String[] getParamValues(int fieldId)
                                  throws DriverException

Gets the param values for the specified field

Parameters:

fieldId -

Returns:

Throws:

DriverException

getFieldParams

java.util.HashMap<java.lang.String,java.lang.String> getFieldParams(int fieldId)
                                                                    throws DriverException

Gets the parameters for the specified field

Returns:

Throws:

DriverException

getPrimaryKeys

java.lang.String[] getPrimaryKeys()
                                  throws DriverException

Gets the names of the fields which are primary key. An array of zero elements if there isn't any primary key

Returns:

Throws:

DriverException