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

java.lang.Object
  extended by com.crystaldecisions.sdk.occa.report.data.GroupOptions
All Implemented Interfaces:
IGroupOptions, IClone
Direct Known Subclasses:
BooleanGroupOptions, DateGroupOptions, SpecifiedGroupOptions

public class GroupOptions
extends java.lang.Object
implements IGroupOptions, IClone

This class is used as a base class for groups that group data according to specific options, or for unusual fields that require options.


Constructor Summary
GroupOptions()
          Creates a new GroupOptions object.
GroupOptions(IGroupOptions src)
          Copies the given IGroupOptions object.
 
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)
          For internal use only.
 void endElement(java.lang.String eleName, java.util.Map objState)
          For internal use only.
 void enumerateMembers(IMemberVisitor visitor)
          For internal use only.
 GroupOptionsConditionFormulas getConditionFormulas()
          Returns the condition formulas that override the values for the default group options.
 ControllableMixin getControllableMixin()
          For internal use only.
 IHierarchicalOptions getHierarchicalOptions()
          Returns the hierarchical options that contains the information of the hierarchical sorting.
 boolean hasContent(java.lang.Object srcGroupOptions)
           
 boolean isDirectlyControllable()
          For internal use only.
 boolean isSortedHierarchically()
          Returns true if the group is sorted hierarchically, and false other wise.
 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 setConditionFormulas(GroupOptionsConditionFormulas formulas)
          Sets the condition formulas that override the values for the default group options.
 void setHierarchicalOptions(IHierarchicalOptions hierarchycalOptions)
          Sets the hierarchical options that contains the information of the hierarchical 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

GroupOptions

public GroupOptions(IGroupOptions src)
Copies the given IGroupOptions object. This method makes a deep copy of the src object.

Parameters:
src - the IGroupOptions to copy

GroupOptions

public GroupOptions()
Creates a new GroupOptions object.

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.


hasContent

public boolean hasContent(java.lang.Object srcGroupOptions)

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

startElement

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


getConditionFormulas

public GroupOptionsConditionFormulas getConditionFormulas()
Description copied from interface: IGroupOptions
Returns the condition formulas that override the values for the default group options.

Specified by:
getConditionFormulas in interface IGroupOptions
Returns:
A GroupOptionsConditionFormulas object containing the condition formulas that override the values for the default group options.

setConditionFormulas

public void setConditionFormulas(GroupOptionsConditionFormulas formulas)
Description copied from interface: IGroupOptions
Sets the condition formulas that override the values for the default group options.

Specified by:
setConditionFormulas in interface IGroupOptions
Parameters:
formulas - A GroupOptionsConditionFormulas object containing the condition formulas that override the values for the default group options.

isSortedHierarchically

public boolean isSortedHierarchically()
Description copied from interface: IGroupOptions
Returns true if the group is sorted hierarchically, and false other wise.

Specified by:
isSortedHierarchically in interface IGroupOptions
Returns:
A boolean to indicate if the group is sorted hierarchically.

getHierarchicalOptions

public IHierarchicalOptions getHierarchicalOptions()
Description copied from interface: IGroupOptions
Returns the hierarchical options that contains the information of the hierarchical sorting.

Specified by:
getHierarchicalOptions in interface IGroupOptions
Returns:
A IHierarchicalOptions object that contains the information of the hierarchical sorting.

setHierarchicalOptions

public void setHierarchicalOptions(IHierarchicalOptions hierarchycalOptions)
Description copied from interface: IGroupOptions
Sets the hierarchical options that contains the information of the hierarchical sorting.

Specified by:
setHierarchicalOptions in interface IGroupOptions
Parameters:
hierarchycalOptions - A IHierarchicalOptions object that contains the information of the hierarchical sorting.

getControllableMixin

public ControllableMixin getControllableMixin()
For internal use only.


doControllerModification

public void doControllerModification(java.lang.Object newObject)
For internal use only.


isDirectlyControllable

public boolean isDirectlyControllable()
For internal use only.


enumerateMembers

public void enumerateMembers(IMemberVisitor visitor)
For internal use only.