com.crystaldecisions.sdk.occa.report.data
Interface IDataDefinition

All Superinterfaces:
IClone
All Known Implementing Classes:
DataDefinition

public interface IDataDefinition
extends IClone

This interface provides access the document's DataDefinition. The DataDefinition contains all the fields and groups in the report. This is used to define the structure of the data that is being retrieved from the database. In order to modify any part of the report's data definition, you must access the DataDefinition object through the DataDefController object. If you want to access the DataDefinition only to read it, you can also use the ReportClientDocument object.

The following table shows the differences in behavior associated with the different report filters:

Record Filter Saved Data Filter Group Filter
Can refer to the summary? No. Yes. Yes.
When is the formula evaluated? While reading records. If a summary is used, at print time; otherwise, while reading records. At print time.
When is the report refreshed? If the evaluation result is false, when records are dropped. If records are being read, when evaluated. If the evaluation result is false, when records are dropped. N/A
Affects summary calculation? Yes, records that are filtered out are not counted. If the filter is evaluated while reading records, then no; otherwise, yes. No, records are counted even when they are filtered out.


Method Summary
 Alerts getAlerts()
          For internal use only
 Fields getBurstingIndexes()
          For internal use only
 CustomFunctions getCustomFunctions()
          For internal use only
 Fields getFormulaFields()
           Returns an object that contains a list of all the formula fields in the report.
 IFilter getGroupFilter()
           Returns the filter that indicates how groups are filtered in the report.
 Groups getGroups()
           Returns an object that indicates how data is grouped in the report.
 Fields getParameterFields()
           Returns an object that contains the parameters in the report.
 java.util.List getParameterGroups()
          For internal use only
 IFilter getRecordFilter()
           Returns the filter that determines which records should be retrieved from the database when data is retrieved.
 Sorts getRecordSorts()
          Returns an object that indicates how records are sorted once they are retrieved from the database.
 Fields getResultFields()
           Returns an object that contains the result fields in the report.
 Fields getRunningTotalFields()
          For internal use only
 IFilter getSavedDataFilter()
           Returns the filter that allows users to view a subset of the data saved in a report.
 Sorts getSorts()
          Deprecated. As of version 4.0. For record sorts, replaced by IDataDefinition.getRecordSorts(). For group sorts, replaced by IDataDefinition.getGroups() and IGroup.getSort().
 SummaryFields getSummaryFields()
           Returns an object that contains a list of the summaries in the report.
 IFilter getViewTimeFilter()
          For internal use only
 void setBurstingIndexes(Fields fieldsToIndex)
          For internal use only
 void setFormulaFields(Fields formulaFields)
           Sets an object that contains a list of all the formula fields in the report.
 void setGroupFilter(IFilter groupFilter)
           Sets the filter that indicates how groups are filtered in the report.
 void setGroups(Groups groups)
           Sets an object that indicates how data is grouped in the report.
 void setParameterFields(Fields parameterFields)
           Sets an object that contains the parameters in the report.
 void setParameterGroups(java.util.List parameterGroups)
          For internal use only
 void setRecordFilter(IFilter recordFilter)
           Sets the filter that determines which records should be retrieved from the database when data is retrieved.
 void setRecordSorts(Sorts sorts)
          Sets an object that indicates how records are sorted once they are retrieved from the database.
 void setResultFields(Fields resultFields)
           Sets an object that contains the result fields in the report.
 void setRunningTotalFields(Fields runningTotalFields)
          For internal use only
 void setSavedDataFilter(IFilter savedDataFilter)
           Sets a filter that allows users to view a subset of the data saved in a report.
 void setSorts(Sorts sorts)
          Deprecated. As of version 4.0. For record sorts, replaced by #setRecordSorts(). For group sorts, replaced by #setGroups() and IGroup#setSort().
 

Method Detail

getFormulaFields

Fields getFormulaFields()

Returns an object that contains a list of all the formula fields in the report. The formula fields that are included in this list are not necessarily placed on the report. That is, you may not see their values when the report is refreshed. To see whether a formula field has been placed on the report, use the IDataDefinition.getResultFields() method.

Returns:
The Fields object.

getGroupFilter

IFilter getGroupFilter()

Returns the filter that indicates how groups are filtered in the report.

Returns:
The group filter as an IFilter object.

getGroups

Groups getGroups()

Returns an object that indicates how data is grouped in the report. This object contains all the groups in a report.

Returns:
The Groups object.

getParameterFields

Fields getParameterFields()

Returns an object that contains the parameters in the report.

Returns:
The Fields object.

getParameterGroups

java.util.List getParameterGroups()
For internal use only


getSavedDataFilter

IFilter getSavedDataFilter()

Returns the filter that allows users to view a subset of the data saved in a report. Changing the SavedDataFilter will not discard the data saved in a report or result in a database hit.

Returns:
The saved data filter as an IFilter object.
See Also:
getSavedDataFilterController

getRecordFilter

IFilter getRecordFilter()

Returns the filter that determines which records should be retrieved from the database when data is retrieved.

Returns:
The filter as an IFilter object.

getResultFields

Fields getResultFields()

Returns an object that contains the result fields in the report.

Returns:
The Fields object.

getSorts

Sorts getSorts()
Deprecated. As of version 4.0. For record sorts, replaced by IDataDefinition.getRecordSorts(). For group sorts, replaced by IDataDefinition.getGroups() and IGroup.getSort().

Returns an object that indicates how records are sorted once they are retrieved from the database.

Returns:
The Sorts object.

getRecordSorts

Sorts getRecordSorts()
Returns an object that indicates how records are sorted once they are retrieved from the database. For group sorts, see IGroup.getSort().

Returns:
The Sorts object.
See Also:
RecordSortController

getSummaryFields

SummaryFields getSummaryFields()

Returns an object that contains a list of the summaries in the report.

Returns:
The Fields object.

setFormulaFields

void setFormulaFields(Fields formulaFields)

Sets an object that contains a list of all the formula fields in the report. The formula fields that are included in this list are not necessarily placed on the report. That is, you may not see their values when the report is refreshed. To see whether a formula field has been placed on the report, use the IDataDefinition.getResultFields() method.

Parameters:
formulaFields - Returns the Fields object.

setGroupFilter

void setGroupFilter(IFilter groupFilter)

Sets the filter that indicates how groups are filtered in the report.

Parameters:
groupFilter - The group filter as an IFilter object.

setGroups

void setGroups(Groups groups)

Sets an object that indicates how data is grouped in the report. This object contains all the groups in a report.

Parameters:
groups - The Groups object.

setParameterFields

void setParameterFields(Fields parameterFields)

Sets an object that contains the parameters in the report.

Parameters:
parameterFields - The Fields object.

setParameterGroups

void setParameterGroups(java.util.List parameterGroups)
For internal use only


setSavedDataFilter

void setSavedDataFilter(IFilter savedDataFilter)

Sets a filter that allows users to view a subset of the data saved in a report. Changing the SavedDataFilter will not discard the data saved in a report or result in a database hit.

Parameters:
savedDataFilter - The saved data filter as an IFilter object.

setRecordFilter

void setRecordFilter(IFilter recordFilter)

Sets the filter that determines which records should be retrieved from the database when data is retrieved.

Parameters:
recordFilter - The filter as an IFilter object.

setResultFields

void setResultFields(Fields resultFields)

Sets an object that contains the result fields in the report.

Parameters:
resultFields - The Fields object.

setSorts

void setSorts(Sorts sorts)
Deprecated. As of version 4.0. For record sorts, replaced by #setRecordSorts(). For group sorts, replaced by #setGroups() and IGroup#setSort().

Sets an object that indicates how records are sorted once they are retrieved from the database.

Parameters:
sorts - The Sorts object.

setRecordSorts

void setRecordSorts(Sorts sorts)
Sets an object that indicates how records are sorted once they are retrieved from the database. To set group sorts, see IGroup.setSort(com.crystaldecisions.sdk.occa.report.data.ISort).

Parameters:
sorts - The Sorts object.
See Also:
RecordSortController

getRunningTotalFields

Fields getRunningTotalFields()
For internal use only


setRunningTotalFields

void setRunningTotalFields(Fields runningTotalFields)
For internal use only


getCustomFunctions

CustomFunctions getCustomFunctions()
For internal use only


getAlerts

Alerts getAlerts()
For internal use only


getBurstingIndexes

Fields getBurstingIndexes()
For internal use only


setBurstingIndexes

void setBurstingIndexes(Fields fieldsToIndex)
For internal use only


getViewTimeFilter

IFilter getViewTimeFilter()
For internal use only