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

java.lang.Object
  extended by com.crystaldecisions.sdk.occa.report.data.Field
      extended by com.crystaldecisions.sdk.occa.report.data.DBField
All Implemented Interfaces:
IDBField, IField, IClone

public class DBField
extends Field
implements IDBField

This object represents a database field. Use the IDBField interface to manipulate this object.


Constructor Summary
DBField()
           
DBField(IDBField src)
           
 
Method Summary
 java.lang.Object clone(boolean deepClone)
           
 void copyTo(java.lang.Object destObject, boolean deepCopy)
           
 void doControllerModification(java.lang.Object newObject)
           
 void enumerateMembers(IMemberVisitor visitor)
           
 boolean getIsRecurring()
           Returns true if the field is recurring, and false otherwise.
 FieldKind getKind()
           Returns what kind of field this is.
 java.lang.String getLongName(java.util.Locale locale)
           Returns the fully qualified name of the field.
 java.lang.String getTableAlias()
          Returns the alias that is used to identify the table.
 boolean hasContent(java.lang.Object srcField)
           
 boolean isDirectlyControllable()
           
 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 setTableAlias(java.lang.String tableAlias)
          Sets the alias that is used to identify the table.
 
Methods inherited from class com.crystaldecisions.sdk.occa.report.data.Field
createMember, endElement, getAttributes, getControllableMixin, getDescription, getDisplayName, getFormulaForm, getHeadingText, getIsPrintTime, getLength, getName, getShortName, getType, setAttributes, setDescription, setHeadingText, setLength, setName, setType, startElement
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.crystaldecisions.sdk.occa.report.data.IDBField
getHeadingText, setHeadingText
 
Methods inherited from interface com.crystaldecisions.sdk.occa.report.data.IField
getDescription, getDisplayName, getFormulaForm, getLength, getName, getShortName, getType, setDescription, setLength, setName, setType
 

Constructor Detail

DBField

public DBField(IDBField src)

DBField

public DBField()
Method Detail

clone

public java.lang.Object clone(boolean deepClone)
Overrides:
clone in class Field

copyTo

public void copyTo(java.lang.Object destObject,
                   boolean deepCopy)
Overrides:
copyTo in class Field

getIsRecurring

public boolean getIsRecurring()
Description copied from interface: IField

Returns true if the field is recurring, and false otherwise. A field is recurring if its contents change during the formatting of a report. A constant field (not recurring) is one that doesn't change. The special field "Page Number," for example, is a recurring field, while the special field "Report Title" is not.

Specified by:
getIsRecurring in interface IField
Overrides:
getIsRecurring in class Field
Returns:
true if the field is recurring, and false otherwise.

getKind

public FieldKind getKind()
Description copied from interface: IField

Returns what kind of field this is. Do not confuse this property with Type. Kind identifies what sort of report field this is, while Type identifies what the field is composed of. For example, a bitmap, string, chart, number, date, and so on.

Specified by:
getKind in interface IField
Returns:
A String that specifies what kind of field this is.

getLongName

public java.lang.String getLongName(java.util.Locale locale)
Description copied from interface: IField

Returns the fully qualified name of the field.

Specified by:
getLongName in interface IField
Overrides:
getLongName in class Field
Parameters:
locale - The locale that will be used to localize the field.
Returns:
A String containing the fully qualified name of the field.

getTableAlias

public java.lang.String getTableAlias()
Description copied from interface: IDBField

Returns the alias that is used to identify the table.

Specified by:
getTableAlias in interface IDBField
Returns:
The table alias as a String.

hasContent

public boolean hasContent(java.lang.Object srcField)
Overrides:
hasContent in class Field

readElement

public void readElement(java.lang.String eleName,
                        java.lang.String sVal,
                        org.xml.sax.Attributes attrs,
                        java.util.Map objState)
Description copied from class: Field

For internal use only.

Overrides:
readElement in class Field

save

public void save(com.crystaldecisions.xml.serialization.XMLWriter writer,
                 com.crystaldecisions.xml.serialization.XMLSerializationContext ctxt)
          throws java.io.IOException
Description copied from class: Field

For internal use only.

Overrides:
save in class Field
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
Description copied from class: Field

For internal use only.

Overrides:
save in class Field
Throws:
java.io.IOException

saveContents

public void saveContents(XMLWriter writer,
                         XMLSerializationContext ctxt)
                  throws java.io.IOException
Description copied from class: Field

For internal use only.

Overrides:
saveContents in class Field
Throws:
java.io.IOException

setTableAlias

public void setTableAlias(java.lang.String tableAlias)
Description copied from interface: IDBField

Sets the alias that is used to identify the table.

Specified by:
setTableAlias in interface IDBField
Parameters:
tableAlias - The table alias as a String.

doControllerModification

public void doControllerModification(java.lang.Object newObject)
                              throws ReportSDKException
Throws:
ReportSDKException

isDirectlyControllable

public boolean isDirectlyControllable()

enumerateMembers

public void enumerateMembers(IMemberVisitor visitor)