|
|||||||||
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 | |
---|---|
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)
|
IField |
getConditionField()
Returns which field is being used to group the data. |
ControllableMixin |
getControllableMixin()
|
int |
getGroupIndex()
For internal use only. |
IGroupOptions |
getOptions()
Indicates how the group behaves. |
ISort |
getSort()
Gets the group sorting. |
boolean |
hasContent(java.lang.Object srcGroup)
|
boolean |
isDirectlyControllable()
|
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 |
setConditionField(IField conditionField)
Sets which field is being used to group the data. |
void |
setGroupIndex(int index)
For internal use only. |
void |
setOptions(IGroupOptions options)
Indicates how the group behaves. |
void |
setSort(ISort sort)
Sets the group sorting. |
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 Group(IGroup src)
public Group()
Method Detail |
---|
public java.lang.Object clone(boolean deepClone)
public void copyTo(java.lang.Object destObject, boolean deepCopy)
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.
public void endElement(java.lang.String eleName, java.util.Map objState)
For internal use only.
public IField getConditionField()
IGroup
Returns 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 IGroup
IField
interface.public ISort getSort()
IGroup
getSort
in interface IGroup
ISort
objectGroupSortController
public IGroupOptions getOptions()
IGroup
Indicates 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 IGroup
IGroupOptions
interface.public int getGroupIndex()
IGroup
getGroupIndex
in interface IGroup
public void setGroupIndex(int index)
IGroup
setGroupIndex
in interface IGroup
public 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)
For internal use only.
public void save(XMLWriter writer, XMLSerializationContext ctxt) throws java.io.IOException
For internal use only.
java.io.IOException
public void save(XMLWriter writer, java.lang.String sTag, XMLSerializationContext ctxt) throws java.io.IOException
For internal use only.
java.io.IOException
public void saveContents(XMLWriter writer, XMLSerializationContext ctxt) throws java.io.IOException
For internal use only.
java.io.IOException
public void setConditionField(IField conditionField)
IGroup
Sets 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 IGroup
conditionField
- The field that is being used to group the data as an IField
interface.public void setSort(ISort sort)
IGroup
setSort
in interface IGroup
sort
- an ISort
objectGroupSortController
public void setOptions(IGroupOptions options)
IGroup
Indicates 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 IGroup
options
- The IGroupOptions
interface.public void startElement(java.lang.String eleName, java.util.Map objState, org.xml.sax.Attributes attrs)
For internal use only.
public ControllableMixin getControllableMixin()
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 |