ca.sqlpower.architect
Interface ArchitectSessionContext

All Known Subinterfaces:

ArchitectSwingSessionContext

All Known Implementing Classes:

ArchitectSessionContextImpl, ArchitectSwingSessionContextImpl

public interface ArchitectSessionContext

The ArchitectSessionContext interface specifies a set of properties and methods for creating new Architect Sessions. Additionally, the session context is the gateway to information that is specific to the current user's environment (as opposed to information that is attached to specific projects, which is stored in the session).

Field Summary

static java.lang.String

DRIVERS_URL The URL where there is more information about finding and configuring JDBC drivers.

Method Summary

ArchitectSession	createSession() Creates a new session within this parent context.
ArchitectSession	createSession(java.io.InputStream in) Creates a new session by loading the Architect XML project description from the given input stream.
java.util.List<ca.sqlpower.sql.SPDataSource>	getConnections()
ca.sqlpower.sql.DataSourceCollection	getPlDotIni() Tries to read the plDotIni if it hasn't been done already.
java.lang.String	getPlDotIniPath()
java.util.prefs.Preferences	getPrefs() Returns the user preferences node associated with this context.
java.util.Collection<ArchitectSession>	getSessions() Returns a collection containing all the sessions from this context.
void	setPlDotIniPath(java.lang.String plDotIniPath) Sets the plDotIniPath property, and nulls out the current plDotIni if the given value differs from the existing one.

Field Detail

DRIVERS_URL

static final java.lang.String DRIVERS_URL

The URL where there is more information about finding and configuring JDBC drivers.

See Also:

Constant Field Values

Method Detail

createSession

ArchitectSession createSession()
                               throws ArchitectException

Creates a new session within this parent context.

Throws:

ArchitectException

createSession

ArchitectSession createSession(java.io.InputStream in)
                               throws ArchitectException,
                                      java.io.IOException

Creates a new session by loading the Architect XML project description from the given input stream.

Parameters:

in - The input stream to read the XML data from

Returns:

The new session

Throws:

ArchitectException

java.io.IOException

getPrefs

java.util.prefs.Preferences getPrefs()

Returns the user preferences node associated with this context.

getSessions

java.util.Collection<ArchitectSession> getSessions()

Returns a collection containing all the sessions from this context.

getPlDotIniPath

java.lang.String getPlDotIniPath()

getPlDotIni

ca.sqlpower.sql.DataSourceCollection getPlDotIni()

Tries to read the plDotIni if it hasn't been done already. If it can't be read, returns null and leaves the plDotIni property as null as well. See #plDotIni.

getConnections

java.util.List<ca.sqlpower.sql.SPDataSource> getConnections()

setPlDotIniPath

void setPlDotIniPath(java.lang.String plDotIniPath)

Sets the plDotIniPath property, and nulls out the current plDotIni if the given value differs from the existing one. See #plDotIniPath.