|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectcom.crystaldecisions.sdk.occa.report.application.DataDefController
public class DataDefController
This object is used to add, remove, and modify the data definition of the report. The data
definition defines which data is being retrieved and how the data is grouped, summarized, and
filtered. Using the DataDefController, you may modify any part of the report that acts
on the data from the database. This includes:
ResultFieldController add method.
| Method Summary | |
|---|---|
IField |
findFieldByFormulaForm(java.lang.String formulaForm)
Gets the field in the report that matches the specified formula form. |
AlertController |
getAlertController()
For internal use only. |
BurstingIndexController |
getBurstingIndexController()
For internal use only. |
IDataDefinition |
getDataDefinition()
Returns formulas, filters, groups, parameters, sort objects, and summaries. |
FormulaFieldController |
getFormulaFieldController()
Adds, removes, and modifies formula fields on the report. |
GroupController |
getGroupController()
Adds, moves, removes, and modifies the way data is grouped in the report. |
FilterController |
getGroupFilterController()
Adds, moves, removes, and modifies the way in which groups are filtered in the report. |
GroupSortController |
getGroupSortController()
Modifies group ISort objects, which define how groups in the report are
sorted. |
Strings |
getInUseFieldsNames()
For internal use only |
ParameterFieldController |
getParameterFieldController()
Adds, removes, and modifies any parameter fields in the report. |
java.util.Locale |
getProductLocale()
|
FilterController |
getRecordFilterController()
Adds, moves, removes, and modifies the way in which records are filtered in the report. |
RecordSortController |
getRecordSortController()
Adds, moves, removes, and modifies record ISort objects, which define how
records in the report are sorted. |
ResultFieldController |
getResultFieldController()
Determines which fields will be displayed in the report. |
RunningTotalFieldController |
getRunningTotalFieldController()
For internal use only |
FilterController |
getSavedDataFilterController()
Adds, moves, removes, and modifies the way in which saved data is filtered in the report. |
SortController |
getSortController()
Deprecated. As of version 4.0. The SortController is replaced by RecordSortController
and GroupSortController. To get these objects, use DataDefController.getRecordSortController()
and DataDefController.getGroupSortController(). |
SummaryFieldController |
getSummaryFieldController()
Adds, removes, and modifies summary fields on the report. |
FilterController |
getViewTimeFilterController()
Internal only |
FieldValueType |
guessFieldValueTypeFromFormulaForm(java.lang.String formulaForm)
For internal use only |
FieldValueType |
guessFieldValueTypeFromFormulaForm(java.lang.String formulaForm,
boolean getValueTypeForFormatOption)
For internal use only |
void |
interactiveSortPromote(ISortInfo selectedSort)
For internal use only |
void |
modifyFieldName(IField field,
java.lang.String newName)
For internal use only |
java.lang.String |
validateFieldForGrouping(IDBField dbField,
int groupingLevel,
java.lang.String crossTabName,
java.lang.Boolean useRowGroupContext)
For internal use only |
| Methods inherited from class java.lang.Object |
|---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Method Detail |
|---|
public IDataDefinition getDataDefinition()
Returns formulas, filters, groups, parameters, sort objects, and summaries. The
IDataDefinition object contains all the data structures necessary to define
and manipulate the data that the report contains. Note that the report's data definition is
not concerned with how the report is laid out. That is, it does not store information
regarding graphics, charts, borders, or text objects.
Although the DataDefinition represents the data in a report, it does not synchronize the data that your Report Application Server client is manipulating with that on the server. In order to properly modify the report, you must use the appropriate controller.
IDataDefinition object containing all formulas, filters, groups,
parameters, sort objects, and summaries in this report.public FormulaFieldController getFormulaFieldController()
Adds, removes, and modifies formula fields on the report.
FormulaFieldController object used to add, remove, and modify
formula fields on the report.public GroupController getGroupController()
Adds, moves, removes, and modifies the way data is grouped in the report.
GroupController object used to add, move, remove, and modify the
way data is grouped in the report.public FilterController getGroupFilterController()
Adds, moves, removes, and modifies the way in which groups are filtered in the report.
FilterController object used to add, move, remove, and modify the
way in which groups are filtered in the report.public ParameterFieldController getParameterFieldController()
Adds, removes, and modifies any parameter fields in the report.
ParameterFieldController used to add, remove, and modify any
parameter fields in the report.public FilterController getRecordFilterController()
Adds, moves, removes, and modifies the way in which records are filtered in the report.
FilterController object used to add, move, remove, and modify the
way in which records are filtered in the report.public FilterController getViewTimeFilterController()
Internal only
public ResultFieldController getResultFieldController()
Determines which fields will be displayed in the report.
ResultFieldController object used to determine which fields will
be displayed in the report.@Deprecated public SortController getSortController()
SortController is replaced by RecordSortController
and GroupSortController. To get these objects, use DataDefController.getRecordSortController()
and DataDefController.getGroupSortController().
ISort objects, which define how data in
the report is sorted.
SortController.DataDefinition.getSorts()public RecordSortController getRecordSortController()
ISort objects, which define how
records in the report are sorted.
RecordSortController.DataDefinition.getRecordSorts()public GroupSortController getGroupSortController()
ISort objects, which define how groups in the report are
sorted.
To reorder group sorts, use the GroupController to reorder the groups.
GroupSortController.DataDefinition.getGroups(),
Group.getSort()public FilterController getSavedDataFilterController()
Adds, moves, removes, and modifies the way in which saved data is filtered in the report.
Example:
This sample shows how to modify the savedDataFilter in a report.
DataDefController dataDefController = clientDoc.getDataDefController();
FilterController filterController = dataDefController.getSavedDataFilterController();
filterController.setFormulaText("{Customer.Last Year's Sales} > 20000");
FilterController object used to add, move, remove, and modify
the way in which saved data are filtered in the report.public SummaryFieldController getSummaryFieldController()
Adds, removes, and modifies summary fields on the report.
SummaryFieldController object used to add, remove, and modify
summary fields on the report.public RunningTotalFieldController getRunningTotalFieldController()
public AlertController getAlertController()
public BurstingIndexController getBurstingIndexController()
public IField findFieldByFormulaForm(java.lang.String formulaForm)
Gets the field in the report that matches the specified formula form. The string comparison search is case sensitive.
Example:
This sample shows how to find a field in a report that matches a specified formula form.
DataDefController dataDefController = clientDoc.getDataDefController();
IField field = dataDefController.findFieldByFormulaForm( "{table.field}" );
formulaForm - the formula form string that is used in the search
IField object
public void modifyFieldName(IField field,
java.lang.String newName)
throws ReportSDKException
ReportSDKException
public FieldValueType guessFieldValueTypeFromFormulaForm(java.lang.String formulaForm)
throws ReportSDKException
ReportSDKException
public FieldValueType guessFieldValueTypeFromFormulaForm(java.lang.String formulaForm,
boolean getValueTypeForFormatOption)
throws ReportSDKException
ReportSDKException
public void interactiveSortPromote(ISortInfo selectedSort)
throws ReportSDKException
ReportSDKException
public Strings getInUseFieldsNames()
throws ReportSDKException
ReportSDKException
public java.lang.String validateFieldForGrouping(IDBField dbField,
int groupingLevel,
java.lang.String crossTabName,
java.lang.Boolean useRowGroupContext)
throws ReportSDKException
ReportSDKExceptionpublic java.util.Locale getProductLocale()
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||