com.crystaldecisions.sdk.occa.report.data
Class Connection

java.lang.Object
  extended by com.crystaldecisions.sdk.occa.report.data.Connection
All Implemented Interfaces:
IConnection, IClone

public class Connection
extends java.lang.Object
implements IConnection, IClone

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.


Constructor Summary
Connection()
           
Connection(IConnection src)
           
 
Method Summary
 java.lang.Object clone(boolean deepClone)
           
 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)
           
 void endElement(java.lang.String eleName, java.util.Map objState)
           
 IConnectionInfo getConnectionInfo()
          For internal use only
 java.lang.String getDescription()
          For internal use only
 java.lang.String getLocation()
          The location of the connection (for example, a URI).
 java.lang.String getName()
          Gets the connection name.
 NavigationHierarchyNodes getNavigationHierarchyNodes()
          For internal use only
 Fields getParameters()
          For internal use only
 TableLinks getTableLinks()
          Returns the links between the tables that belong to the connection.
 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 isMatch(IConnection connection_, boolean completeMatching)
          For internal use only.
 void readElement(java.lang.String eleName, java.lang.String sVal, org.xml.sax.Attributes attrs, java.util.Map objState)
           
 void save(XMLWriter writer, java.lang.String sTag, XMLSerializationContext ctxt)
           
 void save(XMLWriter writer, XMLSerializationContext ctxt)
           
 void saveContents(XMLWriter writer, XMLSerializationContext ctxt)
           
 void setConnectionInfo(IConnectionInfo connectionInfo)
          For internal use only
 void setDescription(java.lang.String description)
          For internal use only
 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 setNavigationHierarchyNodes(NavigationHierarchyNodes navigationHierarchyNodes)
          For internal use only
 void setParameters(Fields parameters)
          For internal use only
 void setTableLinks(TableLinks tableLinks)
          Sets the links between the tables that belong to the connection.
 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)
           
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Connection

public Connection(IConnection src)

Connection

public Connection()
Method Detail

getConnectionInfo

public IConnectionInfo getConnectionInfo()
Description copied from interface: IConnection
For internal use only

Specified by:
getConnectionInfo in interface IConnection

setConnectionInfo

public void setConnectionInfo(IConnectionInfo connectionInfo)
Description copied from interface: IConnection
For internal use only

Specified by:
setConnectionInfo in interface IConnection

getDescription

public java.lang.String getDescription()
Description copied from interface: IConnection
For internal use only

Specified by:
getDescription in interface IConnection

setDescription

public void setDescription(java.lang.String description)
Description copied from interface: IConnection
For internal use only

Specified by:
setDescription in interface IConnection

getName

public java.lang.String getName()
Description copied from interface: IConnection
Gets the connection name.

Specified by:
getName in interface IConnection
Returns:
the name of this data source connection

setName

public void setName(java.lang.String name)
Description copied from interface: IConnection
Sets the connection name.

Specified by:
setName in interface IConnection
Parameters:
name - the name for the data source connection

getParameters

public Fields getParameters()
Description copied from interface: IConnection
For internal use only

Specified by:
getParameters in interface IConnection

setParameters

public void setParameters(Fields parameters)
Description copied from interface: IConnection
For internal use only

Specified by:
setParameters in interface IConnection

isMatch

public boolean isMatch(IConnection connection_,
                       boolean completeMatching)
For internal use only.


clone

public java.lang.Object clone(boolean deepClone)

copyTo

public void copyTo(java.lang.Object destObject,
                   boolean deepCopy)

hasContent

public boolean hasContent(java.lang.Object srcCon)

createMember

public java.lang.Object createMember(java.lang.String eleName,
                                     org.xml.sax.Attributes attrs,
                                     XMLSerializationContext ctxt,
                                     java.util.Map objState,
                                     boolean[] bLoaded)

endElement

public void endElement(java.lang.String eleName,
                       java.util.Map objState)

startElement

public void startElement(java.lang.String eleName,
                         java.util.Map objState,
                         org.xml.sax.Attributes attrs)

readElement

public void readElement(java.lang.String eleName,
                        java.lang.String sVal,
                        org.xml.sax.Attributes attrs,
                        java.util.Map objState)

save

public void save(XMLWriter writer,
                 XMLSerializationContext ctxt)
          throws java.io.IOException
Throws:
java.io.IOException

save

public void save(XMLWriter writer,
                 java.lang.String sTag,
                 XMLSerializationContext ctxt)
          throws java.io.IOException
Throws:
java.io.IOException

saveContents

public void saveContents(XMLWriter writer,
                         XMLSerializationContext ctxt)
                  throws java.io.IOException
Throws:
java.io.IOException

getLocation

public java.lang.String getLocation()
Description copied from interface: IConnection
The location of the connection (for example, a URI).

Specified by:
getLocation in interface IConnection
Returns:
The location of the connection as a String.

getTableLinks

public TableLinks getTableLinks()
Description copied from interface: IConnection

Returns the links between the tables that belong to the connection. Use IConnection.getTablesFetched() to see if these tables and TableLinks have been fetched from the server.

Specified by:
getTableLinks in interface IConnection
Returns:
The table links as a TableLinks object.
See Also:
ITableLink

getTables

public Tables getTables()
Description copied from interface: IConnection
Returns the tables that belong to the connection. Use IConnection.getTablesFetched() to see if these tables and TableLinks have been fetched from the server.

Specified by:
getTables in interface IConnection
Returns:
The tables as a Tables object.

getTablesFetched

public boolean getTablesFetched()
Description copied from interface: IConnection
Returns whether the tables that belong to the connection have been fetched from the server.

Specified by:
getTablesFetched in interface IConnection
Returns:
true if the tables that belong to the connection have been fetched from the server, and false otherwise.

setLocation

public void setLocation(java.lang.String location)
Description copied from interface: IConnection
The location of the connection (for example, a URI).

Specified by:
setLocation in interface IConnection
Parameters:
location - The location of the connection as a String.

setTableLinks

public void setTableLinks(TableLinks tableLinks)
Description copied from interface: IConnection

Sets the links between the tables that belong to the connection. Use IConnection.getTablesFetched() to see if these tables and TableLinks have been fetched from the server.

Specified by:
setTableLinks in interface IConnection
Parameters:
tableLinks - The table links as a TableLinks object.
See Also:
ITableLink

setTables

public void setTables(Tables tables)
Description copied from interface: IConnection
Returns the tables that belong to the connection. Use IConnection.getTablesFetched() to see if these tables and TableLinks have been fetched from the server.

Specified by:
setTables in interface IConnection
Parameters:
tables - The tables as a Table object.

setTablesFetched

public void setTablesFetched(boolean tablesFetched)
Description copied from interface: IConnection
Sets whether the tables that belong to the connection have been fetched from the server.

Specified by:
setTablesFetched in interface IConnection
Parameters:
tablesFetched - true if the tables that belong to the connection have been fetched from the server, and false otherwise.

getNavigationHierarchyNodes

public NavigationHierarchyNodes getNavigationHierarchyNodes()
Description copied from interface: IConnection
For internal use only

Specified by:
getNavigationHierarchyNodes in interface IConnection

setNavigationHierarchyNodes

public void setNavigationHierarchyNodes(NavigationHierarchyNodes navigationHierarchyNodes)
Description copied from interface: IConnection
For internal use only

Specified by:
setNavigationHierarchyNodes in interface IConnection