|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.crystaldecisions.sdk.occa.report.data.Connection
public class Connection
This object contains information about a data source connection and the tables that belong to it.
Whenever possible, use the IConnection
interface to manipulate this object.
IDatabase.setConnections(Connections)
Constructor Summary | |
---|---|
Connection()
|
|
Connection(IConnection src)
|
Method Summary | |
---|---|
java.lang.Object |
clone(boolean deepClone)
|
void |
close()
Closes the data source connection. |
void |
copyTo(java.lang.Object destObject,
boolean deepCopy)
|
java.lang.Object |
createMember(java.lang.String eleName,
org.xml.sax.Attributes attrs,
XMLSerializationContext ctxt,
java.util.Map objState,
boolean[] bLoaded)
For internal use only. |
void |
doControllerModification(java.lang.Object newObject)
For internal use only. |
void |
endElement(java.lang.String eleName,
java.util.Map objState)
For internal use only. |
void |
enumerateMembers(IMemberVisitor visitor)
For internal use only. |
IConnectionInfo |
getConnectionInfo()
Gets connection information about this data source, which may include the connection type and logon credentials, for example. |
ControllableMixin |
getControllableMixin()
For internal use only. |
java.lang.String |
getDescription()
Gets the description of this data source connection. |
java.lang.String |
getLocation()
The location of the connection (for example, a URI). |
java.lang.String |
getName()
Gets the connection name. |
Fields |
getParameters()
Gets the stored procedure parameters. |
TableJoins |
getTableJoins()
Gets the table joins that define how tbales used in the connection are linked. |
Tables |
getTables()
Returns the tables that belong to the connection. |
boolean |
getTablesFetched()
Returns whether the tables that belong to the connection have been fetched from the server. |
boolean |
hasContent(java.lang.Object srcCon)
|
boolean |
isDirectlyControllable()
For internal use only. |
boolean |
isMatch(IConnection connection_,
boolean completeMatching)
For internal use only. |
boolean |
isOpen()
Tests whether this data source connection is currently open. |
void |
open()
Opens the data source connection. |
void |
readElement(java.lang.String eleName,
java.lang.String sVal,
org.xml.sax.Attributes attrs,
java.util.Map objState)
For internal use only. |
void |
save(XMLWriter writer,
java.lang.String sTag,
XMLSerializationContext ctxt)
For internal use only. |
void |
save(XMLWriter writer,
XMLSerializationContext ctxt)
For internal use only. |
void |
saveContents(XMLWriter writer,
XMLSerializationContext ctxt)
For internal use only. |
void |
setConnectionInfo(IConnectionInfo connectionInfo)
Sets connection information about this data source, which may include the connection type and logon credentials, for example. |
void |
setDescription(java.lang.String description)
Sets the description of this data source connection. |
void |
setLocation(java.lang.String location)
The location of the connection (for example, a URI). |
void |
setName(java.lang.String name)
Sets the connection name. |
void |
setParameters(Fields parameters)
Sets the stored procedure parameters. |
void |
setTableJoins(TableJoins TableJoins)
Sets the table joins that define how tables used in the connection are linked. |
void |
setTables(Tables tables)
Returns the tables that belong to the connection. |
void |
setTablesFetched(boolean tablesFetched)
Sets whether the tables that belong to the connection have been fetched from the server. |
void |
startElement(java.lang.String eleName,
java.util.Map objState,
org.xml.sax.Attributes attrs)
For internal use only. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public Connection(IConnection src)
public Connection()
Method Detail |
---|
public IConnectionInfo getConnectionInfo()
IConnection
getConnectionInfo
in interface IConnection
IConnectionInfo
objectIConnectionInfo
public void setConnectionInfo(IConnectionInfo connectionInfo)
IConnection
setConnectionInfo
in interface IConnection
connectionInfo
- an IConnectionInfo
objectIConnectionInfo
public java.lang.String getDescription()
IConnection
getDescription
in interface IConnection
String
description of the connnectionpublic void setDescription(java.lang.String description)
IConnection
setDescription
in interface IConnection
description
- a String
description of the connnectionpublic java.lang.String getName()
IConnection
getName
in interface IConnection
public void setName(java.lang.String name)
IConnection
setName
in interface IConnection
name
- the name for the data source connectionpublic Fields getParameters()
IConnection
getParameters
in interface IConnection
IParameterField
objectspublic void setParameters(Fields parameters)
IConnection
setParameters
in interface IConnection
parameters
- a collection of IParameterField
objectspublic boolean isOpen() throws ReportSDKExceptionBase
IConnection
isOpen
in interface IConnection
true
if connected to the data source, false
otherwise
ReportSDKExceptionBase
public void open() throws ReportSDKExceptionBase
IConnection
open
in interface IConnection
ReportSDKExceptionBase
public void close() throws ReportSDKExceptionBase
IConnection
close
in interface IConnection
ReportSDKExceptionBase
public ControllableMixin getControllableMixin()
public void doControllerModification(java.lang.Object newObject) throws ReportSDKException
ReportSDKException
public boolean isDirectlyControllable()
public void enumerateMembers(IMemberVisitor visitor)
public boolean isMatch(IConnection connection_, boolean completeMatching)
public java.lang.Object clone(boolean deepClone)
public void copyTo(java.lang.Object destObject, boolean deepCopy)
public boolean hasContent(java.lang.Object srcCon)
public java.lang.Object createMember(java.lang.String eleName, org.xml.sax.Attributes attrs, XMLSerializationContext ctxt, java.util.Map objState, boolean[] bLoaded)
public void endElement(java.lang.String eleName, java.util.Map objState)
public void startElement(java.lang.String eleName, java.util.Map objState, org.xml.sax.Attributes attrs)
public void readElement(java.lang.String eleName, java.lang.String sVal, org.xml.sax.Attributes attrs, java.util.Map objState)
public void save(XMLWriter writer, XMLSerializationContext ctxt) throws java.io.IOException
java.io.IOException
public void save(XMLWriter writer, java.lang.String sTag, XMLSerializationContext ctxt) throws java.io.IOException
java.io.IOException
public void saveContents(XMLWriter writer, XMLSerializationContext ctxt) throws java.io.IOException
java.io.IOException
public java.lang.String getLocation()
IConnection
getLocation
in interface IConnection
String
.public TableJoins getTableJoins()
IConnection
getTableJoins
in interface IConnection
ITableJoin
objectsITableJoin
public Tables getTables()
IConnection
IConnection.getTablesFetched()
to see if
these tables and TableLinks have been fetched from the server.
getTables
in interface IConnection
Tables
object.public boolean getTablesFetched()
IConnection
getTablesFetched
in interface IConnection
true
if the tables that belong to the connection have been fetched
from the server, and false
otherwise.public void setLocation(java.lang.String location)
IConnection
setLocation
in interface IConnection
location
- The location of the connection as a String
.public void setTableJoins(TableJoins TableJoins)
IConnection
setTableJoins
in interface IConnection
TableJoins
- a collection of ITableJoin
objectsITableJoin
public void setTables(Tables tables)
IConnection
IConnection.getTablesFetched()
to see if
these tables and TableLinks have been fetched from the server.
setTables
in interface IConnection
tables
- The tables as a Table
object.public void setTablesFetched(boolean tablesFetched)
IConnection
setTablesFetched
in interface IConnection
tablesFetched
- true
if the tables that belong to the connection have been
fetched from the server, and false
otherwise.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |