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

java.lang.Object
  extended by com.crystaldecisions.sdk.occa.report.data.DataDefinition
All Implemented Interfaces:
IDataDefinition, IClone

public class DataDefinition
extends java.lang.Object
implements IDataDefinition, IClone

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

DataDefinition

public DataDefinition(IDataDefinition src)

DataDefinition

public DataDefinition()
Method Detail

clone

public java.lang.Object clone(boolean deepClone)

copyTo

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

copyTo

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

adjustGroupIndex

public void adjustGroupIndex()
For internal use only.


rebuildSortCollection

public void rebuildSortCollection()
For internal use only.


createMember

public java.lang.Object createMember(java.lang.String eleName,
                                     org.xml.sax.Attributes attrs,
                                     XMLSerializationContext ctxt,
                                     java.util.Map objState,
                                     boolean[] bLoaded)

endElement

public void endElement(java.lang.String eleName,
                       java.util.Map objState)

getFormulaFields

public Fields getFormulaFields()
Description copied from interface: 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.

Specified by:
getFormulaFields in interface IDataDefinition
Returns:
The Fields object.

getGroupFilter

public IFilter getGroupFilter()
Description copied from interface: IDataDefinition

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

Specified by:
getGroupFilter in interface IDataDefinition
Returns:
The group filter as an IFilter object.

getGroups

public Groups getGroups()
Description copied from interface: IDataDefinition

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

Specified by:
getGroups in interface IDataDefinition
Returns:
The Groups object.

getParameterFields

public Fields getParameterFields()
Description copied from interface: IDataDefinition

Returns an object that contains the parameters in the report.

Specified by:
getParameterFields in interface IDataDefinition
Returns:
The Fields object.

getBurstingIndexes

public Fields getBurstingIndexes()
Description copied from interface: IDataDefinition
For internal use only

Specified by:
getBurstingIndexes in interface IDataDefinition

addParameterGroup

public int addParameterGroup(int index,
                             IParameterGroup parameterGroup)
For internal use only


removeParameterGroup

public boolean removeParameterGroup(int index)
For internal use only


modifyParameterGroup

public void modifyParameterGroup(int index,
                                 IParameterGroup newParameterGroup)
For internal use only


getParameterGroups

public java.util.List getParameterGroups()
Description copied from interface: IDataDefinition
For internal use only

Specified by:
getParameterGroups in interface IDataDefinition

getSavedDataFilter

public IFilter getSavedDataFilter()
Description copied from interface: IDataDefinition

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.

Specified by:
getSavedDataFilter in interface IDataDefinition
Returns:
The saved data filter as an IFilter object.
See Also:
getSavedDataFilterController

getRunningTotalFields

public Fields getRunningTotalFields()
Description copied from interface: IDataDefinition
For internal use only

Specified by:
getRunningTotalFields in interface IDataDefinition

getCustomFunctions

public CustomFunctions getCustomFunctions()
Description copied from interface: IDataDefinition
For internal use only

Specified by:
getCustomFunctions in interface IDataDefinition

getRecordFilter

public IFilter getRecordFilter()
Description copied from interface: IDataDefinition

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

Specified by:
getRecordFilter in interface IDataDefinition
Returns:
The filter as an IFilter object.

getAlerts

public Alerts getAlerts()
Description copied from interface: IDataDefinition
For internal use only

Specified by:
getAlerts in interface IDataDefinition

getResultFields

public Fields getResultFields()
Description copied from interface: IDataDefinition

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

Specified by:
getResultFields in interface IDataDefinition
Returns:
The Fields object.

getSorts

@Deprecated
public 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().

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

Specified by:
getSorts in interface IDataDefinition
Returns:
The Sorts object.

getRecordSorts

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

Specified by:
getRecordSorts in interface IDataDefinition
Returns:
The Sorts object.
See Also:
RecordSortController

getSummaryFields

public SummaryFields getSummaryFields()
Description copied from interface: IDataDefinition

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

Specified by:
getSummaryFields in interface IDataDefinition
Returns:
The Fields object.

hasContent

public boolean hasContent(java.lang.Object srcDataDefinition)

readElement

public void readElement(java.lang.String eleName,
                        java.lang.String sVal,
                        org.xml.sax.Attributes attrs,
                        java.util.Map objState)

save

public void save(XMLWriter writer,
                 XMLSerializationContext ctxt)
          throws java.io.IOException
Throws:
java.io.IOException

save

public void save(XMLWriter writer,
                 java.lang.String sTag,
                 XMLSerializationContext ctxt)
          throws java.io.IOException
Throws:
java.io.IOException

saveContents

public void saveContents(XMLWriter writer,
                         XMLSerializationContext ctxt)
                  throws java.io.IOException
Throws:
java.io.IOException

setFormulaFields

public void setFormulaFields(Fields formulaFields)
Description copied from interface: 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.

Specified by:
setFormulaFields in interface IDataDefinition
Parameters:
formulaFields - Returns the Fields object.

setGroupFilter

public void setGroupFilter(IFilter groupFilter)
Description copied from interface: IDataDefinition

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

Specified by:
setGroupFilter in interface IDataDefinition
Parameters:
groupFilter - The group filter as an IFilter object.

setSavedDataFilter

public void setSavedDataFilter(IFilter savedDataFilter)
Description copied from interface: IDataDefinition

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.

Specified by:
setSavedDataFilter in interface IDataDefinition
Parameters:
savedDataFilter - The saved data filter as an IFilter object.

setGroups

public void setGroups(Groups groups)
Description copied from interface: IDataDefinition

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

Specified by:
setGroups in interface IDataDefinition
Parameters:
groups - The Groups object.

setParameterFields

public void setParameterFields(Fields parameterFields)
Description copied from interface: IDataDefinition

Sets an object that contains the parameters in the report.

Specified by:
setParameterFields in interface IDataDefinition
Parameters:
parameterFields - The Fields object.

setBurstingIndexes

public void setBurstingIndexes(Fields fieldsToIndex)
Description copied from interface: IDataDefinition
For internal use only

Specified by:
setBurstingIndexes in interface IDataDefinition

setParameterGroups

public void setParameterGroups(java.util.List parameterGroups)
Description copied from interface: IDataDefinition
For internal use only

Specified by:
setParameterGroups in interface IDataDefinition

setParameterGroupsOrder

public void setParameterGroupsOrder(java.util.List order)
For internal use only


setRunningTotalFields

public void setRunningTotalFields(Fields runningTotalFields)
Description copied from interface: IDataDefinition
For internal use only

Specified by:
setRunningTotalFields in interface IDataDefinition

setAlerts

public void setAlerts(Alerts alerts)
For internal use only.


setCustomFunctions

public void setCustomFunctions(CustomFunctions functions)
For internal use only.


setRecordFilter

public void setRecordFilter(IFilter recordFilter)
Description copied from interface: IDataDefinition

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

Specified by:
setRecordFilter in interface IDataDefinition
Parameters:
recordFilter - The filter as an IFilter object.

setResultFields

public void setResultFields(Fields resultFields)
Description copied from interface: IDataDefinition

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

Specified by:
setResultFields in interface IDataDefinition
Parameters:
resultFields - The Fields object.

setSorts

@Deprecated
public void setSorts(Sorts sorts)
Deprecated. 

Description copied from interface: IDataDefinition

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

Specified by:
setSorts in interface IDataDefinition
Parameters:
sorts - The Sorts object.

setRecordSorts

public void setRecordSorts(Sorts sorts)
Description copied from interface: IDataDefinition
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).

Specified by:
setRecordSorts in interface IDataDefinition
Parameters:
sorts - The Sorts object.
See Also:
RecordSortController

disablePropertiesUnsupportedByLegacyReport

public void disablePropertiesUnsupportedByLegacyReport()
For internal use only


startElement

public void startElement(java.lang.String eleName,
                         java.util.Map objState,
                         org.xml.sax.Attributes attrs)

getViewTimeFilter

public IFilter getViewTimeFilter()
Description copied from interface: IDataDefinition
For internal use only

Specified by:
getViewTimeFilter in interface IDataDefinition