|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
public interface IDataDefinition
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 |
|---|
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.
Fields object.IFilter getGroupFilter()
Returns the filter that indicates how groups are filtered in the report.
IFilter object.Groups getGroups()
Returns an object that indicates how data is grouped in the report. This object contains all the groups in a report.
Groups object.Fields getParameterFields()
Returns an object that contains the parameters in the report.
Fields object.java.util.List getParameterGroups()
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.
IFilter object.getSavedDataFilterControllerIFilter getRecordFilter()
Returns the filter that determines which records should be retrieved from the database when data is retrieved.
IFilter object.Fields getResultFields()
Returns an object that contains the result fields in the report.
Fields object.Sorts getSorts()
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.
Sorts object.Sorts getRecordSorts()
IGroup.getSort().
Sorts object.RecordSortControllerSummaryFields getSummaryFields()
Returns an object that contains a list of the summaries in the report.
Fields object.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.
formulaFields - Returns the Fields object.void setGroupFilter(IFilter groupFilter)
Sets the filter that indicates how groups are filtered in the report.
groupFilter - The group filter as an IFilter object.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.
groups - The Groups object.void setParameterFields(Fields parameterFields)
Sets an object that contains the parameters in the report.
parameterFields - The Fields object.void setParameterGroups(java.util.List parameterGroups)
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.
savedDataFilter - The saved data filter as an IFilter object.void setRecordFilter(IFilter recordFilter)
Sets the filter that determines which records should be retrieved from the database when data is retrieved.
recordFilter - The filter as an IFilter object.void setResultFields(Fields resultFields)
Sets an object that contains the result fields in the report.
resultFields - The Fields object.void setSorts(Sorts sorts)
#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.
sorts - The Sorts object.void setRecordSorts(Sorts sorts)
IGroup.setSort(com.crystaldecisions.sdk.occa.report.data.ISort).
sorts - The Sorts object.RecordSortControllerFields getRunningTotalFields()
void setRunningTotalFields(Fields runningTotalFields)
CustomFunctions getCustomFunctions()
Alerts getAlerts()
Fields getBurstingIndexes()
void setBurstingIndexes(Fields fieldsToIndex)
IFilter getViewTimeFilter()
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||