|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.crystaldecisions.sdk.occa.report.data.Field
com.crystaldecisions.sdk.occa.report.data.SummaryField
public class SummaryField
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. |
void |
doControllerModification(java.lang.Object newObject)
|
void |
endElement(java.lang.String eleName,
java.util.Map objState)
For internal use only. |
void |
enumerateMembers(IMemberVisitor visitor)
|
ControllableMixin |
getControllableMixin()
|
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 |
getIsPrintTime()
|
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. |
int |
getOperationParameter()
Gets the operation parameter. |
IField |
getSecondarySummarizedField()
Gets the secondary summarized field. |
IGroup |
getSecondGroupForPercentage()
Gets the group that is used for the percentage summary. |
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)
|
boolean |
hasContent(java.lang.Object srcSummaryField,
IGroup containerGroup)
|
boolean |
isDirectlyControllable()
|
boolean |
isPercentageSummary()
Gets whether the summary calculates the percentage total of one group within a broader grouping. |
boolean |
isSummarizedAcrossHierarchy()
Gets whether the summary is calculated across hierarchical groupings. |
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 |
setOperationParameter(int parameter)
Sets the operation parameter. |
void |
setPercentageSummary(boolean percentageSummary)
Sets whether the summary calculates the percentage total of one group within a broader grouping. |
void |
setSecondarySummarizedField(IField summarizedField)
Sets the secondary summarized field. |
void |
setSecondGroupForPercentage(IGroup secondGroup)
Sets the group that is used for the percentage summary. |
void |
setSummarizedAcrossHierarchy(boolean sumAcrossHierarchy)
Sets whether the summary is calculated across hierarchical groupings. |
void |
setSummarizedField(IField summarizedField)
Sets the field that is being used to calculate the summary. |
void |
startElement(java.lang.String eleName,
java.util.Map objState,
org.xml.sax.Attributes attrs)
For internal use only. |
Methods inherited from class com.crystaldecisions.sdk.occa.report.data.Field |
---|
getAttributes, getDescription, getHeadingText, getIsRecurring, getLength, getName, getType, setAttributes, setDescription, setHeadingText, setLength, setName, setType |
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, getIsRecurring, getLength, getName, getType, setDescription, setHeadingText, setLength, setName, setType |
Constructor Detail |
---|
public SummaryField(ISummaryField src)
public SummaryField()
For internal use only.
Method Detail |
---|
public java.lang.Object clone(boolean deepClone)
clone
in class Field
public void copyTo(java.lang.Object destObject, boolean deepCopy)
copyTo
in class Field
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.
createMember
in class Field
public void endElement(java.lang.String eleName, java.util.Map objState)
Field
For internal use only.
endElement
in class Field
public java.lang.String getDisplayName(FieldDisplayNameType displayName, java.util.Locale locale)
IField
Returns the name of the field that has been formatted according to the value of the parameter
displayNameType
.
getDisplayName
in interface IField
getDisplayName
in class Field
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.
String
containing the name of the field that has been formatted
according to the value of the parameter displayNameType
.public java.lang.String getFormulaForm()
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.
getFormulaForm
in interface IField
getFormulaForm
in class Field
String
containing the name of the field as it will be used in a
formula.public IGroup getGroup()
ISummaryField
getGroup
in interface ISummaryField
IGroup
object containing the group for which the summary field is
being calculated.public FieldKind getKind()
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.
getKind
in interface IField
String
that specifies what kind of field this is.public boolean getIsPrintTime()
getIsPrintTime
in class Field
public java.lang.String getLongName(java.util.Locale locale)
IField
Returns the fully qualified name of the field.
getLongName
in interface IField
getLongName
in class Field
locale
- The locale that will be used to localize the field.
String
containing the fully qualified name of the field.public SummaryOperation getOperation()
ISummaryFieldBase
getOperation
in interface ISummaryFieldBase
SummaryOperation
object that specifies the manner in which the summary will
be calculated.public int getOperationParameter()
ISummaryFieldBase
SummaryOperation
types do not need a parameter, however, some summary operations
(i.e., "Nth Largest, N is") require an integer parameter.
getOperationParameter
in interface ISummaryFieldBase
int
parameter for the SummaryOperation
ISummaryFieldBase.getOperation()
public IField getSecondarySummarizedField()
ISummaryFieldBase
getSecondarySummarizedField
in interface ISummaryFieldBase
public void setSecondarySummarizedField(IField summarizedField)
ISummaryFieldBase
setSecondarySummarizedField
in interface ISummaryFieldBase
summarizedField
- the secondary summarized fieldpublic IGroup getSecondGroupForPercentage()
ISummaryField
getSecondGroupForPercentage
in interface ISummaryField
IGroup
used for the percentage summaryISummaryField.isPercentageSummary()
public void setSecondGroupForPercentage(IGroup secondGroup)
ISummaryField
setSecondGroupForPercentage
in interface ISummaryField
secondGroup
- the IGroup
to use for the percentage summaryISummaryField.setPercentageSummary(boolean)
public boolean isPercentageSummary()
ISummaryField
Note: The percentage option is valid only when the result of a summary operation is numeric.
isPercentageSummary
in interface ISummaryField
true
if the percentage summary is enabled, false
if it is disabledISummaryField.getSecondGroupForPercentage()
public void setPercentageSummary(boolean percentageSummary)
ISummaryField
setPercentageSummary
in interface ISummaryField
percentageSummary
- true
to enable percentage summary, false
to disable itISummaryField.setSecondGroupForPercentage(IGroup)
public boolean isSummarizedAcrossHierarchy()
ISummaryField
isSummarizedAcrossHierarchy
in interface ISummaryField
true
if the summary is calculated across hierarchical groupings, false
if it is notpublic void setSummarizedAcrossHierarchy(boolean sumAcrossHierarchy)
ISummaryField
setSummarizedAcrossHierarchy
in interface ISummaryField
sumAcrossHierarchy
- true
to enable calculating the summary across hierarchical groupings,
false
to disable itpublic java.lang.String getShortName(java.util.Locale locale)
IField
Returns the short name of the field.
getShortName
in interface IField
getShortName
in class Field
locale
- The locale that will be used to localize the field name.
String
containing the short name of the field.public IField getSummarizedField()
ISummaryFieldBase
getSummarizedField
in interface ISummaryFieldBase
IField
object containing the field that is being used to calculate
the summary.public boolean hasContent(java.lang.Object srcSummaryField)
hasContent
in class Field
public boolean hasContent(java.lang.Object srcSummaryField, IGroup containerGroup)
public void readElement(java.lang.String eleName, java.lang.String sVal, org.xml.sax.Attributes attrs, java.util.Map objState)
Field
For internal use only.
readElement
in class Field
public void save(XMLWriter writer, XMLSerializationContext ctxt) throws java.io.IOException
For internal use only.
save
in class Field
java.io.IOException
public void save(XMLWriter writer, java.lang.String sTag, XMLSerializationContext ctxt) throws java.io.IOException
For internal use only.
save
in class Field
java.io.IOException
public void saveContents(XMLWriter writer, XMLSerializationContext ctxt) throws java.io.IOException
Field
For internal use only.
saveContents
in class Field
java.io.IOException
public void setGroup(IGroup group)
ISummaryField
setGroup
in interface ISummaryField
group
- An IGroup
object containing the group for which the summary field is
being calculated.public void setOperation(SummaryOperation operation)
ISummaryFieldBase
setOperation
in interface ISummaryFieldBase
operation
- A SummaryOperation
object that specifies the manner in which the summary will
be calculated.public void setOperationParameter(int parameter)
ISummaryFieldBase
SummaryOperation
types do not need a parameter, however, some summary operations
(i.e., "Nth Largest, N is") require an integer parameter.
setOperationParameter
in interface ISummaryFieldBase
parameter
- the int
parameter used by the SummaryOperation
ISummaryFieldBase.setOperation(SummaryOperation)
public void setSummarizedField(IField summarizedField)
ISummaryFieldBase
setSummarizedField
in interface ISummaryFieldBase
summarizedField
- An IField
object containing the field that is being used to calculate
the summary.public void startElement(java.lang.String eleName, java.util.Map objState, org.xml.sax.Attributes attrs)
Field
For internal use only.
startElement
in class Field
public ControllableMixin getControllableMixin()
getControllableMixin
in class Field
public void doControllerModification(java.lang.Object newObject) throws ReportSDKException
ReportSDKException
public boolean isDirectlyControllable()
public void enumerateMembers(IMemberVisitor visitor)
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |