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

java.lang.Object
  extended by com.crystaldecisions.sdk.occa.report.data.FilterItem
All Implemented Interfaces:
IFilterItem, IClone
Direct Known Subclasses:
FieldRangeFilterItem, OperatorFilterItem

public abstract class FilterItem
extends java.lang.Object
implements IFilterItem, IClone

This abstract class is used to represent an item in a formula string. This is used as a base class for the FieldRangeFilterItem object and the OperatorFilterItem object.


Constructor Summary
FilterItem()
           
 
Method Summary
abstract  java.lang.Object clone(boolean deepClone)
           
abstract  java.lang.String computeText()
           Returns a String representation of the field value that can be used in a report formula.
abstract  void copyTo(java.lang.Object destObject, boolean deepCopy)
           
abstract  java.lang.String displayText(FieldDisplayNameType displayNameType, java.util.Locale locale)
           Returns the field's value as a localized and formatted string.
 void doControllerModification(java.lang.Object newObject)
           
 void enumerateMembers(IMemberVisitor visitor)
           
 ControllableMixin getControllableMixin()
           
 boolean isDirectlyControllable()
           
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

FilterItem

public FilterItem()
Method Detail

clone

public abstract java.lang.Object clone(boolean deepClone)

computeText

public abstract java.lang.String computeText()
Description copied from interface: IFilterItem

Returns a String representation of the field value that can be used in a report formula. The string is not formatted or localized. The syntax will always be Crystal syntax.

If the field contains a date, computeText returns Date(x, x, x); if it contains a date and time, computeText returns DateTime(x, x, x, x, x, x). However, when the date is 1900, 0, 1 (the Java start date), computeText returns Time(x, x, x). If you want to set a field to a time value only (that is, with no date), you should set the date to 1900, 0, 1, so that computeText will retrieve the correct information.

Specified by:
computeText in interface IFilterItem
Returns:
A String representation of the field value that can be used in a report formula.

copyTo

public abstract void copyTo(java.lang.Object destObject,
                            boolean deepCopy)

displayText

public abstract java.lang.String displayText(FieldDisplayNameType displayNameType,
                                             java.util.Locale locale)
Description copied from interface: IFilterItem

Returns the field's value as a localized and formatted string.

Specified by:
displayText in interface IFilterItem
Parameters:
displayNameType - How the field names in the filter should be formatted.
locale - The locale that is used to format the string. If this value is not specified and you are writing a Win32 application, the locale will be the user's default locale. If you are writing a thin client (a script that is running on a server) and this value is not specified, the server's default locale will be used.
Returns:
The field's value as a localized and formatted string.

getControllableMixin

public ControllableMixin getControllableMixin()

doControllerModification

public void doControllerModification(java.lang.Object newObject)

isDirectlyControllable

public boolean isDirectlyControllable()

enumerateMembers

public void enumerateMembers(IMemberVisitor visitor)