Package org.apache.jena.jdbc.connections

Class JenaConnection

java.lang.Object

org.apache.jena.jdbc.connections.JenaConnection

All Implemented Interfaces:

AutoCloseable, Connection, Wrapper

Direct Known Subclasses:

DatasetConnection, RemoteEndpointConnection

public abstract class JenaConnection
extends Object
implements Connection

Abstract base implementation of a Jena JDBC connection

Generally speaking this is a faithful implementation of a JDBC connection but it also provides a couple of Jena JDBC specific features:

1. JDBC compatibility level
2. Command pre-processors

The JDBC compatibility level allows the API to behave slightly differently depending on how JDBC like you need it to be, see JdbcCompatibility for more discussion on this.

Command pre-processors are an extension mechanism designed to allow Jena JDBC connections to cope with the fact that the tools consuming the API may be completely unaware that we speak SPARQL rather than SQL. They allow for manipulation of incoming command text as well as manipulation of the parsed SPARQL queries and updates as desired.

Field Summary

Fields

Modifier and Type	Field	Description
static final boolean	DEFAULT_AUTO_COMMIT	Constant for default auto-commit for Jena JDBC connections
static final int	DEFAULT_HOLDABILITY	Constant for default cursor holdability for Jena JDBC connections
static final int	DEFAULT_ISOLATION_LEVEL	Constant for default transaction isolation level for Jena JDBC connections

Fields inherited from interface java.sql.Connection

TRANSACTION_NONE, TRANSACTION_READ_COMMITTED, TRANSACTION_READ_UNCOMMITTED, TRANSACTION_REPEATABLE_READ, TRANSACTION_SERIALIZABLE

Constructor Summary

Constructors

Constructor	Description
JenaConnection(int holdability, boolean autoCommit, int transactionLevel, int compatibilityLevel)	Creates a new connection

Method Summary

Modifier and Type	Method	Description
void	abort(Executor executor)
final void	addPostProcessor(ResultsPostProcessor postProcessor)	Adds a results post-processor to the connection
final void	addPreProcessor(CommandPreProcessor preProcessor)	Adds a command pre-processor to the connection
final boolean	applyPostProcessors(boolean result)	Applies registered post-processors to the given results
final Iterator<Triple>	applyPostProcessors(Iterator<Triple> triples)	Applies registered post-processors to the given results
final AskResultsMetadata	applyPostProcessors(AskResultsMetadata metadata)	Applies registered post-processors to the given results metadata
final SelectResultsMetadata	applyPostProcessors(SelectResultsMetadata metadata)	Applies registered post-processors to the given results metadata
final TripleResultsMetadata	applyPostProcessors(TripleResultsMetadata metadata)	Applies registered post-processors to the given results metadata
final ResultSet	applyPostProcessors(ResultSet results)	Applies registered post-processors to the given results
final String	applyPreProcessors(String text)	Apply registered pre-processors to the given command text
final Query	applyPreProcessors(Query q)	Applies registered pre-processors to the given query
final UpdateRequest	applyPreProcessors(UpdateRequest u)	Applies registered pre-processors to the given update
final void	clearPostProcessors()	Clears all command post-processors from the connection
final void	clearPreProcessors()	Clears all command pre-processor from the connection
void	clearWarnings()
final void	close()
void	commit()
Array	createArrayOf(String typeName, Object[] elements)
Blob	createBlob()
Clob	createClob()
NClob	createNClob()
SQLXML	createSQLXML()
final Statement	createStatement()
final Statement	createStatement(int resultSetType, int resultSetConcurrency)
final Statement	createStatement(int resultSetType, int resultSetConcurrency, int resultSetHoldability)
Struct	createStruct(String typeName, Object[] attributes)
boolean	getAutoCommit()
String	getCatalog()
Properties	getClientInfo()
String	getClientInfo(String name)
int	getHoldability()
int	getJdbcCompatibilityLevel()	Gets the JDBC compatibility level that is in use, see JdbcCompatibility for explanations
abstract DatabaseMetaData	getMetaData()
int	getNetworkTimeout()
final Iterator<ResultsPostProcessor>	getPostProcessors()	Gets the currently registered post-processors for the connection
final Iterator<CommandPreProcessor>	getPreProcessors()	Gets the currently registered pre-processors for the connection
String	getSchema()
int	getTransactionIsolation()
Map<String,Class<?>>	getTypeMap()
SQLWarning	getWarnings()
final void	insertPostProcessor(int index, ResultsPostProcessor postProcessor)	Inserts a results post-processor for the connection
final void	insertPreProcessor(int index, CommandPreProcessor preProcessor)	Inserts a command pre-processor for the connection
abstract boolean	isClosed()
abstract boolean	isReadOnly()
abstract boolean	isValid(int timeout)
boolean	isWrapperFor(Class<?> arg0)
String	nativeSQL(String sql)
CallableStatement	prepareCall(String sql)
CallableStatement	prepareCall(String sql, int resultSetType, int resultSetConcurrency)
CallableStatement	prepareCall(String sql, int resultSetType, int resultSetConcurrency, int resultSetHoldability)
PreparedStatement	prepareStatement(String sql)
PreparedStatement	prepareStatement(String sql, int autoGeneratedKeys)
PreparedStatement	prepareStatement(String sql, int[] columnIndexes)
PreparedStatement	prepareStatement(String sql, int resultSetType, int resultSetConcurrency)
PreparedStatement	prepareStatement(String sql, int resultSetType, int resultSetConcurrency, int resultSetHoldability)
PreparedStatement	prepareStatement(String sql, String[] columnNames)
void	releaseSavepoint(Savepoint savepoint)
final void	removePostProcessor(int index)	Removes a results post-processor from the connection
final void	removePostProcessor(ResultsPostProcessor postProcessor)	Removes a results post-processor from the connection
final void	removePreProcessor(int index)	Removes a command pre-processor from the connection
final void	removePreProcessor(CommandPreProcessor preProcessor)	Removes a command pre-processor from the connection
void	rollback()
void	rollback(Savepoint savepoint)
void	setAutoCommit(boolean autoCommit)
void	setCatalog(String catalog)
void	setClientInfo(String name, String value)
void	setClientInfo(Properties properties)
void	setHoldability(int holdability)
void	setJdbcCompatibilityLevel(int level)	Sets the JDBC compatibility level that is in use, see JdbcCompatibility for explanations.
void	setNetworkTimeout(Executor executor, int milliseconds)
abstract void	setReadOnly(boolean readOnly)
Savepoint	setSavepoint()
Savepoint	setSavepoint(String name)
void	setSchema(String schema)
void	setTransactionIsolation(int level)
void	setTypeMap(Map<String,Class<?>> map)
<T> T	unwrap(Class<T> arg0)

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.sql.Connection

beginRequest, endRequest, setShardingKey, setShardingKey, setShardingKeyIfValid, setShardingKeyIfValid

Field Details

DEFAULT_HOLDABILITY

public static final int DEFAULT_HOLDABILITY

Constant for default cursor holdability for Jena JDBC connections

See Also:

• Constant Field Values

DEFAULT_AUTO_COMMIT

public static final boolean DEFAULT_AUTO_COMMIT

Constant for default auto-commit for Jena JDBC connections

See Also:

• Constant Field Values

DEFAULT_ISOLATION_LEVEL

public static final int DEFAULT_ISOLATION_LEVEL

Constant for default transaction isolation level for Jena JDBC connections

See Also:

• Constant Field Values

Constructor Details

JenaConnection

public JenaConnection(int holdability,
 boolean autoCommit,
 int transactionLevel,
 int compatibilityLevel)
               throws SQLException

Creates a new connection

Parameters:

holdability - Cursor holdability

autoCommit - Sets auto-commit behaviour for the connection

transactionLevel - Sets transaction isolation level for the connection

compatibilityLevel - Sets JDBC compatibility level for the connection, see JdbcCompatibility

Throws:

SQLException - Thrown if the arguments are invalid

Method Details

getJdbcCompatibilityLevel

public int getJdbcCompatibilityLevel()

Gets the JDBC compatibility level that is in use, see JdbcCompatibility for explanations

Returns:

Compatibility level

setJdbcCompatibilityLevel

public void setJdbcCompatibilityLevel(int level)

Sets the JDBC compatibility level that is in use, see JdbcCompatibility for explanations.

Changing the level may not effect existing open objects, behaviour in this case will be implementation specific.

Parameters:

level - Compatibility level

addPreProcessor

public final void addPreProcessor(CommandPreProcessor preProcessor)

Adds a command pre-processor to the connection

Parameters:

preProcessor - Pre-processor to add

addPostProcessor

public final void addPostProcessor(ResultsPostProcessor postProcessor)

Adds a results post-processor to the connection

Parameters:

postProcessor - Post-processor to add

insertPreProcessor

public final void insertPreProcessor(int index,
 CommandPreProcessor preProcessor)

Inserts a command pre-processor for the connection

Parameters:

index - Index to insert at

preProcessor - Pre-processor

insertPostProcessor

public final void insertPostProcessor(int index,
 ResultsPostProcessor postProcessor)

Inserts a results post-processor for the connection

Parameters:

index - Index to insert at

postProcessor - Post-processor

removePreProcessor

public final void removePreProcessor(CommandPreProcessor preProcessor)

Removes a command pre-processor from the connection

Parameters:

preProcessor - Pre-processor to remove

removePostProcessor

public final void removePostProcessor(ResultsPostProcessor postProcessor)

Removes a results post-processor from the connection

Parameters:

postProcessor - Post-processor to remove

removePreProcessor

public final void removePreProcessor(int index)

Removes a command pre-processor from the connection

Parameters:

index - Index to remove at

removePostProcessor

public final void removePostProcessor(int index)

Removes a results post-processor from the connection

Parameters:

index - Index to remove at

clearPreProcessors

public final void clearPreProcessors()

Clears all command pre-processor from the connection

clearPostProcessors

public final void clearPostProcessors()

Clears all command post-processors from the connection

getPreProcessors

public final Iterator<CommandPreProcessor> getPreProcessors()

Gets the currently registered pre-processors for the connection

Returns:

Iterator of pre-processors

getPostProcessors

public final Iterator<ResultsPostProcessor> getPostProcessors()

Gets the currently registered post-processors for the connection

Returns:

Iterator of post-processors

applyPreProcessors

public final String applyPreProcessors(String text)
                                throws SQLException

Apply registered pre-processors to the given command text

Parameters:

text - Command Text

Returns:

Command Text after processing by registered pre-processors

Throws:

SQLException

applyPreProcessors

public final Query applyPreProcessors(Query q)
                               throws SQLException

Applies registered pre-processors to the given query

Parameters:

q - Query

Returns:

Query after processing by registered pre-processors

Throws:

SQLException

applyPreProcessors

public final UpdateRequest applyPreProcessors(UpdateRequest u)
                                       throws SQLException

Applies registered pre-processors to the given update

Parameters:

u - Update

Returns:

Update after processing by registered pre-processors

Throws:

SQLException

applyPostProcessors

public final ResultSet applyPostProcessors(ResultSet results)
                                    throws SQLException

Applies registered post-processors to the given results

Parameters:

results - Results

Returns:

Results after processing by registered post-processors

Throws:

SQLException

applyPostProcessors

public final Iterator<Triple> applyPostProcessors(Iterator<Triple> triples)
                                           throws SQLException

Applies registered post-processors to the given results

Parameters:

triples - Results

Returns:

Results after processing by registered post-processors

Throws:

SQLException

applyPostProcessors

public final boolean applyPostProcessors(boolean result)
                                  throws SQLException

Applies registered post-processors to the given results

Parameters:

result - Result

Returns:

Result after processing by registered post-processors

Throws:

SQLException

applyPostProcessors

public final SelectResultsMetadata applyPostProcessors(SelectResultsMetadata metadata)
                                                throws SQLException

Applies registered post-processors to the given results metadata

Parameters:

metadata - Results metadata

Returns:

Results metadata after processing by registered post-processors

Throws:

SQLException

applyPostProcessors

public final TripleResultsMetadata applyPostProcessors(TripleResultsMetadata metadata)
                                                throws SQLException

Applies registered post-processors to the given results metadata

Parameters:

metadata - Results metadata

Returns:

Results metadata after processing by registered post-processors

Throws:

SQLException

applyPostProcessors

public final AskResultsMetadata applyPostProcessors(AskResultsMetadata metadata)
                                             throws SQLException

Applies registered post-processors to the given results metadata

Parameters:

metadata - Results metadata

Returns:

Results metadata after processing by registered post-processors

Throws:

SQLException

isWrapperFor

public boolean isWrapperFor(Class<?> arg0)
                     throws SQLException

Specified by:

isWrapperFor in interface Wrapper

Throws:

SQLException

unwrap

public <T> T unwrap(Class<T> arg0)
             throws SQLException

Specified by:

unwrap in interface Wrapper

Throws:

SQLException

clearWarnings

public void clearWarnings()

Specified by:

clearWarnings in interface Connection

close

public final void close()
                 throws SQLException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Connection

Throws:

SQLException

commit

public void commit()
            throws SQLException

Specified by:

commit in interface Connection

Throws:

SQLException

createArrayOf

public Array createArrayOf(String typeName,
 Object[] elements)
                    throws SQLException

Specified by:

createArrayOf in interface Connection

Throws:

SQLException

createBlob

public Blob createBlob()
                throws SQLException

Specified by:

createBlob in interface Connection

Throws:

SQLException

createClob

public Clob createClob()
                throws SQLException

Specified by:

createClob in interface Connection

Throws:

SQLException

createNClob

public NClob createNClob()
                  throws SQLException

Specified by:

createNClob in interface Connection

Throws:

SQLException

createSQLXML

public SQLXML createSQLXML()
                    throws SQLException

Specified by:

createSQLXML in interface Connection

Throws:

SQLException

createStatement

public final Statement createStatement()
                                throws SQLException

Specified by:

createStatement in interface Connection

Throws:

SQLException

createStatement

public final Statement createStatement(int resultSetType,
 int resultSetConcurrency)
                                throws SQLException

Specified by:

createStatement in interface Connection

Throws:

SQLException

createStatement

public final Statement createStatement(int resultSetType,
 int resultSetConcurrency,
 int resultSetHoldability)
                                throws SQLException

Specified by:

createStatement in interface Connection

Throws:

SQLException

createStruct

public Struct createStruct(String typeName,
 Object[] attributes)
                    throws SQLException

Specified by:

createStruct in interface Connection

Throws:

SQLException

getAutoCommit

public boolean getAutoCommit()

Specified by:

getAutoCommit in interface Connection

getCatalog

public String getCatalog()

Specified by:

getCatalog in interface Connection

getClientInfo

public Properties getClientInfo()

Specified by:

getClientInfo in interface Connection

getClientInfo

public String getClientInfo(String name)

Specified by:

getClientInfo in interface Connection

getHoldability

public int getHoldability()

Specified by:

getHoldability in interface Connection

getMetaData

public abstract DatabaseMetaData getMetaData()
                                      throws SQLException

Specified by:

getMetaData in interface Connection

Throws:

SQLException

getTransactionIsolation

public int getTransactionIsolation()

Specified by:

getTransactionIsolation in interface Connection

getTypeMap

public Map<String,Class<?>> getTypeMap()
                                throws SQLException

Specified by:

getTypeMap in interface Connection

Throws:

SQLException

getWarnings

public SQLWarning getWarnings()

Specified by:

getWarnings in interface Connection

isClosed

public abstract boolean isClosed()
                          throws SQLException

Specified by:

isClosed in interface Connection

Throws:

SQLException

isReadOnly

public abstract boolean isReadOnly()
                            throws SQLException

Specified by:

isReadOnly in interface Connection

Throws:

SQLException

isValid

public abstract boolean isValid(int timeout)
                         throws SQLException

Specified by:

isValid in interface Connection

Throws:

SQLException

nativeSQL

public String nativeSQL(String sql)
                 throws SQLException

Specified by:

nativeSQL in interface Connection

Throws:

SQLException

prepareCall

public CallableStatement prepareCall(String sql)
                              throws SQLException

Specified by:

prepareCall in interface Connection

Throws:

SQLException

prepareCall

public CallableStatement prepareCall(String sql,
 int resultSetType,
 int resultSetConcurrency)
                              throws SQLException

Specified by:

prepareCall in interface Connection

Throws:

SQLException

prepareCall

public CallableStatement prepareCall(String sql,
 int resultSetType,
 int resultSetConcurrency,
 int resultSetHoldability)
                              throws SQLException

Specified by:

prepareCall in interface Connection

Throws:

SQLException

prepareStatement

public PreparedStatement prepareStatement(String sql)
                                   throws SQLException

Specified by:

prepareStatement in interface Connection

Throws:

SQLException

prepareStatement

public PreparedStatement prepareStatement(String sql,
 int autoGeneratedKeys)
                                   throws SQLException

Specified by:

prepareStatement in interface Connection

Throws:

SQLException

prepareStatement

public PreparedStatement prepareStatement(String sql,
 int[] columnIndexes)
                                   throws SQLException

Specified by:

prepareStatement in interface Connection

Throws:

SQLException

prepareStatement

public PreparedStatement prepareStatement(String sql,
 String[] columnNames)
                                   throws SQLException

Specified by:

prepareStatement in interface Connection

Throws:

SQLException

prepareStatement

public PreparedStatement prepareStatement(String sql,
 int resultSetType,
 int resultSetConcurrency)
                                   throws SQLException

Specified by:

prepareStatement in interface Connection

Throws:

SQLException

prepareStatement

public PreparedStatement prepareStatement(String sql,
 int resultSetType,
 int resultSetConcurrency,
 int resultSetHoldability)
                                   throws SQLException

Specified by:

prepareStatement in interface Connection

Throws:

SQLException

releaseSavepoint

public void releaseSavepoint(Savepoint savepoint)
                      throws SQLException

Specified by:

releaseSavepoint in interface Connection

Throws:

SQLException

rollback

public void rollback()
              throws SQLException

Specified by:

rollback in interface Connection

Throws:

SQLException

rollback

public void rollback(Savepoint savepoint)
              throws SQLException

Specified by:

rollback in interface Connection

Throws:

SQLException

setAutoCommit

public void setAutoCommit(boolean autoCommit)

Specified by:

setAutoCommit in interface Connection

setCatalog

public void setCatalog(String catalog)
                throws SQLException

Specified by:

setCatalog in interface Connection

Throws:

SQLException

setClientInfo

public void setClientInfo(Properties properties)

Specified by:

setClientInfo in interface Connection

setClientInfo

public void setClientInfo(String name,
 String value)

Specified by:

setClientInfo in interface Connection

setHoldability

public void setHoldability(int holdability)
                    throws SQLException

Specified by:

setHoldability in interface Connection

Throws:

SQLException

setReadOnly

public abstract void setReadOnly(boolean readOnly)
                          throws SQLException

Specified by:

setReadOnly in interface Connection

Throws:

SQLException

setSavepoint

public Savepoint setSavepoint()
                       throws SQLException

Specified by:

setSavepoint in interface Connection

Throws:

SQLException

setSavepoint

public Savepoint setSavepoint(String name)
                       throws SQLException

Specified by:

setSavepoint in interface Connection

Throws:

SQLException

setTransactionIsolation

public void setTransactionIsolation(int level)
                             throws SQLException

Specified by:

setTransactionIsolation in interface Connection

Throws:

SQLException

setTypeMap

public void setTypeMap(Map<String,Class<?>> map)
                throws SQLException

Specified by:

setTypeMap in interface Connection

Throws:

SQLException

setSchema

public void setSchema(String schema)
               throws SQLException

Specified by:

setSchema in interface Connection

Throws:

SQLException

getSchema

public String getSchema()
                 throws SQLException

Specified by:

getSchema in interface Connection

Throws:

SQLException

abort

public void abort(Executor executor)
           throws SQLException

Specified by:

abort in interface Connection

Throws:

SQLException

getNetworkTimeout

public int getNetworkTimeout()
                      throws SQLException

Specified by:

getNetworkTimeout in interface Connection

Throws:

SQLException

setNetworkTimeout

public void setNetworkTimeout(Executor executor,
 int milliseconds)
                       throws SQLException

Specified by:

setNetworkTimeout in interface Connection

Throws:

SQLException