|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectcom.crystaldecisions.sdk.occa.report.data.DataDefinition
public class DataDefinition
This object contains the 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. When possible, use the IDataDefinition interface to manipulate this object.
| Constructor Summary | |
|---|---|
DataDefinition()
|
|
DataDefinition(IDataDefinition src)
|
|
| Method Summary | |
|---|---|
int |
addParameterGroup(int index,
IParameterGroup parameterGroup)
For internal use only |
void |
adjustGroupIndex()
For internal use only. |
java.lang.Object |
clone(boolean deepClone)
|
void |
copyTo(java.lang.Object destObject,
boolean deepCopy)
|
void |
copyTo(java.lang.Object destObject,
boolean deepCopy,
AncestorLink parentObject)
|
java.lang.Object |
createMember(java.lang.String eleName,
org.xml.sax.Attributes attrs,
XMLSerializationContext ctxt,
java.util.Map objState,
boolean[] bLoaded)
|
void |
disablePropertiesUnsupportedByLegacyReport()
For internal use only |
void |
endElement(java.lang.String eleName,
java.util.Map objState)
|
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 DataDefinition.getRecordSorts().
For group sorts, replaced by DataDefinition.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 |
boolean |
hasContent(java.lang.Object srcDataDefinition)
|
void |
modifyParameterGroup(int index,
IParameterGroup newParameterGroup)
For internal use only |
void |
readElement(java.lang.String eleName,
java.lang.String sVal,
org.xml.sax.Attributes attrs,
java.util.Map objState)
|
void |
rebuildSortCollection()
For internal use only. |
boolean |
removeParameterGroup(int index)
For internal use only |
void |
save(XMLWriter writer,
java.lang.String sTag,
XMLSerializationContext ctxt)
|
void |
save(XMLWriter writer,
XMLSerializationContext ctxt)
|
void |
saveContents(XMLWriter writer,
XMLSerializationContext ctxt)
|
void |
setAlerts(Alerts alerts)
For internal use only. |
void |
setBurstingIndexes(Fields fieldsToIndex)
For internal use only |
void |
setCustomFunctions(CustomFunctions functions)
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 |
setParameterGroupsOrder(java.util.List order)
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. |
void |
startElement(java.lang.String eleName,
java.util.Map objState,
org.xml.sax.Attributes attrs)
|
| Methods inherited from class java.lang.Object |
|---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public DataDefinition(IDataDefinition src)
public DataDefinition()
| Method Detail |
|---|
public java.lang.Object clone(boolean deepClone)
public void copyTo(java.lang.Object destObject,
boolean deepCopy)
public void copyTo(java.lang.Object destObject,
boolean deepCopy,
AncestorLink parentObject)
public void adjustGroupIndex()
public void rebuildSortCollection()
public java.lang.Object createMember(java.lang.String eleName,
org.xml.sax.Attributes attrs,
XMLSerializationContext ctxt,
java.util.Map objState,
boolean[] bLoaded)
public void endElement(java.lang.String eleName,
java.util.Map objState)
public Fields getFormulaFields()
IDataDefinition
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.
getFormulaFields in interface IDataDefinitionFields object.public IFilter getGroupFilter()
IDataDefinitionReturns the filter that indicates how groups are filtered in the report.
getGroupFilter in interface IDataDefinitionIFilter object.public Groups getGroups()
IDataDefinitionReturns an object that indicates how data is grouped in the report. This object contains all the groups in a report.
getGroups in interface IDataDefinitionGroups object.public Fields getParameterFields()
IDataDefinitionReturns an object that contains the parameters in the report.
getParameterFields in interface IDataDefinitionFields object.public Fields getBurstingIndexes()
IDataDefinition
getBurstingIndexes in interface IDataDefinition
public int addParameterGroup(int index,
IParameterGroup parameterGroup)
public boolean removeParameterGroup(int index)
public void modifyParameterGroup(int index,
IParameterGroup newParameterGroup)
public java.util.List getParameterGroups()
IDataDefinition
getParameterGroups in interface IDataDefinitionpublic IFilter getSavedDataFilter()
IDataDefinitionReturns 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.
getSavedDataFilter in interface IDataDefinitionIFilter object.getSavedDataFilterControllerpublic Fields getRunningTotalFields()
IDataDefinition
getRunningTotalFields in interface IDataDefinitionpublic CustomFunctions getCustomFunctions()
IDataDefinition
getCustomFunctions in interface IDataDefinitionpublic IFilter getRecordFilter()
IDataDefinitionReturns the filter that determines which records should be retrieved from the database when data is retrieved.
getRecordFilter in interface IDataDefinitionIFilter object.public Alerts getAlerts()
IDataDefinition
getAlerts in interface IDataDefinitionpublic Fields getResultFields()
IDataDefinitionReturns an object that contains the result fields in the report.
getResultFields in interface IDataDefinitionFields object.@Deprecated public Sorts getSorts()
DataDefinition.getRecordSorts().
For group sorts, replaced by DataDefinition.getGroups() and IGroup.getSort().
Returns an object that indicates how records are sorted once they are retrieved from the database.
getSorts in interface IDataDefinitionSorts object.public Sorts getRecordSorts()
IDataDefinitionIGroup.getSort().
getRecordSorts in interface IDataDefinitionSorts object.RecordSortControllerpublic SummaryFields getSummaryFields()
IDataDefinitionReturns an object that contains a list of the summaries in the report.
getSummaryFields in interface IDataDefinitionFields object.public boolean hasContent(java.lang.Object srcDataDefinition)
public void readElement(java.lang.String eleName,
java.lang.String sVal,
org.xml.sax.Attributes attrs,
java.util.Map objState)
public void save(XMLWriter writer,
XMLSerializationContext ctxt)
throws java.io.IOException
java.io.IOException
public void save(XMLWriter writer,
java.lang.String sTag,
XMLSerializationContext ctxt)
throws java.io.IOException
java.io.IOException
public void saveContents(XMLWriter writer,
XMLSerializationContext ctxt)
throws java.io.IOException
java.io.IOExceptionpublic void setFormulaFields(Fields formulaFields)
IDataDefinition
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.
setFormulaFields in interface IDataDefinitionformulaFields - Returns the Fields object.public void setGroupFilter(IFilter groupFilter)
IDataDefinitionSets the filter that indicates how groups are filtered in the report.
setGroupFilter in interface IDataDefinitiongroupFilter - The group filter as an IFilter object.public void setSavedDataFilter(IFilter savedDataFilter)
IDataDefinitionSets 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.
setSavedDataFilter in interface IDataDefinitionsavedDataFilter - The saved data filter as an IFilter object.public void setGroups(Groups groups)
IDataDefinitionSets an object that indicates how data is grouped in the report. This object contains all the groups in a report.
setGroups in interface IDataDefinitiongroups - The Groups object.public void setParameterFields(Fields parameterFields)
IDataDefinitionSets an object that contains the parameters in the report.
setParameterFields in interface IDataDefinitionparameterFields - The Fields object.public void setBurstingIndexes(Fields fieldsToIndex)
IDataDefinition
setBurstingIndexes in interface IDataDefinitionpublic void setParameterGroups(java.util.List parameterGroups)
IDataDefinition
setParameterGroups in interface IDataDefinitionpublic void setParameterGroupsOrder(java.util.List order)
public void setRunningTotalFields(Fields runningTotalFields)
IDataDefinition
setRunningTotalFields in interface IDataDefinitionpublic void setAlerts(Alerts alerts)
public void setCustomFunctions(CustomFunctions functions)
public void setRecordFilter(IFilter recordFilter)
IDataDefinitionSets the filter that determines which records should be retrieved from the database when data is retrieved.
setRecordFilter in interface IDataDefinitionrecordFilter - The filter as an IFilter object.public void setResultFields(Fields resultFields)
IDataDefinitionSets an object that contains the result fields in the report.
setResultFields in interface IDataDefinitionresultFields - The Fields object.@Deprecated public void setSorts(Sorts sorts)
IDataDefinitionSets an object that indicates how records are sorted once they are retrieved from the database.
setSorts in interface IDataDefinitionsorts - The Sorts object.public void setRecordSorts(Sorts sorts)
IDataDefinitionIGroup.setSort(com.crystaldecisions.sdk.occa.report.data.ISort).
setRecordSorts in interface IDataDefinitionsorts - The Sorts object.RecordSortControllerpublic void disablePropertiesUnsupportedByLegacyReport()
public void startElement(java.lang.String eleName,
java.util.Map objState,
org.xml.sax.Attributes attrs)
public IFilter getViewTimeFilter()
IDataDefinition
getViewTimeFilter in interface IDataDefinition
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||