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

java.lang.Object
  extended by com.crystaldecisions.sdk.occa.report.data.Table
All Implemented Interfaces:
ITable, IClone
Direct Known Subclasses:
Procedure

public class Table
extends java.lang.Object
implements ITable, IClone

This object implements a table from a database. The data contained in the table may be accessed through the getDataFields method. When possible, use the ITable interface to manipulate this object.


Constructor Summary
Table()
          Constructor for a Table object.
Table(ITable src)
          Constructor for a Table object that creates a copy of an ITable object.
 
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.
 java.lang.String getAlias()
           Returns the alias that is used to identify the table.
 IConnection getConnection()
          For internal use only
 IConnectionInfo getConnectionInfo()
           Returns information about the connection to the database that the table belongs to.
 Fields getDataFields()
           Returns the data fields that the table contains.
 java.lang.String getDescription()
           Returns a description of the table.
 Indexes getIndexes()
          For internal use only
 boolean getIsLinkable()
          For internal use only
 java.lang.String getName()
           Returns the name of the table.
 java.lang.String getQualifiedName()
           Returns the fully qualified name of the table.
 boolean hasContent(java.lang.Object srcTable)
           
 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 setAlias(java.lang.String alias)
           Sets the alias that is used to identify the table.
 void setConnection(IConnection connection)
          For internal use only
 void setConnectionInfo(IConnectionInfo connectionInfo)
           Sets information about the connection to the database that the table belongs to.
 void setDataFields(Fields dataFields)
           Sets the data fields that the table contains.
 void setDescription(java.lang.String description)
           Sets the description of the table.
 void setIndexes(Indexes indexes)
          For internal use only
 void setIsLinkable(boolean isLinkable)
          For internal use only
 void setName(java.lang.String name)
           Sets the name of the table.
 void setQualifiedName(java.lang.String qualifiedName)
           Sets the fully qualified name of the table.
 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

Table

public Table(ITable src)
Constructor for a Table object that creates a copy of an ITable object.

Parameters:
src - the table to copy

Table

public Table()
Constructor for a Table object.

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.


getAlias

public java.lang.String getAlias()
Description copied from interface: ITable

Returns the alias that is used to identify the table. The alias may be different than the name of the table.

Specified by:
getAlias in interface ITable
Returns:
A String containing the alias that is used to identify the table.

getConnectionInfo

public IConnectionInfo getConnectionInfo()
Description copied from interface: ITable

Returns information about the connection to the database that the table belongs to.

Specified by:
getConnectionInfo in interface ITable
Returns:
An IConnectionInfo object that contains information about the connection to the database that the table belongs to.

getDataFields

public Fields getDataFields()
Description copied from interface: ITable

Returns the data fields that the table contains.

Specified by:
getDataFields in interface ITable
Returns:
A Fields object containing the data fields that the table contains.

getDescription

public java.lang.String getDescription()
Description copied from interface: ITable

Returns a description of the table.

Specified by:
getDescription in interface ITable
Returns:
A String containing a description of the table.

getName

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

Returns the name of the table.

Specified by:
getName in interface ITable
Returns:
A String containing the name of the table.

getQualifiedName

public java.lang.String getQualifiedName()
Description copied from interface: ITable

Returns the fully qualified name of the table.

Specified by:
getQualifiedName in interface ITable
Returns:
A String containing the fully qualified name of the table.

getIndexes

public Indexes getIndexes()
Description copied from interface: ITable
For internal use only

Specified by:
getIndexes in interface ITable

hasContent

public boolean hasContent(java.lang.Object srcTable)

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

setAlias

public void setAlias(java.lang.String alias)
Description copied from interface: ITable

Sets the alias that is used to identify the table. This may not be the same as the name of the table.

Specified by:
setAlias in interface ITable
Parameters:
alias - A String containing the alias that is used to identify the table.

setConnectionInfo

public void setConnectionInfo(IConnectionInfo connectionInfo)
Description copied from interface: ITable

Sets information about the connection to the database that the table belongs to.

Specified by:
setConnectionInfo in interface ITable
Parameters:
connectionInfo - An IConnectionInfo object that contains information about the connection to the database that the table belongs to.

setDataFields

public void setDataFields(Fields dataFields)
Description copied from interface: ITable

Sets the data fields that the table contains.

Specified by:
setDataFields in interface ITable
Parameters:
dataFields - A Fields object containing the data fields that the table contains.

setDescription

public void setDescription(java.lang.String description)
Description copied from interface: ITable

Sets the description of the table.

Specified by:
setDescription in interface ITable
Parameters:
description - A String containing a description of the table.

setName

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

Sets the name of the table.

Specified by:
setName in interface ITable
Parameters:
name - A String containing the name of the table.

setQualifiedName

public void setQualifiedName(java.lang.String qualifiedName)
Description copied from interface: ITable

Sets the fully qualified name of the table.

Specified by:
setQualifiedName in interface ITable
Parameters:
qualifiedName - A String containing the fully qualified name of the table.

startElement

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

For internal use only.


setIndexes

public void setIndexes(Indexes indexes)
Description copied from interface: ITable
For internal use only

Specified by:
setIndexes in interface ITable

getConnection

public IConnection getConnection()
For internal use only

Specified by:
getConnection in interface ITable

setConnection

public void setConnection(IConnection connection)
For internal use only

Specified by:
setConnection in interface ITable

getIsLinkable

public boolean getIsLinkable()
Description copied from interface: ITable
For internal use only

Specified by:
getIsLinkable in interface ITable

setIsLinkable

public void setIsLinkable(boolean isLinkable)
Description copied from interface: ITable
For internal use only

Specified by:
setIsLinkable in interface ITable