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

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

public class ConnectionInfo
extends java.lang.Object
implements IConnectionInfo, IClone

This object enables you to get and set properties of a data source connection. The properties may include logon credentials, a connection type (such as SQL, database file, or Crystal Report Query Engine), the database DLL or a connection string, among others.

Whenever possible, use the IConnectionInfo interface to manipulate this object.

See Also:
IConnection.setConnectionInfo(IConnectionInfo)

Constructor Summary
ConnectionInfo()
           
ConnectionInfo(IConnectionInfo 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)
          For internal use only.
 void endElement(java.lang.String eleName, java.util.Map objState)
          For internal use only.
 PropertyBag getAttributes()
          Gets additional properties of the data source connection.
 java.lang.String getDatabaseName()
          For internal use only.
 PropertyBag getDetailAttributes()
          For internal use only.
 ConnectionInfoKind getKind()
          Returns the kind of connection.
 java.lang.String getPassword()
          Returns the password used to connect to the data source.
 java.lang.String getServerName()
          For internal use only.
 java.lang.String getUserName()
          Returns the user name used to connect to the data source.
 boolean hasContent(java.lang.Object obj)
           
 boolean isMatch(IConnectionInfo info, boolean completeMatching)
          Checks to see if two IConnectionInfo objects match.
 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 setAttributes(PropertyBag attributes)
          Sets additional properties for the data source connection.
 void setDetailAttributes(PropertyBag detailAttributes)
          For internal use only.
 void setKind(ConnectionInfoKind kind)
          Sets the kind of connection.
 void setPassword(java.lang.String password)
          Sets the password used to connect to the data source.
 void setUserName(java.lang.String userName)
          Sets the user name used to connect to the data source.
 boolean skipWritingIdenticalObject()
          For internal use only.
 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

ConnectionInfo

public ConnectionInfo(IConnectionInfo src)

ConnectionInfo

public ConnectionInfo()
Method Detail

clone

public java.lang.Object clone(boolean deepClone)

copyTo

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

createMember

public 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.


endElement

public void endElement(java.lang.String eleName,
                       java.util.Map objState)
For internal use only.


getAttributes

public PropertyBag getAttributes()
Description copied from interface: IConnectionInfo
Gets additional properties of the data source connection. These properties may include the database DLL name, a database name or a connection string, among others.

Specified by:
getAttributes in interface IConnectionInfo
Returns:
The properties as a PropertyBag object.
See Also:
PropertyBagHelper.CONNINFO_*

getKind

public ConnectionInfoKind getKind()
Description copied from interface: IConnectionInfo
Returns the kind of connection. For example, connection kinds include SQL, query, metadata, database file, and Crystal Report Query Engine (CRQE).

Specified by:
getKind in interface IConnectionInfo
Returns:
The connection kind as a ConnectionInfoKind object.
See Also:
ConnectionInfoKind

getPassword

public java.lang.String getPassword()
Description copied from interface: IConnectionInfo
Returns the password used to connect to the data source.

Specified by:
getPassword in interface IConnectionInfo
Returns:
The password as a String.

getUserName

public java.lang.String getUserName()
Description copied from interface: IConnectionInfo
Returns the user name used to connect to the data source.

Specified by:
getUserName in interface IConnectionInfo
Returns:
The user name as a String.

hasContent

public boolean hasContent(java.lang.Object obj)

readElement

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


save

public void save(XMLWriter writer,
                 XMLSerializationContext ctxt)
          throws java.io.IOException
For internal use only.

Throws:
java.io.IOException

save

public void save(XMLWriter writer,
                 java.lang.String sTag,
                 XMLSerializationContext ctxt)
          throws java.io.IOException
For internal use only.

Throws:
java.io.IOException

saveContents

public void saveContents(XMLWriter writer,
                         XMLSerializationContext ctxt)
                  throws java.io.IOException
For internal use only.

Throws:
java.io.IOException

setAttributes

public void setAttributes(PropertyBag attributes)
Description copied from interface: IConnectionInfo
Sets additional properties for the data source connection. These properties may include the database DLL name, a database name or a connection string, among others.

Specified by:
setAttributes in interface IConnectionInfo
Parameters:
attributes - The properties as a PropertyBag object.
See Also:
PropertyBagHelper.CONNINFO_*

setKind

public void setKind(ConnectionInfoKind kind)
Description copied from interface: IConnectionInfo
Sets the kind of connection. For example, connection kinds include SQL, query, metadata, database file, and Crystal Report Query Engine (CRQE).

Specified by:
setKind in interface IConnectionInfo
Parameters:
kind - The connection kind as a ConnectionInfoKind object.
See Also:
ConnectionInfoKind

setPassword

public void setPassword(java.lang.String password)
Description copied from interface: IConnectionInfo
Sets the password used to connect to the data source.

Specified by:
setPassword in interface IConnectionInfo
Parameters:
password - The password as a String.

setUserName

public void setUserName(java.lang.String userName)
Description copied from interface: IConnectionInfo
Sets the user name used to connect to the data source.

Specified by:
setUserName in interface IConnectionInfo
Parameters:
userName - The user name as a String.

startElement

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


skipWritingIdenticalObject

public boolean skipWritingIdenticalObject()
For internal use only.


isMatch

public boolean isMatch(IConnectionInfo info,
                       boolean completeMatching)
Description copied from interface: IConnectionInfo

Checks to see if two IConnectionInfo objects match.

If complateMatching is true, all members of the object are compared. When all members of the object have been compared, a value of true is returned if all members are exactly the same. If set to false, all members of the object are compared and a value of true is returned if the mismatch is caused by one of the comparing members having an empty string and all of the remaining kinds of members match. If strings are being compared, the comparison is not case sensitive.

Specified by:
isMatch in interface IConnectionInfo
Parameters:
info - the IConnectionInfo object that is compared to the one you are using.
completeMatching - defaults to true
Returns:
dependent on conditions described above

getServerName

public java.lang.String getServerName()
For internal use only.


getDatabaseName

public java.lang.String getDatabaseName()
For internal use only.


getDetailAttributes

public PropertyBag getDetailAttributes()
For internal use only.


setDetailAttributes

public void setDetailAttributes(PropertyBag detailAttributes)
For internal use only.