|
|||||||||
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 | |
---|---|
void |
adjustGroupIndex()
For internal use only. |
java.lang.Object |
clone(boolean deepClone)
|
void |
copyTo(java.lang.Object destObject,
boolean deepCopy)
|
java.lang.Object |
createMember(java.lang.String eleName,
org.xml.sax.Attributes attrs,
XMLSerializationContext ctxt,
java.util.Map objState,
boolean[] bLoaded)
For internal use only. |
void |
doControllerModification(java.lang.Object newObject)
For internal use only. |
void |
endElement(java.lang.String eleName,
java.util.Map objState)
For internal use only. |
void |
enumerateMembers(IMemberVisitor visitor)
For internal use only. |
Alerts |
getAlerts()
For internal use only. |
ControllableMixin |
getControllableMixin()
For internal use only. |
CustomFunctions |
getCustomFunctions()
Returns a collection of the custom functions contained in a report. |
Fields<IFormulaField> |
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<IParameterField> |
getParameterFields()
Returns an object that contains the parameters in the report. |
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<IField> |
getResultFields()
Returns an object that contains the result fields in the report. |
Fields<IRunningTotalField> |
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()
Returns an object that indicates how records are sorted once they are retrieved from the database. |
SummaryFields<ISummaryField> |
getSummaryFields()
Returns an object that contains a list of the summaries in the report. |
IFilter |
getViewTimeFilter()
Returns the report filter that can be applied when viewing. |
boolean |
hasContent(java.lang.Object srcDataDefinition)
|
boolean |
isDirectlyControllable()
For internal use only. |
void |
readElement(java.lang.String eleName,
java.lang.String sVal,
org.xml.sax.Attributes attrs,
java.util.Map objState)
For internal use only. |
void |
rebuildSortCollection()
For internal use only. |
void |
save(XMLWriter writer,
java.lang.String sTag,
XMLSerializationContext ctxt)
For internal use only. |
void |
save(XMLWriter writer,
XMLSerializationContext ctxt)
For internal use only. |
void |
saveContents(XMLWriter writer,
XMLSerializationContext ctxt)
For internal use only. |
void |
setAlerts(Alerts alerts)
For internal use only. |
void |
setFormulaFields(Fields<IFormulaField> 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<IParameterField> parameterFields)
Sets an object that contains the parameters in the report. |
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<IField> resultFields)
Sets an object that contains the result fields in the report. |
void |
setRunningTotalFields(Fields<IRunningTotalField> 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)
Sets an object that indicates how records are sorted once they are retrieved from the database. |
void |
startElement(java.lang.String eleName,
java.util.Map objState,
org.xml.sax.Attributes attrs)
For internal use only. |
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 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<IFormulaField> 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 IDataDefinition
Fields
object.public IFilter getGroupFilter()
IDataDefinition
Returns the filter that indicates how groups are filtered in the report.
getGroupFilter
in interface IDataDefinition
IFilter
object.public Groups getGroups()
IDataDefinition
Returns an object that indicates how data is grouped in the report. This object contains all the groups in a report.
getGroups
in interface IDataDefinition
Groups
object.public Fields<IParameterField> getParameterFields()
IDataDefinition
Returns an object that contains the parameters in the report.
getParameterFields
in interface IDataDefinition
Fields
object.public IFilter getSavedDataFilter()
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.
getSavedDataFilter
in interface IDataDefinition
IFilter
object.getSavedDataFilterController
public Fields<IRunningTotalField> getRunningTotalFields()
IDataDefinition
For internal use only.
getRunningTotalFields
in interface IDataDefinition
public CustomFunctions getCustomFunctions()
IDataDefinition
Returns a collection of the custom functions contained in a report. Custom functions must be added to the report using Crystal Reports. For information on how to do this, see the Crystal Reports online help.
getCustomFunctions
in interface IDataDefinition
CustomFunctions
object containing a collection of custom functions.public IFilter getRecordFilter()
IDataDefinition
Returns the filter that determines which records should be retrieved from the database when data is retrieved.
getRecordFilter
in interface IDataDefinition
IFilter
object.public Alerts getAlerts()
IDataDefinition
getAlerts
in interface IDataDefinition
public Fields<IField> getResultFields()
IDataDefinition
Returns an object that contains the result fields in the report.
getResultFields
in interface IDataDefinition
Fields
object.public Sorts getSorts()
IDataDefinition
Returns an object that indicates how records are sorted once they are retrieved from the database.
getSorts
in interface IDataDefinition
Sorts
object.public Sorts getRecordSorts()
IDataDefinition
IGroup.getSort()
.
getRecordSorts
in interface IDataDefinition
Sorts
object.RecordSortController
public SummaryFields<ISummaryField> getSummaryFields()
IDataDefinition
Returns an object that contains a list of the summaries in the report.
getSummaryFields
in interface IDataDefinition
Fields
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.IOException
public void setFormulaFields(Fields<IFormulaField> 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 IDataDefinition
formulaFields
- Returns the Fields
object.public void setGroupFilter(IFilter groupFilter)
IDataDefinition
Sets the filter that indicates how groups are filtered in the report.
setGroupFilter
in interface IDataDefinition
groupFilter
- The group filter as an IFilter
object.public void setSavedDataFilter(IFilter savedDataFilter)
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.
setSavedDataFilter
in interface IDataDefinition
savedDataFilter
- The saved data filter as an IFilter
object.public void setGroups(Groups groups)
IDataDefinition
Sets an object that indicates how data is grouped in the report. This object contains all the groups in a report.
setGroups
in interface IDataDefinition
groups
- The Groups
object.public void setParameterFields(Fields<IParameterField> parameterFields)
IDataDefinition
Sets an object that contains the parameters in the report.
setParameterFields
in interface IDataDefinition
parameterFields
- The Fields
object.public void setRunningTotalFields(Fields<IRunningTotalField> runningTotalFields)
IDataDefinition
For internal use only.
setRunningTotalFields
in interface IDataDefinition
public void setAlerts(Alerts alerts)
public void setRecordFilter(IFilter recordFilter)
IDataDefinition
Sets the filter that determines which records should be retrieved from the database when data is retrieved.
setRecordFilter
in interface IDataDefinition
recordFilter
- The filter as an IFilter
object.public void setResultFields(Fields<IField> resultFields)
IDataDefinition
Sets an object that contains the result fields in the report.
setResultFields
in interface IDataDefinition
resultFields
- The Fields
object.public void setSorts(Sorts sorts)
IDataDefinition
Sets an object that indicates how records are sorted once they are retrieved from the database.
setSorts
in interface IDataDefinition
sorts
- The Sorts
object.public void setRecordSorts(Sorts sorts)
IDataDefinition
IGroup.setSort(com.crystaldecisions.sdk.occa.report.data.ISort)
.
setRecordSorts
in interface IDataDefinition
sorts
- The Sorts
object.RecordSortController
public void startElement(java.lang.String eleName, java.util.Map objState, org.xml.sax.Attributes attrs)
public ControllableMixin getControllableMixin()
public void doControllerModification(java.lang.Object newObject) throws ReportSDKException
ReportSDKException
public boolean isDirectlyControllable()
public void enumerateMembers(IMemberVisitor visitor)
public IFilter getViewTimeFilter()
IDataDefinition
Returns the report filter that can be applied when viewing.
getViewTimeFilter
in interface IDataDefinition
IFilter
object.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |