com.crystaldecisions.sdk.occa.report.definition
Class ChartDefinition

java.lang.Object
  extended by com.crystaldecisions.sdk.occa.report.definition.ChartDefinition
All Implemented Interfaces:
IChartDefinition, IClone

public class ChartDefinition
extends java.lang.Object
implements IChartDefinition, IClone

This object implements the type of chart that appears on the report and defines the fields that are being charted on. When possible, use the IChartDefinition interface.


Constructor Summary
ChartDefinition()
           
ChartDefinition(IChartDefinition src)
           
 
Method Summary
 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)
           
 void endElement(java.lang.String eleName, java.util.Map objState)
           For internal use only.
 void enumerateMembers(IMemberVisitor visitor)
           
 ChartType getChartType()
          Returns the data that you want the chart type to represent.
 Fields getConditionFields()
          Deprecated. please use getGroups
 ControllableMixin getControllableMixin()
           
 Fields<IField> getDataFields()
          Returns the fields that indicate what information is plotted as the points on your chart.
 Groups getGroups()
          Gets the chart's groups.
 ChartGroupType getGroupType()
          Gets the chart group type.
 IField getLabelField()
          Get the chart's label field.
 Groups getSeries()
          Get the chart's series groups.
 boolean hasContent(java.lang.Object srcChartDefinition)
           
 boolean isDirectlyControllable()
           
 void onChange(java.util.EventObject event)
           
 void readElement(java.lang.String eleName, java.lang.String sVal, org.xml.sax.Attributes attrs, java.util.Map objState)
           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 setChartType(ChartType chartType)
          Sets the data that you want the chart type to represent.
 void setConditionFields(Fields conditionFields)
          Deprecated. please use setGroups
 void setDataFields(Fields<IField> dataFields)
          Sets the fields that indicate what information is plotted as the points on your chart.
 void setGroups(Groups groups)
           
 void setGroupType(ChartGroupType groupType)
          Sets the chart group type.
 void setLabelField(IField labelFieldOnRecord)
          Sets the chart's label field.
 void setSeries(Groups series)
           
 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

ChartDefinition

public ChartDefinition(IChartDefinition src)

ChartDefinition

public ChartDefinition()
Method Detail

clone

public java.lang.Object clone(boolean deepClone)

copyTo

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

createMember

public 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.


endElement

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

For internal use only.


getChartType

public ChartType getChartType()
Description copied from interface: IChartDefinition
Returns the data that you want the chart type to represent. Your report may include different fields, such as group fields, summary fields, and detail fields. Detail fields are those fields that form the columns of data values in the report.

Specified by:
getChartType in interface IChartDefinition
Returns:
A ChartType object containing the data that you want the chart type to represent.

getConditionFields

public Fields getConditionFields()
Deprecated. please use getGroups

Description copied from interface: IChartDefinition

Returns the fields that indicate when to plot a point on a chart. To create a chart, you must specify two things: conditions (the fields that indicate when to plot a point on a chart), and values (the fields that indicate what information is plotted as the points on your chart). Condition fields are the conditions. For example, a chart showing last year's sales for your customers uses the Customer Name field as the condition. Each time the condition changes (the customer name changes), a point is plotted on the x-axis.

You can set two conditions, which may then be used to create a 3D chart. See the setType method.

Specified by:
getConditionFields in interface IChartDefinition
Returns:
A Fields object containing the fields that indicate when to plot a point on a chart.

getDataFields

public Fields<IField> getDataFields()
Description copied from interface: IChartDefinition

Returns the fields that indicate what information is plotted as the points on your chart. To create a chart, you must specify two things: conditions (the fields that indicate when to plot a point on a chart) and values (the fields that indicate what information is plotted as the points on your chart). Data fields are the values. For example, in a chart showing last year's sales for each of your customers, the Last Year's Sales field would be the y-axis value.

You can set multiple values, which may then be used to create a 3D chart. See the setType method.

Specified by:
getDataFields in interface IChartDefinition
Returns:
A Fields object containing the fields that indicate what information is plotted as the points on your chart.

hasContent

public boolean hasContent(java.lang.Object srcChartDefinition)

readElement

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

For internal use only.


save

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

For internal use only.

Throws:
java.io.IOException

save

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

For internal use only.

Throws:
java.io.IOException

saveContents

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

For internal use only.

Throws:
java.io.IOException

setChartType

public void setChartType(ChartType chartType)
Description copied from interface: IChartDefinition

Sets the data that you want the chart type to represent. Your report may include different fields, such as group fields, summary fields, and detail fields. Detail fields are those fields that form the columns of data values in the report.

This property specifies the type of data--group or detail--that you want the chart to represent:

Specified by:
setChartType in interface IChartDefinition
Parameters:
chartType - A ChartType object containing the data that you want the chart type to represent.

setConditionFields

public void setConditionFields(Fields conditionFields)
Deprecated. please use setGroups

Description copied from interface: IChartDefinition

Sets the fields that indicate when to plot a point on a chart. To create a chart, you must specify two things: conditions (the fields that indicate when to plot a point on a chart), and values (the fields that indicate what information is plotted as the points on your chart). Condition fields are the conditions. For example, a chart showing last year's sales for your customers uses the Customer Name field as the condition. Each time the condition changes (the customer name changes), a point is plotted on the x-axis.

You can set two conditions, which may then be used to create a 3D chart. See the setType method.

Specified by:
setConditionFields in interface IChartDefinition
Parameters:
conditionFields - A Fields object containing the fields that indicate when to plot a point on a chart.

setDataFields

public void setDataFields(Fields<IField> dataFields)
Description copied from interface: IChartDefinition

Sets the fields that indicate what information is plotted as the points on your chart. To create a chart, you must specify two things: conditions (the fields that indicate when to plot a point on a chart) and values (the fields that indicate what information is plotted as the points on your chart). Data fields are the values. For example, in a chart showing last year's sales for each of your customers, the Last Year's Sales field would be the y-axis value.

You can set multiple values, which may then be used to create a 3D chart. See the setType method.

Specified by:
setDataFields in interface IChartDefinition
Parameters:
dataFields - A Fields object containing the fields that indicate what information is plotted as the points on your chart.

startElement

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

For internal use only.


getGroups

public Groups getGroups()
Description copied from interface: IChartDefinition
Gets the chart's groups.

Specified by:
getGroups in interface IChartDefinition
Returns:
a collection of IGroup objects

setGroups

public void setGroups(Groups groups)

getGroupType

public ChartGroupType getGroupType()
Description copied from interface: IChartDefinition
Gets the chart group type.

Specified by:
getGroupType in interface IChartDefinition
Returns:
the ChartGroupType
See Also:
ChartGroupType

setGroupType

public void setGroupType(ChartGroupType groupType)
Description copied from interface: IChartDefinition
Sets the chart group type.

Specified by:
setGroupType in interface IChartDefinition
Parameters:
groupType - a ChartGroupType
See Also:
ChartGroupType

getLabelField

public IField getLabelField()
Description copied from interface: IChartDefinition
Get the chart's label field. Used only when the chart group type is set to ChartGroupType.forEachRecord.

Specified by:
getLabelField in interface IChartDefinition
Returns:
the label field

getSeries

public Groups getSeries()
Description copied from interface: IChartDefinition
Get the chart's series groups.

Specified by:
getSeries in interface IChartDefinition
Returns:
a collection of IGroup objects

setLabelField

public void setLabelField(IField labelFieldOnRecord)
Description copied from interface: IChartDefinition
Sets the chart's label field. Used only when the chart group type is set to ChartGroupType.forEachRecord.

Specified by:
setLabelField in interface IChartDefinition
Parameters:
labelFieldOnRecord - the field to use as label

setSeries

public void setSeries(Groups series)

onChange

public void onChange(java.util.EventObject event)

doControllerModification

public void doControllerModification(java.lang.Object newObject)

getControllableMixin

public ControllableMixin getControllableMixin()

isDirectlyControllable

public boolean isDirectlyControllable()

enumerateMembers

public void enumerateMembers(IMemberVisitor visitor)