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

java.lang.Object
  com.crystaldecisions.sdk.occa.report.data.Field
      com.crystaldecisions.sdk.occa.report.data.SummaryField

All Implemented Interfaces:

IField, ISummaryField, IClone

public class SummaryField
extends Field
implements ISummaryField, IClone

This object is used to calculate a summary for a group, or for the entire report.

Constructor Summary

SummaryField()
For internal use only.

SummaryField(ISummaryField 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.
java.lang.String	getDisplayName(FieldDisplayNameType displayName, java.util.Locale locale) Returns the name of the field that has been formatted according to the value of the parameter displayNameType.
java.lang.String	getFormulaForm() Returns the name of the field as it will be used in a formula.
IGroup	getGroup() Returns the group for which the summary is being calculated.
boolean	getIsRecurring() Returns true if the field is recurring, and false otherwise.
FieldKind	getKind() Returns what kind of field this is.
java.lang.String	getLongName(java.util.Locale locale) Returns the fully qualified name of the field.
SummaryOperation	getOperation() Returns the manner in which the summary will be calculated.
java.lang.String	getShortName(java.util.Locale locale) Returns the short name of the field.
IField	getSummarizedField() Returns the field that is being used to calculate the summary.
boolean	hasContent(java.lang.Object srcSummaryField)
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	setGroup(IGroup group) Sets the group for which the summary is being calculated.
void	setOperation(SummaryOperation operation) Sets the manner in which the summary will be calculated.
void	setSummarizedField(IField summarizedField) Sets the field that is being used to calculate the summary.

Methods inherited from class com.crystaldecisions.sdk.occa.report.data.Field

endElement, getAttributes, getDescription, getHeadingText, getLength, getName, getType, setAttributes, setDescription, setHeadingText, setLength, setName, setType, startElement

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.crystaldecisions.sdk.occa.report.data.IField

getDescription, getHeadingText, getLength, getName, getType, setDescription, setHeadingText, setLength, setName, setType

Constructor Detail

SummaryField

public SummaryField(ISummaryField src)

SummaryField

public SummaryField()

For internal use only.

Method Detail

clone

public java.lang.Object clone(boolean deepClone)

Overrides:

clone in class Field

copyTo

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

Overrides:

copyTo in class Field

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.

Overrides:

createMember in class Field

getDisplayName

public java.lang.String getDisplayName(FieldDisplayNameType displayName,
                                       java.util.Locale locale)

Description copied from interface: IField

Returns the name of the field that has been formatted according to the value of the parameter displayNameType.

Specified by:

getDisplayName in interface IField

Overrides:

getDisplayName in class Field

Parameters:

displayName - Indicates how the display text should be formatted. It may be one of the values listed under FieldDisplayNameType.

locale - Formats the string according to a locale.

Returns:

A String containing the name of the field that has been formatted according to the value of the parameter displayNameType.

getFormulaForm

public java.lang.String getFormulaForm()

Description copied from interface: IField

Returns the name of the field as it will be used in a formula. This is a unique identifier to avoid ambiguity in formula code. It is the same value as the one used in the CRW formula editor.

Specified by:

getFormulaForm in interface IField

Overrides:

getFormulaForm in class Field

Returns:

A String containing the name of the field as it will be used in a formula.

getGroup

public IGroup getGroup()

Description copied from interface: ISummaryField

Returns the group for which the summary is being calculated.

Specified by:

getGroup in interface ISummaryField

Returns:

An IGroup object containing the group for which the summary field is being calculated.

getKind

public FieldKind getKind()

Description copied from interface: IField

Returns what kind of field this is. Do not confuse this property with Type. Kind identifies what sort of report field this is, while Type identifies what the field is composed of. For example, a bitmap, string, chart, number, date, and so on.

Specified by:

getKind in interface IField

Returns:

A String that specifies what kind of field this is.

getIsRecurring

public boolean getIsRecurring()

Description copied from interface: IField

Returns true if the field is recurring, and false otherwise. A field is recurring if its contents change during the formatting of a report. A constant field (not recurring) is one that doesn't change. The special field "Page Number," for example, is a recurring field, while the special field "Report Title" is not.

Specified by:

getIsRecurring in interface IField

Overrides:

getIsRecurring in class Field

Returns:

true if the field is recurring, and false otherwise.

getLongName

public java.lang.String getLongName(java.util.Locale locale)

Description copied from interface: IField

Returns the fully qualified name of the field.

Specified by:

getLongName in interface IField

Overrides:

getLongName in class Field

Parameters:

locale - The locale that will be used to localize the field.

Returns:

A String containing the fully qualified name of the field.

getOperation

public SummaryOperation getOperation()

Description copied from interface: ISummaryField

Returns the manner in which the summary will be calculated.

Specified by:

getOperation in interface ISummaryField

Returns:

A SummaryOperation object that specifies the manner in which the summary will be calculated.

getShortName

public java.lang.String getShortName(java.util.Locale locale)

Description copied from interface: IField

Returns the short name of the field.

Specified by:

getShortName in interface IField

Overrides:

getShortName in class Field

Parameters:

locale - The locale that will be used to localize the field name.

Returns:

A String containing the short name of the field.

getSummarizedField

public IField getSummarizedField()

Description copied from interface: ISummaryField

Returns the field that is being used to calculate the summary.

Specified by:

getSummarizedField in interface ISummaryField

Returns:

An IField object containing the field that is being used to calculate the summary.

hasContent

public boolean hasContent(java.lang.Object srcSummaryField)

Overrides:

hasContent in class Field

readElement

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

Description copied from class: Field

For internal use only.

Overrides:

readElement in class Field

save

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

For internal use only.

Overrides:

save in class Field

Throws:

java.io.IOException

save

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

For internal use only.

Overrides:

save in class Field

Throws:

java.io.IOException

saveContents

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

Description copied from class: Field

For internal use only.

Overrides:

saveContents in class Field

Throws:

java.io.IOException

setGroup

public void setGroup(IGroup group)

Description copied from interface: ISummaryField

Sets the group for which the summary is being calculated.

Specified by:

setGroup in interface ISummaryField

Parameters:

group - An IGroup object containing the group for which the summary field is being calculated.

setOperation

public void setOperation(SummaryOperation operation)

Description copied from interface: ISummaryField

Sets the manner in which the summary will be calculated.

Specified by:

setOperation in interface ISummaryField

Parameters:

operation - A SummaryOperation object that specifies the manner in which the summary will be calculated.

setSummarizedField

public void setSummarizedField(IField summarizedField)

Description copied from interface: ISummaryField

Sets the field that is being used to calculate the summary.

Specified by:

setSummarizedField in interface ISummaryField

Parameters:

summarizedField - An IField object containing the field that is being used to calculate the summary.