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

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<IFieldLink>
                          extended by com.crystaldecisions.sdk.occa.report.data.FieldLinks
All Implemented Interfaces:
IClone, java.io.Serializable, java.lang.Cloneable, java.lang.Iterable<IFieldLink>, java.util.Collection<IFieldLink>, java.util.List<IFieldLink>, java.util.RandomAccess

public class FieldLinks
extends ReportSDKVector<IFieldLink>
implements IClone

A collection of IFieldLink objects that represents the fields used to link two tables in a join operation.

See Also:
TableJoin.setFieldLinks(FieldLinks), Serialized Form

Constructor Summary
FieldLinks()
          Creates an empty FieldLinks collection.
FieldLinks(FieldLinks src)
          Copies the specified FieldLinks collection.
 
Method Summary
 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 fromFieldName, java.lang.String toFieldName)
          Returns the index of an IFieldLink in the collection that has the specified source and target field names.
 IFieldLink getFieldLink(int index)
          Returns the IFieldLink 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, 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

FieldLinks

public FieldLinks(FieldLinks src)
Copies the specified FieldLinks collection. This method creates a deep copy of the src collection.

Parameters:
src - The collection to copy.

FieldLinks

public FieldLinks()
Creates an empty FieldLinks 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<IFieldLink>

endElement

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

Overrides:
endElement in class ClonableList<IFieldLink>

find

public int find(java.lang.String fromFieldName,
                java.lang.String toFieldName)
Returns the index of an IFieldLink in the collection that has the specified source and target field names.

Parameters:
fromFieldName - The source field name to search for.
toFieldName - The target field name to search for.
Returns:
An int specifying the index of an IFieldLink in the collection, or -1 if one could not be found that matches the search criteria.

getFieldLink

public IFieldLink getFieldLink(int index)
Returns the IFieldLink object at the specified index.

Parameters:
index - The index of the desired IFieldLink object.
Returns:
The IFieldLink 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<IFieldLink>

save

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

Overrides:
save in class ClonableList<IFieldLink>
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<IFieldLink>
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<IFieldLink>
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<IFieldLink>

isDirectlyControllable

public boolean isDirectlyControllable()
For internal use only.

Overrides:
isDirectlyControllable in class ReportSDKVector<IFieldLink>