com.exalead.papi.connectors.jdbc.columnprocessing

Class ColumnProcessor

java.lang.Object

com.exalead.papi.connectors.jdbc.columnprocessing.ColumnProcessor

Direct Known Subclasses:

AutomaticProcessor, AverageMetaProcessor, ConcatenateMetaProcessor, ConcatenatePartProcessor, DocumentFilterProcessor, FileAttachPartProcessor, FirstValueAsMetaProcessor, FirstValueAsPartProcessor, InterconnectorServiceProcessor, LastValueAsMetaProcessor, LastValueAsPartProcessor, MapValueAsMetaProcessor, MaximumCheckpointProcessor, MaximumMetaProcessor, MinimumMetaProcessor, MultipleMetaProcessor, MultiplePartProcessor, NumericalProcessor, RowNumURIBuilder, StandardURIBuilder, TotalMetaProcessor, UniqueMetaProcessor

public abstract class ColumnProcessor
extends java.lang.Object

An columnProcessor is responsible of processing data when synchronization is performed.

Field Summary

Fields

Modifier and Type	Field and Description
ColumnMapping	columnMapping The column mapping associated with this columnProcessor.
protected DatabaseConnector	connector the connector where this column processor was instantiated
JDBCDocument	document the document where the columnProcessor should apply its changes.
protected static org.apache.log4j.Logger	logger
java.lang.String	name
java.util.Map<java.lang.String,java.lang.String>	parameters Additional parameters used by custom processors
boolean	verbose

Constructor Summary

Constructors

Constructor and Description
ColumnProcessor()

Method Summary

Modifier and Type	Method and Description
void	addParameters(java.lang.String key, java.lang.String value)
void	buildURI(ResultSetProxy row, JDBCURI documentURI, JDBCURI referenceURI) This method is called to build the URI
void	end() This method is called when synchronization is done.
void	endDocument() This method is called when the connector is about to send the document via the PushAPI.
void	error(java.lang.String msg)
ColumnMapping	getColumnMapping()
DatabaseConnector	getConnector()
JDBCDocument	getDocument()
java.util.Map<java.lang.String,java.lang.String>	getParameters()
void	info(java.lang.String msg)
protected java.lang.String	makeLogString(java.lang.String msg)
abstract void	processRow(ResultSetProxy row) This method is called when the connector a tuple should be processed
void	setColumnMapping(ColumnMapping columnMapping)
void	setConnector(DatabaseConnector connector)
void	setDocument(JDBCDocument document)
void	setParameters(java.util.Map<java.lang.String,java.lang.String> parameters)
void	start() This method is called the custom parameters has been filled and before the beginning of synchronization.
void	startDocument() This method is called when the connector begins to process a new PAPI document
void	verbose(java.lang.String msg)
void	warning(java.lang.String msg)

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected static org.apache.log4j.Logger logger

connector

protected DatabaseConnector connector

the connector where this column processor was instantiated

document

public JDBCDocument document

the document where the columnProcessor should apply its changes. Note that some fields of the document may not be set when the columnProcessor works (eg. the document URI).

columnMapping

public ColumnMapping columnMapping

The column mapping associated with this columnProcessor.

parameters

public java.util.Map<java.lang.String,java.lang.String> parameters

Additional parameters used by custom processors

verbose

public boolean verbose

name

public java.lang.String name

Constructor Detail

ColumnProcessor

public ColumnProcessor()

Method Detail

makeLogString

protected java.lang.String makeLogString(java.lang.String msg)

info

public void info(java.lang.String msg)

warning

public void warning(java.lang.String msg)

error

public void error(java.lang.String msg)

verbose

public void verbose(java.lang.String msg)

buildURI

public void buildURI(ResultSetProxy row,
                     JDBCURI documentURI,
                     JDBCURI referenceURI)
              throws java.lang.Exception

This method is called to build the URI

Throws:

java.lang.Exception

start

public void start()
           throws java.lang.Exception

This method is called the custom parameters has been filled and before the beginning of synchronization.

Throws:

java.lang.Exception

end

public void end()
         throws java.lang.Exception

This method is called when synchronization is done.

Throws:

java.lang.Exception

startDocument

public void startDocument()
                   throws java.lang.Exception

This method is called when the connector begins to process a new PAPI document

Throws:

java.lang.Exception

endDocument

public void endDocument()
                 throws java.lang.Exception

This method is called when the connector is about to send the document via the PushAPI. This call notifies the columnProcessor that pending operations should be applied to the document.

Throws:

java.lang.Exception

processRow

public abstract void processRow(ResultSetProxy row)
                         throws java.lang.Exception

This method is called when the connector a tuple should be processed

Throws:

java.lang.Exception

getDocument

public JDBCDocument getDocument()

setDocument

public void setDocument(JDBCDocument document)

getColumnMapping

public ColumnMapping getColumnMapping()

setColumnMapping

public void setColumnMapping(ColumnMapping columnMapping)

getParameters

public java.util.Map<java.lang.String,java.lang.String> getParameters()

setParameters

public void setParameters(java.util.Map<java.lang.String,java.lang.String> parameters)

addParameters

public void addParameters(java.lang.String key,
                          java.lang.String value)

getConnector

public DatabaseConnector getConnector()

setConnector

public void setConnector(DatabaseConnector connector)