org.geotools.data.jdbc.fidmapper
Class TypedFIDMapper

Object
  AbstractFIDMapper
      TypedFIDMapper

All Implemented Interfaces:

Serializable, FIDMapper

public class TypedFIDMapper
extends AbstractFIDMapper

This fidmapper just takes another fid mapper and builds fids based on the wrapped FIDMapper by prefixing them with the feature type name, that is, the resulting fid follow the <featureTypeName>.<basic_fid> pattern.

Author:

wolf

See Also:

Serialized Form

Module:

modules/library/jdbc (gt2-jdbc.jar) (Maven report) (SVN head)

Field Summary

Fields inherited from class AbstractFIDMapper

autoIncrement, colDecimalDigits, colNames, colSizes, colTypes, returnFIDColumnsAsAttributes, tableName, tableSchemaName

Constructor Summary

TypedFIDMapper(FIDMapper wrapped, String featureTypeName)
Creates a new TypedFIDMapper object.

Method Summary

String	createID(Connection conn, Feature feature, Statement statement) Creates a new ID for a feature.
boolean	equals(Object object)
int	getColumnCount() Returns the number of columns in the primary keys handled by this mapper
int	getColumnDecimalDigits(int colIndex) Provides the number of decimal digits for this column.
String	getColumnName(int colIndex) Returns the name of the specified column in the primary key
int	getColumnSize(int colIndex) Returns the size of a primary key column as it would be provided by the database metadata.
int	getColumnType(int colIndex) Returns the column type by using a constant available in the java.sql.Types interface
String	getID(Object[] attributes) Returns the FID given the values of the prymary key attributes
Object[]	getPKAttributes(String FID) Creates the value for the PK attributes given the feature.
String	getTableName()
String	getTableSchemaName()
FIDMapper	getWrappedMapper() Returns the base mapper wrapped by this TypedFIDMapper
void	initSupportStructures() This method will be called by JDBCDataStore when creating new tables to give the FID mapper an opportunity to initialize needed data structures, such as support tables, sequences, and so on.
boolean	isAutoIncrement(int colIndex) Returns true if the column is of serial type, that is, its value is automatically generated by the database if the user does not provide one
boolean	isVolatile() Convenience since most FID mappers should be persistent, override on the specific ones that aren't.
boolean	returnFIDColumnsAsAttributes() If true the primary key columns will be returned as attributes.
String	toString() Create a nice string representation of a FID Mapper

Methods inherited from class AbstractFIDMapper

getColumnDecimalDigits, getColumnName, getColumnSize, getColumnType, hasAutoIncrementColumns, isAutoIncrement, setInfo

Methods inherited from class Object

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

Constructor Detail

TypedFIDMapper

public TypedFIDMapper(FIDMapper wrapped,
                      String featureTypeName)

Creates a new TypedFIDMapper object.

Parameters:

wrapped -

featureTypeName -

Throws:

IllegalArgumentException - DOCUMENT ME!

Method Detail

getID

public String getID(Object[] attributes)

Description copied from interface: FIDMapper

Returns the FID given the values of the prymary key attributes

Parameters:

attributes - DOCUMENT ME!

See Also:

FIDMapper.getID(java.lang.Object[])

getPKAttributes

public Object[] getPKAttributes(String FID)
                         throws IOException

Description copied from interface: FIDMapper

Creates the value for the PK attributes given the feature. If the FID is null, will throw an IOException if not possible. If null is returned, no primary key value needs to be specified, which is what we want for auto-increment fields.

Parameters:

FID - The feature ID is going to be parsed

Throws:

IOException

See Also:

FIDMapper.getPKAttributes(java.lang.String)

returnFIDColumnsAsAttributes

public boolean returnFIDColumnsAsAttributes()

Description copied from interface: FIDMapper

If true the primary key columns will be returned as attributes. This is fundamental for primary key with businnes meaning.

Specified by:

returnFIDColumnsAsAttributes in interface FIDMapper

Overrides:

returnFIDColumnsAsAttributes in class AbstractFIDMapper

See Also:

FIDMapper.returnFIDColumnsAsAttributes()

getColumnCount

public int getColumnCount()

Description copied from interface: FIDMapper

Returns the number of columns in the primary keys handled by this mapper

Specified by:

getColumnCount in interface FIDMapper

Overrides:

getColumnCount in class AbstractFIDMapper

See Also:

FIDMapper.getColumnCount()

getColumnName

public String getColumnName(int colIndex)

Description copied from interface: FIDMapper

Returns the name of the specified column in the primary key

Specified by:

getColumnName in interface FIDMapper

Overrides:

getColumnName in class AbstractFIDMapper

See Also:

FIDMapper.getColumnName(int)

getColumnType

public int getColumnType(int colIndex)

Description copied from interface: FIDMapper

Returns the column type by using a constant available in the java.sql.Types interface

Specified by:

getColumnType in interface FIDMapper

Overrides:

getColumnType in class AbstractFIDMapper

See Also:

FIDMapper.getColumnType(int)

getColumnSize

public int getColumnSize(int colIndex)

Description copied from interface: FIDMapper

Returns the size of a primary key column as it would be provided by the database metadata. Some fields requires a size specification, such as VARCHAR or NUMBER, whilst other don't have or don't need it (for example, an INTEGER or a TEXT field).

Specified by:

getColumnSize in interface FIDMapper

Overrides:

getColumnSize in class AbstractFIDMapper

See Also:

FIDMapper.getColumnSize(int)

getColumnDecimalDigits

public int getColumnDecimalDigits(int colIndex)

Description copied from interface: FIDMapper

Provides the number of decimal digits for this column. This is relevant in particular when the column is a scaled integer such as a NUMBER column

Specified by:

getColumnDecimalDigits in interface FIDMapper

Overrides:

getColumnDecimalDigits in class AbstractFIDMapper

See Also:

FIDMapper.getColumnDecimalDigits(int)

isAutoIncrement

public boolean isAutoIncrement(int colIndex)

Description copied from interface: FIDMapper

Returns true if the column is of serial type, that is, its value is automatically generated by the database if the user does not provide one

Specified by:

isAutoIncrement in interface FIDMapper

Overrides:

isAutoIncrement in class AbstractFIDMapper

See Also:

FIDMapper.isAutoIncrement(int)

equals

public boolean equals(Object object)

Overrides:

equals in class Object

See Also:

Object.equals(java.lang.Object)

createID

public String createID(Connection conn,
                       Feature feature,
                       Statement statement)
                throws IOException

Description copied from interface: FIDMapper

Creates a new ID for a feature.
This is done either by querying the database (for auto-increment like types, for example sequences) or by inspecting the Feature (for example, for primary keys with business meaning that whose attributes are included in the Feature ones).

Parameters:

conn - - the database connection

feature - - the feature that needs the new FID

statement - - the statement used to insert the feature into the database

Throws:

IOException

See Also:

FIDMapper.createID(java.sql.Connection, org.geotools.feature.Feature, Statement)

initSupportStructures

public void initSupportStructures()

Description copied from interface: FIDMapper

This method will be called by JDBCDataStore when creating new tables to give the FID mapper an opportunity to initialize needed data structures, such as support tables, sequences, and so on.

Specified by:

initSupportStructures in interface FIDMapper

Overrides:

initSupportStructures in class AbstractFIDMapper

See Also:

FIDMapper.initSupportStructures()

getWrappedMapper

public FIDMapper getWrappedMapper()

Returns the base mapper wrapped by this TypedFIDMapper

toString

public String toString()

Description copied from class: AbstractFIDMapper

Create a nice string representation of a FID Mapper

Overrides:

toString in class AbstractFIDMapper

Returns:

the String representation

getTableName

public String getTableName()

Overrides:

getTableName in class AbstractFIDMapper

getTableSchemaName

public String getTableSchemaName()

Overrides:

getTableSchemaName in class AbstractFIDMapper

isVolatile

public boolean isVolatile()

Description copied from class: AbstractFIDMapper

Convenience since most FID mappers should be persistent, override on the specific ones that aren't.

Specified by:

isVolatile in interface FIDMapper

Overrides:

isVolatile in class AbstractFIDMapper

See Also:

FIDMapper.isVolatile()