com.exalead.papi.connectors.jdbc

Class ColumnMapping

java.lang.Object

com.exalead.papi.connectors.jdbc.ColumnMapping

All Implemented Interfaces:

java.lang.Cloneable

public class ColumnMapping
extends java.lang.Object
implements java.lang.Cloneable

Field Summary

Fields

Modifier and Type	Field and Description
protected int	columnIndex the index of a column matching columnName in a given result set
protected java.lang.String	columnName same as ColumnMappingConfig.columnName
protected ColumnProcessor[]	columnProcessor the columnProcessor associated with this mapping
protected java.lang.String[]	columnProcessorName same as ColumnMappingConfig.columnProcessorName
protected ColumnProcessorParameter[][]	columnProcessorParameters the parameters of the columnProcessor
protected int	columnType the type of a column matching columnName in a given result set
protected boolean	includeInDocumentURI same as ColumnMappingConfig.includeInDocumentURI
static int	INVALID_SQL_TYPE default SQL type when this mapping is unresolved
protected java.lang.String	mappingName same as ColumnMappingConfig.mappingName

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ColumnMapping(DatabaseColumnMappingConfig config) builds a new mapping according to the given configuration
	ColumnMapping(DatabaseColumnMappingConfig config, java.sql.ResultSetMetaData metaData, DatabaseConnector connector) builds a new mapping according to the given configuration, resolve index and type from metaData and loads the columnProcessor.

Method Summary

Modifier and Type	Method and Description
void	checkState() this function checks that the current state of the mapping is sensible: if it is used a a key, a mappingName should be supplied.
int	getColumnIndex()
java.lang.String	getColumnName()
ColumnProcessor[]	getColumnProcessor()
java.lang.String[]	getColumnProcessorName()
ColumnProcessorParameter[][]	getColumnProcessorParameters()
int	getColumnType()
java.lang.String	getMappingName()
boolean	isIncludedInDocumentURI()
void	loadColumnProcessor() loads the columnProcessor associated with this mapping.
void	resolveMetaData(java.sql.ResultSetMetaData metaData) finds in the given metaData an index and a type matching the column name of this mapping
void	setColumnName(java.lang.String columnName)
void	setColumnProcessor(ColumnProcessor[] columnProcessor)
void	setColumnProcessorName(java.lang.String[] columnProcessorName)
void	setColumnProcessorParameters(ColumnProcessorParameter[][] columnProcessorParameters)
void	setIncludeInDocumentURI(java.lang.String includeInDocumentURI)
void	setMappingName(java.lang.String mappingName)

Methods inherited from class java.lang.Object

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

Field Detail

INVALID_SQL_TYPE

public static final int INVALID_SQL_TYPE

default SQL type when this mapping is unresolved

See Also:

Constant Field Values

columnName

protected java.lang.String columnName

same as ColumnMappingConfig.columnName

mappingName

protected java.lang.String mappingName

same as ColumnMappingConfig.mappingName

includeInDocumentURI

protected boolean includeInDocumentURI

same as ColumnMappingConfig.includeInDocumentURI

columnIndex

protected int columnIndex

the index of a column matching columnName in a given result set

columnType

protected int columnType

the type of a column matching columnName in a given result set

columnProcessor

protected ColumnProcessor[] columnProcessor

the columnProcessor associated with this mapping

columnProcessorName

protected java.lang.String[] columnProcessorName

same as ColumnMappingConfig.columnProcessorName

columnProcessorParameters

protected ColumnProcessorParameter[][] columnProcessorParameters

the parameters of the columnProcessor

Constructor Detail

ColumnMapping

protected ColumnMapping(DatabaseColumnMappingConfig config)

builds a new mapping according to the given configuration

Parameters:

config -

ColumnMapping

public ColumnMapping(DatabaseColumnMappingConfig config,
                     java.sql.ResultSetMetaData metaData,
                     DatabaseConnector connector)
              throws java.lang.Exception

builds a new mapping according to the given configuration, resolve index and type from metaData and loads the columnProcessor.

Parameters:

config -

metaData -

connector -

Throws:

java.sql.SQLException

java.lang.Exception

Method Detail

resolveMetaData

public void resolveMetaData(java.sql.ResultSetMetaData metaData)
                     throws java.sql.SQLException

finds in the given metaData an index and a type matching the column name of this mapping

Parameters:

metaData -

Throws:

java.sql.SQLException

loadColumnProcessor

public void loadColumnProcessor()

loads the columnProcessor associated with this mapping.

checkState

public void checkState()

this function checks that the current state of the mapping is sensible: if it is used a a key, a mappingName should be supplied. if used as a mapping, an columnProcessor should be loaded

getColumnIndex

public int getColumnIndex()
                   throws java.sql.SQLException

Throws:

java.sql.SQLException

getColumnName

public java.lang.String getColumnName()

getColumnType

public int getColumnType()

Returns:

The type of the column as found in Types

setColumnName

public void setColumnName(java.lang.String columnName)

isIncludedInDocumentURI

public boolean isIncludedInDocumentURI()

setIncludeInDocumentURI

public void setIncludeInDocumentURI(java.lang.String includeInDocumentURI)

getMappingName

public java.lang.String getMappingName()

setMappingName

public void setMappingName(java.lang.String mappingName)

getColumnProcessor

public ColumnProcessor[] getColumnProcessor()

setColumnProcessor

public void setColumnProcessor(ColumnProcessor[] columnProcessor)

getColumnProcessorParameters

public ColumnProcessorParameter[][] getColumnProcessorParameters()

setColumnProcessorParameters

public void setColumnProcessorParameters(ColumnProcessorParameter[][] columnProcessorParameters)

getColumnProcessorName

public java.lang.String[] getColumnProcessorName()

setColumnProcessorName

public void setColumnProcessorName(java.lang.String[] columnProcessorName)