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

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

public class TableJoin
extends java.lang.Object
implements ITableJoin, IClone

This object implements a join between two tables. The tables may be in different databases. Fields from the one table (called the source table) and fields from the other table (called the target table) are used to join the two tables together.

When possible, use the ITableJoin interface to manipulate this object.


Constructor Summary
TableJoin()
          Creates a new TableJoin.
TableJoin(ITableJoin src)
          Copies of the given TableJoin.
 
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 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.
 ControllableMixin getControllableMixin()
          For internal use only.
 TableJoinEnforced getEnforceJoin()
          Returns the manner in which the tables are joined.
 FieldLinks getFieldLinks()
          Returns the collection of the field links in this table join.
 TableJoinOperator getJoinOperator()
          Returns the manner in which the tables are joined.
 java.lang.String getSourceTableAlias()
          Returns the source table's alias.
 java.lang.String getTargetTableAlias()
          Returns the target table's alias.
 boolean hasContent(java.lang.Object srcTableJoin)
           
 boolean isDirectlyControllable()
          For internal use only.
 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(XMLWriter writer, XMLSerializationContext ctxt)
          For internal use only.
 void setEnforceJoin(TableJoinEnforced enforceJoin)
          Sets the manner in which the tables are joined.
 void setFieldLinks(FieldLinks fieldLinks)
          Sets the collection of the field links in this table join.
 void setJoinOperator(TableJoinOperator joinOperator)
          Sets the manner in which the tables are joined.
 void setSourceTableAlias(java.lang.String srcTableAlias)
          Sets the source table's alias.
 void setTargetTableAlias(java.lang.String targetTableAlias)
          Sets the target table's alias.
 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

TableJoin

public TableJoin(ITableJoin src)
Copies of the given TableJoin. This method creates a deep copy of the src object.

Parameters:
src - the TableJoin to copy

TableJoin

public TableJoin()
Creates a new TableJoin.

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.


getJoinOperator

public TableJoinOperator getJoinOperator()
Description copied from interface: ITableJoin
Returns the manner in which the tables are joined.

Specified by:
getJoinOperator in interface ITableJoin
Returns:
A TableJoinOperator object that specifies the manner in which the tables are joined.
See Also:
TableJoinOperator

getFieldLinks

public FieldLinks getFieldLinks()
Description copied from interface: ITableJoin
Returns the collection of the field links in this table join.

Specified by:
getFieldLinks in interface ITableJoin
Returns:
An FieldLinks object containing the collection of the field links table to be linked.

getSourceTableAlias

public java.lang.String getSourceTableAlias()
Description copied from interface: ITableJoin
Returns the source table's alias.

Specified by:
getSourceTableAlias in interface ITableJoin
Returns:
A String containing the source table's alias.

getEnforceJoin

public TableJoinEnforced getEnforceJoin()
Description copied from interface: ITableJoin
Returns the manner in which the tables are joined.

Specified by:
getEnforceJoin in interface ITableJoin
Returns:
A TableJoinEnforced object that specifies the manner in which the tables are joined.
See Also:
TableJoinEnforced

getTargetTableAlias

public java.lang.String getTargetTableAlias()
Description copied from interface: ITableJoin
Returns the target table's alias.

Specified by:
getTargetTableAlias in interface ITableJoin
Returns:
A String containing the target table's alias.

hasContent

public boolean hasContent(java.lang.Object srcTableJoin)

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(XMLWriter writer,
                         XMLSerializationContext ctxt)
                  throws java.io.IOException
For internal use only.

Throws:
java.io.IOException

setJoinOperator

public void setJoinOperator(TableJoinOperator joinOperator)
Description copied from interface: ITableJoin
Sets the manner in which the tables are joined.

Specified by:
setJoinOperator in interface ITableJoin
Parameters:
joinOperator - A TableJoinOperator object that specifies the manner in which the tables are joined.

setFieldLinks

public void setFieldLinks(FieldLinks fieldLinks)
Description copied from interface: ITableJoin
Sets the collection of the field links in this table join.

Specified by:
setFieldLinks in interface ITableJoin
Parameters:
fieldLinks - An FieldLinks object containing the collection of the field links.

setSourceTableAlias

public void setSourceTableAlias(java.lang.String srcTableAlias)
Description copied from interface: ITableJoin
Sets the source table's alias.

Specified by:
setSourceTableAlias in interface ITableJoin
Parameters:
srcTableAlias - A String containing the source table's alias.

setEnforceJoin

public void setEnforceJoin(TableJoinEnforced enforceJoin)
Description copied from interface: ITableJoin
Sets the manner in which the tables are joined.

Specified by:
setEnforceJoin in interface ITableJoin
Parameters:
enforceJoin - A TableJoinEnforced object that specifies the manner in which the tables are joined.

setTargetTableAlias

public void setTargetTableAlias(java.lang.String targetTableAlias)
Description copied from interface: ITableJoin
Sets the target table's alias.

Specified by:
setTargetTableAlias in interface ITableJoin
Parameters:
targetTableAlias - A String containing the target table's alias.

startElement

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


getControllableMixin

public ControllableMixin getControllableMixin()
For internal use only.


doControllerModification

public void doControllerModification(java.lang.Object newObject)
                              throws ReportSDKException
For internal use only.

Throws:
ReportSDKException

isDirectlyControllable

public boolean isDirectlyControllable()
For internal use only.


enumerateMembers

public void enumerateMembers(IMemberVisitor visitor)
For internal use only.