org.geotools.arcsde.pool
Class ArcSDEReferencedConnection

Object
  ArcSDEReferencedConnection

All Implemented Interfaces:

ISession

public class ArcSDEReferencedConnection
extends Object

There can be only one! It ends up being modal based on a transaction being around. If supplied with Transaction.AUTO_COMMIT the connection is viewed as being read only.

Author:

Jody Garnett

Constructor Summary

ArcSDEReferencedConnection(ObjectPool pool, ArcSDEConnectionConfig config)

Method Summary

void	close(SeState state)
void	close(SeStreamOp stream)
void	commitTransaction() Commits the current transaction.
SeQuery	createAndExecuteQuery(String[] propertyNames, SeSqlConstruct sql)
SeState	createChildState(long parentStateId) Creates either a direct child state of parentStateId, or a sibling being an exact copy of parentStatId if either the state can't be closed because its in use or parentStateId does not belong to the current user.
SeDelete	createSeDelete()
SeInsert	createSeInsert()
SeLayer	createSeLayer()
SeQuery	createSeQuery()
SeQuery	createSeQuery(String[] propertyNames, SeSqlConstruct sql) Creates an SeQuery to fetch the given propertyNames with the provided attribute based restrictions This method shall only be called from inside a Command
SeRasterColumn	createSeRasterColumn()
SeRasterColumn	createSeRasterColumn(SeObjectId rasterColumnId)
SeRegistration	createSeRegistration(String typeName)
SeTable	createSeTable(String qualifiedName) Creates an SeTable named qualifiedName; the layer does not need to exist on the server.
SeUpdate	createSeUpdate()
SeState	createState(SeObjectId stateId)
SeColumnDefinition[]	describe(SeTable table)
SeColumnDefinition[]	describe(String tableName)
void	dispose() Return to the pool (may not close the internal connection, depends on pool settings).
boolean	equals(Object other) Compares for reference equality
SdeRow	fetch(SeQuery query) Issues a command that fetches a row from an already executed SeQuery and returns the SdeRow object with its contents.
SdeRow	fetch(SeQuery query, SdeRow currentRow)
String	getDatabaseName()
SeDBMSInfo	getDBMSInfo()
SeVersion	getDefaultVersion() Returns the up to date information about the database default version
SeLayer	getLayer(String layerName)
List<SeLayer>	getLayers() Returns the live list of layers, not the cached ones, so it may pick up the differences in the database.
SeRasterColumn	getRasterColumn(String rasterName)
SeRelease	getRelease()
SeTable	getTable(String tableName)
String	getUser()
int	hashCode()
boolean	isClosed()
boolean	isDisposed() Returns whether this connection is on the connection pool domain or not.
<T> T	issue(Command<T> command) Executes the given command and returns its result.
boolean	isTransactionActive() Returns whether a transaction is in progress over this connection As for any other public method, this one can't be called if ISession.isDisposed() is true.
void	rollbackTransaction() Rolls back the current transaction When this method returns it is guaranteed that ISession.isTransactionActive() will return false, regardless of the success of the rollback operation.
void	startTransaction() Starts a transaction over the connection held by this Session If this method succeeds, ISession.isTransactionActive() will return true afterwards
String	toString()

Methods inherited from class Object

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

Constructor Detail

ArcSDEReferencedConnection

public ArcSDEReferencedConnection(ObjectPool pool,
                                  ArcSDEConnectionConfig config)
                           throws IOException

Throws:

IOException

Method Detail

issue

public <T> T issue(Command<T> command)
        throws IOException

Description copied from interface: ISession

Executes the given command and returns its result.

Specified by:

issue in interface ISession

Parameters:

command - the command to execute

Throws:

IOException - if an exception occurs handling any ArcSDE resource while executing the command

See Also:

ISession.issue(org.geotools.arcsde.pool.Command)

isClosed

public final boolean isClosed()

Specified by:

isClosed in interface ISession

See Also:

ISession.isClosed()

isDisposed

public boolean isDisposed()

Description copied from interface: ISession

Returns whether this connection is on the connection pool domain or not.

Specified by:

isDisposed in interface ISession

Returns:

true if this connection has beed returned to the pool and thus cannot be used, false if its safe to keep using it.

See Also:

ISession#isPassivated()

getLayer

public SeLayer getLayer(String layerName)
                 throws IOException

Specified by:

getLayer in interface ISession

Throws:

IOException

See Also:

ISession.getLayer(java.lang.String)

getRasterColumn

public SeRasterColumn getRasterColumn(String rasterName)
                               throws IOException

Specified by:

getRasterColumn in interface ISession

Throws:

IOException

See Also:

ISession.getRasterColumn(java.lang.String)

getTable

public SeTable getTable(String tableName)
                 throws IOException

Specified by:

getTable in interface ISession

Throws:

IOException

See Also:

ISession.getTable(java.lang.String)

startTransaction

public void startTransaction()
                      throws IOException

Description copied from interface: ISession

Starts a transaction over the connection held by this Session

If this method succeeds, ISession.isTransactionActive() will return true afterwards

Specified by:

startTransaction in interface ISession

Throws:

IOException

See Also:

ISession.startTransaction()

commitTransaction

public void commitTransaction()
                       throws IOException

Description copied from interface: ISession

Commits the current transaction.

This method shall only be called from inside a command

Specified by:

commitTransaction in interface ISession

Throws:

IOException

See Also:

ISession.commitTransaction()

isTransactionActive

public boolean isTransactionActive()

Description copied from interface: ISession

Returns whether a transaction is in progress over this connection

As for any other public method, this one can't be called if ISession.isDisposed() is true.

Specified by:

isTransactionActive in interface ISession

Returns:

See Also:

ISession.isTransactionActive()

rollbackTransaction

public void rollbackTransaction()
                         throws IOException

Description copied from interface: ISession

Rolls back the current transaction

When this method returns it is guaranteed that ISession.isTransactionActive() will return false, regardless of the success of the rollback operation.

Specified by:

rollbackTransaction in interface ISession

Throws:

IOException

See Also:

ISession.rollbackTransaction()

dispose

public void dispose()
             throws IllegalStateException

Description copied from interface: ISession

Return to the pool (may not close the internal connection, depends on pool settings).

Specified by:

dispose in interface ISession

Throws:

IllegalStateException - if close() is called while a transaction is in progress

See Also:

ISession#close()

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object other)

Description copied from interface: ISession

Compares for reference equality

Specified by:

equals in interface ISession

Overrides:

equals in class Object

See Also:

ISession.equals(java.lang.Object)

hashCode

public int hashCode()

Specified by:

hashCode in interface ISession

Overrides:

hashCode in class Object

See Also:

ISession.hashCode()

getLayers

public List<SeLayer> getLayers()
                        throws IOException

Description copied from interface: ISession

Returns the live list of layers, not the cached ones, so it may pick up the differences in the database.

Specified by:

getLayers in interface ISession

Returns:

Throws:

IOException

See Also:

ISession.getLayers()

getUser

public String getUser()
               throws IOException

Specified by:

getUser in interface ISession

Throws:

IOException

See Also:

ISession.getUser()

getRelease

public SeRelease getRelease()
                     throws IOException

Specified by:

getRelease in interface ISession

Throws:

IOException

See Also:

ISession.getRelease()

getDatabaseName

public String getDatabaseName()
                       throws IOException

Specified by:

getDatabaseName in interface ISession

Throws:

IOException

See Also:

ISession.getDatabaseName()

getDBMSInfo

public SeDBMSInfo getDBMSInfo()
                       throws IOException

Specified by:

getDBMSInfo in interface ISession

Throws:

IOException

createSeLayer

public SeLayer createSeLayer()
                      throws IOException

Specified by:

createSeLayer in interface ISession

Throws:

IOException

See Also:

ISession.createSeLayer()

createSeRegistration

public SeRegistration createSeRegistration(String typeName)
                                    throws IOException

Specified by:

createSeRegistration in interface ISession

Throws:

IOException

See Also:

ISession.createSeRegistration(java.lang.String)

createSeTable

public SeTable createSeTable(String qualifiedName)
                      throws IOException

Description copied from interface: ISession

Creates an SeTable named qualifiedName; the layer does not need to exist on the server.

Specified by:

createSeTable in interface ISession

Returns:

Throws:

IOException

See Also:

ISession.createSeTable(java.lang.String)

createSeInsert

public SeInsert createSeInsert()
                        throws IOException

Specified by:

createSeInsert in interface ISession

Throws:

IOException

See Also:

ISession.createSeInsert()

createSeUpdate

public SeUpdate createSeUpdate()
                        throws IOException

Specified by:

createSeUpdate in interface ISession

Throws:

IOException

See Also:

ISession.createSeUpdate()

createSeDelete

public SeDelete createSeDelete()
                        throws IOException

Specified by:

createSeDelete in interface ISession

Throws:

IOException

See Also:

ISession.createSeDelete()

createSeRasterColumn

public SeRasterColumn createSeRasterColumn()
                                    throws IOException

Specified by:

createSeRasterColumn in interface ISession

Throws:

IOException

See Also:

ISession.createSeRasterColumn()

createSeRasterColumn

public SeRasterColumn createSeRasterColumn(SeObjectId rasterColumnId)
                                    throws IOException

Specified by:

createSeRasterColumn in interface ISession

Throws:

IOException

See Also:

ISession.createSeRasterColumn(com.esri.sde.sdk.client.SeObjectId)

describe

public SeColumnDefinition[] describe(String tableName)
                              throws IOException

Specified by:

describe in interface ISession

Throws:

IOException

See Also:

ISession.describe(java.lang.String)

describe

public SeColumnDefinition[] describe(SeTable table)
                              throws IOException

Specified by:

describe in interface ISession

Throws:

IOException

See Also:

ISession.describe(com.esri.sde.sdk.client.SeTable)

fetch

public SdeRow fetch(SeQuery query)
             throws IOException

Description copied from interface: ISession

Issues a command that fetches a row from an already executed SeQuery and returns the SdeRow object with its contents.

The point in returning an SdeRow instead of a plain SeRow is that the former prefetches the row values and this can be freely used outside a Command. Otherwise the SeRow should only be used inside a command as accessing its values implies using the connection.

Specified by:

fetch in interface ISession

Returns:

Throws:

IOException

See Also:

ISession.fetch(com.esri.sde.sdk.client.SeQuery)

fetch

public SdeRow fetch(SeQuery query,
                    SdeRow currentRow)
             throws IOException

Specified by:

fetch in interface ISession

Throws:

IOException

close

public void close(SeState state)
           throws IOException

Specified by:

close in interface ISession

Throws:

IOException

See Also:

ISession.close(com.esri.sde.sdk.client.SeState)

close

public void close(SeStreamOp stream)
           throws IOException

Specified by:

close in interface ISession

Throws:

IOException

See Also:

ISession.close(com.esri.sde.sdk.client.SeStreamOp)

createState

public SeState createState(SeObjectId stateId)
                    throws IOException

Specified by:

createState in interface ISession

Throws:

IOException

See Also:

ISession.createState(com.esri.sde.sdk.client.SeObjectId)

createSeQuery

public SeQuery createSeQuery()
                      throws IOException

Specified by:

createSeQuery in interface ISession

Throws:

IOException

See Also:

ISession.createSeQuery()

createSeQuery

public SeQuery createSeQuery(String[] propertyNames,
                             SeSqlConstruct sql)
                      throws IOException

Description copied from interface: ISession

Creates an SeQuery to fetch the given propertyNames with the provided attribute based restrictions

This method shall only be called from inside a Command

Specified by:

createSeQuery in interface ISession

Returns:

Throws:

IOException

See Also:

ISession.createSeQuery(java.lang.String[], com.esri.sde.sdk.client.SeSqlConstruct)

createAndExecuteQuery

public SeQuery createAndExecuteQuery(String[] propertyNames,
                                     SeSqlConstruct sql)
                              throws IOException

Specified by:

createAndExecuteQuery in interface ISession

Throws:

IOException

See Also:

ISession.createAndExecuteQuery(java.lang.String[], com.esri.sde.sdk.client.SeSqlConstruct)

getDefaultVersion

public SeVersion getDefaultVersion()
                            throws IOException

Description copied from interface: ISession

Returns the up to date information about the database default version

Specified by:

getDefaultVersion in interface ISession

Throws:

IOException

See Also:

ISession.getDefaultVersion()

createChildState

public SeState createChildState(long parentStateId)
                         throws IOException

Creates either a direct child state of parentStateId, or a sibling being an exact copy of parentStatId if either the state can't be closed because its in use or parentStateId does not belong to the current user.

Specified by:

createChildState in interface ISession

Throws:

IOException