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

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

public class ConnectionDirectory
extends java.lang.Object
implements IConnectionDirectory, IClone

This object is used to get and set information for a connection directory. ConnectionDirectoryItem objects can be passed as an argument to the getTables() method, which will in turn retrieve the item's database tables. When possible, use the IConnectionDirectory interface to manipulate this object.


Constructor Summary
ConnectionDirectory()
           
ConnectionDirectory(IConnectionDirectory 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, com.crystaldecisions.xml.serialization.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.
 java.lang.String getName()
          Returns the name of the connection directory.
 java.lang.String getRemoteID()
          Returns the ID of the remote connection directory.
 DirectoryItems getRoots()
          Retrieves the root items from each data source directory on the server.
 boolean hasContent(java.lang.Object obj)
           
 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(com.crystaldecisions.xml.serialization.XMLWriter writer, com.crystaldecisions.xml.serialization.XMLSerializationContext ctxt)
          For internal use only.
 void save(com.crystaldecisions.xml.serialization.XMLWriter writer, java.lang.String sTag, com.crystaldecisions.xml.serialization.XMLSerializationContext ctxt)
          For internal use only.
 void saveContents(com.crystaldecisions.xml.serialization.XMLWriter writer, com.crystaldecisions.xml.serialization.XMLSerializationContext ctxt)
          For internal use only.
 void setName(java.lang.String name)
          Sets the name of the connection directory.
 void setRemoteID(java.lang.String remoteID)
          Sets the ID of the remote connection directory.
 void setRoots(DirectoryItems items)
          Sets the root items from each data source directory on 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

ConnectionDirectory

public ConnectionDirectory(IConnectionDirectory src)

ConnectionDirectory

public ConnectionDirectory()
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,
                                     com.crystaldecisions.xml.serialization.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.


getName

public java.lang.String getName()
Description copied from interface: IConnectionDirectory

Returns the name of the connection directory.

Specified by:
getName in interface IConnectionDirectory
Returns:
The name of the connection directory as a String.

getRemoteID

public java.lang.String getRemoteID()
Description copied from interface: IConnectionDirectory

Returns the ID of the remote connection directory.

Specified by:
getRemoteID in interface IConnectionDirectory
Returns:
The ID of the remote connection directory as a String.

getRoots

public DirectoryItems getRoots()
Description copied from interface: IConnectionDirectory

Retrieves the root items from each data source directory on the server. This method gets the top-level nodes of the Connection Directory Manager. The returned objects are stored in the DirectoryItems collection.

Once the DirectoryItems have been retrieved, use the GetChildren Method to retrieve the child nodes of each item. If the DirectoryItem is a ConnectionDirectoryItem Object, then it can be passed as an argument to the getTables() method, which will in turn retrieve the item's database tables.

Specified by:
getRoots in interface IConnectionDirectory
Returns:
The root items from the data source directory on the server as a DirectoryItems object.

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(com.crystaldecisions.xml.serialization.XMLWriter writer,
                 com.crystaldecisions.xml.serialization.XMLSerializationContext ctxt)
          throws java.io.IOException

For internal use only.

Throws:
java.io.IOException

save

public void save(com.crystaldecisions.xml.serialization.XMLWriter writer,
                 java.lang.String sTag,
                 com.crystaldecisions.xml.serialization.XMLSerializationContext ctxt)
          throws java.io.IOException

For internal use only.

Throws:
java.io.IOException

saveContents

public void saveContents(com.crystaldecisions.xml.serialization.XMLWriter writer,
                         com.crystaldecisions.xml.serialization.XMLSerializationContext ctxt)
                  throws java.io.IOException

For internal use only.

Throws:
java.io.IOException

setName

public void setName(java.lang.String name)
Description copied from interface: IConnectionDirectory

Sets the name of the connection directory.

Specified by:
setName in interface IConnectionDirectory
Parameters:
name - The name of the connection directory as a String.

setRemoteID

public void setRemoteID(java.lang.String remoteID)
Description copied from interface: IConnectionDirectory

Sets the ID of the remote connection directory.

Specified by:
setRemoteID in interface IConnectionDirectory
Parameters:
remoteID - The ID of the remote connection directory as a String.

setRoots

public void setRoots(DirectoryItems items)
Description copied from interface: IConnectionDirectory

Sets the root items from each data source directory on the server. This method sets the top-level nodes of the Connection Directory Manager. The objects are stored in the DirectoryItems collection.

Once the DirectoryItems have been retrieved, use the ITotallerNode.getChildren() Method to retrieve the child nodes of each item. If the DirectoryItem is a ConnectionDirectoryItem object, then it can be passed as an argument to the GetTables Method, which will in turn retrieve the item's database tables.

Specified by:
setRoots in interface IConnectionDirectory
Parameters:
items - The root items form the data source directory on the server as a DirectoryItems object.

startElement

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

For internal use only.