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

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

public class FieldMappingInfo
extends java.lang.Object
implements IFieldMappingInfo, IClone

This object enables you to get and set mapping information for a database field. When the target field is null or an empty string, it means to drop the source field in report.

Whenever possible, use the IFieldMappingInfo interface.

See Also:
ITableChangeFeedback.getFieldMappingInfos()

Constructor Summary
FieldMappingInfo()
          Creates a new FieldMappingInfo object.
FieldMappingInfo(IFieldMappingInfo src)
          Copies a given IFieldMappingInfo object.
FieldMappingInfo(java.lang.String sourceField, java.lang.String targetField)
          Creates a new IFieldMappingInfo, initialized with the given source and target field names.
 
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 getReportName()
          Gets the name of the subreport that the field mapping applies to.
 java.lang.String getSourceField()
          Gets the source field of the field mapping.
 IConnectionInfo getTargetConnectionInfo()
          Gets information about the data source connection.
 java.lang.String getTargetField()
          Gets the target field of the field mapping.
 boolean hasContent(java.lang.Object obj)
           
 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 setReportName(java.lang.String reportName)
          Sets the name of the subreport that the field mapping applies to.
 void setSourceField(java.lang.String srcField)
          Sets the source field of the field mapping.
 void setTargetConnectionInfo(IConnectionInfo table)
          Sets the data source connection information.
 void setTargetField(java.lang.String targetField)
          Sets the target field of the field mapping.
 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

FieldMappingInfo

public FieldMappingInfo(IFieldMappingInfo src)
Copies a given IFieldMappingInfo object. This constructor makes a deep copy of the src object.

Parameters:
src - the object to copy

FieldMappingInfo

public FieldMappingInfo(java.lang.String sourceField,
                        java.lang.String targetField)
Creates a new IFieldMappingInfo, initialized with the given source and target field names.

Parameters:
sourceField - The source field name to use in the mapping.
targetField - The target field name to use in the mapping.

FieldMappingInfo

public FieldMappingInfo()
Creates a new FieldMappingInfo object.

Method Detail

getSourceField

public java.lang.String getSourceField()
Description copied from interface: IFieldMappingInfo
Gets the source field of the field mapping.

Specified by:
getSourceField in interface IFieldMappingInfo
Returns:
The name of the source field.

setSourceField

public void setSourceField(java.lang.String srcField)
Description copied from interface: IFieldMappingInfo
Sets the source field of the field mapping.

Specified by:
setSourceField in interface IFieldMappingInfo
Parameters:
srcField - The name of the source field.

getTargetField

public java.lang.String getTargetField()
Description copied from interface: IFieldMappingInfo
Gets the target field of the field mapping.

Specified by:
getTargetField in interface IFieldMappingInfo
Returns:
The name of the target field.

setTargetField

public void setTargetField(java.lang.String targetField)
Description copied from interface: IFieldMappingInfo
Sets the target field of the field mapping.

Specified by:
setTargetField in interface IFieldMappingInfo
Parameters:
targetField - The name of the target field.

getTargetConnectionInfo

public IConnectionInfo getTargetConnectionInfo()
Description copied from interface: IFieldMappingInfo
Gets information about the data source connection.

Specified by:
getTargetConnectionInfo in interface IFieldMappingInfo
Returns:
An IConnectionInfo describing the data source connection.

setTargetConnectionInfo

public void setTargetConnectionInfo(IConnectionInfo table)
Description copied from interface: IFieldMappingInfo
Sets the data source connection information.

Specified by:
setTargetConnectionInfo in interface IFieldMappingInfo
Parameters:
table - An IConnectionInfo describing the data source connection.

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.


hasContent

public boolean hasContent(java.lang.Object obj)

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

startElement

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


getReportName

public java.lang.String getReportName()
Description copied from interface: IFieldMappingInfo
Gets the name of the subreport that the field mapping applies to.

Specified by:
getReportName in interface IFieldMappingInfo
Returns:
The subreport name, which may be an empty string if the field mapping applies to the main report.

setReportName

public void setReportName(java.lang.String reportName)
Description copied from interface: IFieldMappingInfo
Sets the name of the subreport that the field mapping applies to.

Specified by:
setReportName in interface IFieldMappingInfo
Parameters:
reportName - A subreport name, or an empty string to specify the main report.