|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectcom.crystaldecisions.sdk.occa.report.data.Group
public class Group
This object defines a group in the report. The Group object stores
information on how data is grouped in the report and which
options are set for the group. The options that
control how data is grouped depend on the type of field that is
used in the grouping.
Use the IGroup interface to manipulate this object.
Use the
GroupController.canGroupOn(IField field)
method to determine if a particular field can be used to group data.
IGroup| Constructor Summary | |
|---|---|
Group()
|
|
Group(IGroup src)
|
|
| Method Summary | |
|---|---|
void |
addSort(int index,
ISort newSort)
For internal use only |
void |
cleanSummarySorts()
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 groupAncestor)
For internal use only |
java.lang.Object |
createMember(java.lang.String eleName,
org.xml.sax.Attributes attrs,
XMLSerializationContext ctxt,
java.util.Map objState,
boolean[] bLoaded)
|
void |
endElement(java.lang.String eleName,
java.util.Map objState)
|
IField |
getConditionField()
Returns which field is being used to group the data. |
ISort |
getConditionFieldSort()
For internal use only |
java.lang.String |
getGroupIdentifier()
For internal use only |
int |
getGroupIndex()
For internal use only. |
IGroupOptions |
getOptions()
Indicates how the group behaves. |
int |
getPrimaryInteractiveSortIndex()
For internal use only |
ISort |
getSort()
Gets the group primary sorting. |
ISort |
getSortBySortFieldName(java.lang.String sortFieldName)
For internal use only |
int |
getSortIndexBySortField(IField sortField)
For internal use only |
Sorts |
getSorts()
For internal use only |
boolean |
hasContent(java.lang.Object srcGroup)
|
boolean |
isValidSort(ISort newSort,
int index,
boolean bAdd)
For internal use only |
void |
readElement(java.lang.String eleName,
java.lang.String sVal,
org.xml.sax.Attributes attrs,
java.util.Map objState)
|
void |
removeSummarySort(ISort summarySort)
For internal use only |
void |
removeSummarySortAt(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 |
setConditionField(IField conditionField)
Sets which field is being used to group the data. |
void |
setGroupIdentifier(java.lang.String newIdentifier)
For internal use only |
void |
setGroupIndex(int index)
For internal use only. |
void |
setOptions(IGroupOptions options)
Indicates how the group behaves. |
void |
setSort(int index,
ISort newSort)
For internal use only |
void |
setSort(ISort sort)
This method is to set primary sort in the group |
void |
setSorts(Sorts newSorts)
For internal use only |
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 |
|---|
public Group(IGroup src)
public Group()
| Method Detail |
|---|
public java.lang.Object clone(boolean deepClone)
public void copyTo(java.lang.Object destObject,
boolean deepCopy)
public void copyTo(java.lang.Object destObject,
boolean deepCopy,
AncestorLink groupAncestor)
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 IField getConditionField()
IGroupReturns which field is being used to group the data.
The only fields that may be used to group data are:
The following are defined as primitive types:
Use the
GroupController.canGroupOn(IField) method to determine if a particular field can be used to
group data.
getConditionField in interface IGroupIField interface.public ISort getSort()
IGroup
getSort in interface IGroupISort objectGroupSortControllerpublic ISort getConditionFieldSort()
IGroup
getConditionFieldSort in interface IGrouppublic IGroupOptions getOptions()
IGroupIndicates how the group behaves. Depending on the grouping options required, the Options property will be one of the following
| Group | Options Object Type |
| Normal group | No options |
| Specified grouping | SpecifiedGroupOptions Object |
| Grouping based on date | DateGroupOptions Object |
getOptions in interface IGroupIGroupOptions interface.public int getGroupIndex()
IGroup
getGroupIndex in interface IGrouppublic void setGroupIndex(int index)
IGroup
setGroupIndex in interface IGrouppublic boolean hasContent(java.lang.Object srcGroup)
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.IOExceptionpublic void setConditionField(IField conditionField)
IGroupSets which field is being used to group the data.
The only fields that may be used to group data are:
The following are defined as primitive types:
Use the
GroupController.canGroupOn(IField) method to determine if a particular field can be used to
group data.
setConditionField in interface IGroupconditionField - The field that is being used to group the data as an IField
interface.public void setSort(ISort sort)
setSort in interface IGroupsort - new sort to set as primary sortGroupSortControllerpublic void setOptions(IGroupOptions options)
IGroupIndicates how the group behaves. Depending on the grouping options required, the Options property will be one of the following
| Group | Options Object Type |
| Normal group | No options |
| Specified grouping | SpecifiedGroupOptions Object |
| Grouping based on date | DateGroupOptions Object |
setOptions in interface IGroupoptions - The IGroupOptions interface.
public void startElement(java.lang.String eleName,
java.util.Map objState,
org.xml.sax.Attributes attrs)
public java.lang.String getGroupIdentifier()
IGroup
getGroupIdentifier in interface IGrouppublic void setGroupIdentifier(java.lang.String newIdentifier)
IGroup
setGroupIdentifier in interface IGrouppublic Sorts getSorts()
IGroup
getSorts in interface IGrouppublic void setSorts(Sorts newSorts)
IGroup
setSorts in interface IGroup
public void addSort(int index,
ISort newSort)
IGroup
addSort in interface IGroup
public void setSort(int index,
ISort newSort)
IGroup
setSort in interface IGrouppublic int getSortIndexBySortField(IField sortField)
IGroup
getSortIndexBySortField in interface IGrouppublic void removeSummarySortAt(int index)
IGroup
removeSummarySortAt in interface IGrouppublic void removeSummarySort(ISort summarySort)
IGroup
removeSummarySort in interface IGrouppublic ISort getSortBySortFieldName(java.lang.String sortFieldName)
IGroup
getSortBySortFieldName in interface IGroup
public boolean isValidSort(ISort newSort,
int index,
boolean bAdd)
IGroup
isValidSort in interface IGroupnewSort - sort to be added or setindex - the index to add / set sortbAdd - true: add, false: setpublic void cleanSummarySorts()
cleanSummarySorts in interface IGrouppublic int getPrimaryInteractiveSortIndex()
getPrimaryInteractiveSortIndex in interface IGroup
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||