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

java.lang.Object
  extended by java.util.AbstractCollection<E>
      extended by java.util.AbstractList<E>
          extended by java.util.ArrayList<E>
              extended by com.crystaldecisions.sdk.occa.report.lib.ClonableList<E>
                  extended by com.crystaldecisions.sdk.occa.report.lib.ControllableList<E>
                      extended by com.crystaldecisions.sdk.occa.report.lib.ReportSDKVector<ITableJoin>
                          extended by com.crystaldecisions.sdk.occa.report.data.TableJoins
All Implemented Interfaces:
IClone, java.io.Serializable, java.lang.Cloneable, java.lang.Iterable<ITableJoin>, java.util.Collection<ITableJoin>, java.util.List<ITableJoin>, java.util.RandomAccess

public class TableJoins
extends ReportSDKVector<ITableJoin>
implements IClone

A collection of TableJoin objects that represents how tables are linked in a report.

See Also:
Serialized Form

Constructor Summary
TableJoins()
          Constructs an empty TableJoins collection.
TableJoins(TableJoins src)
          Constructs a copy of a TableJoins collection.
 
Method Summary
 void add(int index, ITableJoin element)
          Inserts an ITableJoin element at the specified index in the collection.
 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.
 int find(java.lang.String sourceTableAlias, java.lang.String targetTableAlias, boolean anyDirection)
          Returns the index of a TableJoin object, or -1 if the TableJoin is not found.
 ITableJoin getTableJoin(int index)
          Returns the ITableJoin object at the specified index.
 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(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 startElement(java.lang.String eleName, java.util.Map objState, org.xml.sax.Attributes attrs)
          For internal use only.
 
Methods inherited from class com.crystaldecisions.sdk.occa.report.lib.ReportSDKVector
add, addElement, elementAt, insertElementAt, removeAllElements
 
Methods inherited from class com.crystaldecisions.sdk.occa.report.lib.ControllableList
addAll, addAll, clear, copyTo, doControllerModification, enumerateMembers, getControllableMixin, iterator, listIterator, listIterator, remove, remove, removeAll, retainAll, set, subList
 
Methods inherited from class com.crystaldecisions.sdk.occa.report.lib.ClonableList
clone, findIndexOf, hasContent
 
Methods inherited from class java.util.ArrayList
clone, contains, ensureCapacity, get, indexOf, isEmpty, lastIndexOf, size, toArray, toArray, trimToSize
 
Methods inherited from class java.util.AbstractList
equals, hashCode
 
Methods inherited from class java.util.AbstractCollection
containsAll, toString
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface java.util.List
containsAll, equals, hashCode
 

Constructor Detail

TableJoins

public TableJoins(TableJoins src)
Constructs a copy of a TableJoins collection. This method creates a deep copy of the src collection.

Parameters:
src - the TableJoins collection to copy

TableJoins

public TableJoins()
Constructs an empty TableJoins collection.

Method Detail

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.

Overrides:
createMember in class ClonableList<ITableJoin>

endElement

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

Overrides:
endElement in class ClonableList<ITableJoin>

find

public int find(java.lang.String sourceTableAlias,
                java.lang.String targetTableAlias,
                boolean anyDirection)
Returns the index of a TableJoin object, or -1 if the TableJoin is not found. If the anyDirection parameter is set to true, this method will search for joins from the source table to the target table as well as joins from the target table to the source table. If anyDirection is set to false, this method will only search joins from the source table to the target table.

Parameters:
sourceTableAlias - the alias of the source table of the TableJoin
targetTableAlias - the alias of the target table of the TableJoin
anyDirection - true to search joins in both directions, false to search only from source to target
Returns:
the index of the TableJoin object, or -1 if the TableJoin is not found

getTableJoin

public ITableJoin getTableJoin(int index)
Returns the ITableJoin object at the specified index.

Parameters:
index - the index of the ITableJoin object
Returns:
the ITableJoin object at the specified index

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.

Overrides:
readElement in class ClonableList<ITableJoin>

save

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

Overrides:
save in class ClonableList<ITableJoin>
Throws:
java.io.IOException

save

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

Overrides:
save in class ClonableList<ITableJoin>
Throws:
java.io.IOException

saveContents

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

Overrides:
saveContents in class ClonableList<ITableJoin>
Throws:
java.io.IOException

startElement

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

Overrides:
startElement in class ClonableList<ITableJoin>

add

public void add(int index,
                ITableJoin element)
Inserts an ITableJoin element at the specified index in the collection. When an object is added to the middle of a collection, the existing elements are shifted and their indexes are incremented by one.

Specified by:
add in interface java.util.List<ITableJoin>
Overrides:
add in class ReportSDKVector<ITableJoin>
Parameters:
index - the index to insert the element at
element - the element to be insert
Throws:
java.lang.NullPointerException - if the element is null

isDirectlyControllable

public boolean isDirectlyControllable()
For internal use only.

Overrides:
isDirectlyControllable in class ReportSDKVector<ITableJoin>