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

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

public class FieldLink
extends java.lang.Object
implements IFieldLink, IClone

This object implements a link between two fields in a table join. The tables may be in different databases. The from field in the source table and the to field in the target table are used to specify one link in a TableJoin.

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

See Also:
TableJoin.setFieldLinks(FieldLinks)

Constructor Summary
FieldLink()
          Creates a new FieldLink.
FieldLink(IFieldLink src)
          Copies the given FieldLink 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 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.
 IField getFromField()
          Returns the from field of the link.
 FieldLinkOperator getLinkOperator()
          Returns the manner in which the tables are joined.
 IField getToField()
          Returns the to field of the link.
 boolean hasContent(java.lang.Object srcFieldLink)
           
 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 setFromField(IField fromField)
          Sets the from field of the link.
 void setLinkOperator(FieldLinkOperator linkOperator)
          Sets the manner in which the tables are joined.
 void setToField(IField toField)
          Sets the to field of the link.
 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

FieldLink

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

Parameters:
src - the IFieldLink to copy

FieldLink

public FieldLink()
Creates a new FieldLink.

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.


getLinkOperator

public FieldLinkOperator getLinkOperator()
Description copied from interface: IFieldLink
Returns the manner in which the tables are joined.

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

getFromField

public IField getFromField()
Description copied from interface: IFieldLink
Returns the from field of the link.

Specified by:
getFromField in interface IFieldLink
Returns:
A String containing the from field of the link.

getToField

public IField getToField()
Description copied from interface: IFieldLink
Returns the to field of the link.

Specified by:
getToField in interface IFieldLink
Returns:
A IField containing the to field of the link.

hasContent

public boolean hasContent(java.lang.Object srcFieldLink)

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

setLinkOperator

public void setLinkOperator(FieldLinkOperator linkOperator)
Description copied from interface: IFieldLink
Sets the manner in which the tables are joined.

Specified by:
setLinkOperator in interface IFieldLink
Parameters:
linkOperator - A FieldLinkOperator object that specifies the manner in which the tables are joined.

setFromField

public void setFromField(IField fromField)
Description copied from interface: IFieldLink
Sets the from field of the link.

Specified by:
setFromField in interface IFieldLink
Parameters:
fromField - A IField containing the from field of the link.

setToField

public void setToField(IField toField)
Description copied from interface: IFieldLink
Sets the to field of the link.

Specified by:
setToField in interface IFieldLink
Parameters:
toField - A IField containing the to field of the link.

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)
For internal use only.


isDirectlyControllable

public boolean isDirectlyControllable()
For internal use only.


enumerateMembers

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