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

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

public class SpecifiedGroupOptions
extends GroupOptions
implements ISpecifiedGroupOptions, IClone

This object is used to store options for data that is grouped according to user-specified options.


Constructor Summary
SpecifiedGroupOptions()
           
SpecifiedGroupOptions(ISpecifiedGroupOptions 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 endElement(java.lang.String eleName, java.util.Map objState)
          For internal use only.
 void enumerateMembers(IMemberVisitor visitor)
          For internal use only.
 Filters getSpecifiedValueFilters()
          Returns the sorting criteria for the specified group.
 java.lang.String getUnspecifiedValuesName()
          Returns the name that is used to group items which do not fall under the specified grouping criteria.
 UnspecifiedValuesType getUnspecifiedValuesType()
          Indicates how records that do not fall under the specified grouping criteria are treated.
 boolean hasContent(java.lang.Object srcSpecifiedGroupOptions)
           
 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 setSpecifiedValueFilters(Filters specifiedValueFilters)
          Stores the sorting criteria for the specified group.
 void setUnspecifiedValuesName(java.lang.String unspecifiedValuesName)
          Sets the name that is used to group items which do not fall under the specified grouping criteria.
 void setUnspecifiedValuesType(UnspecifiedValuesType unspecifiedValuesType)
          Sets how records that do not fall under the specified grouping criteria are treated.
 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.GroupOptions
doControllerModification, getConditionFormulas, getControllableMixin, getHierarchicalOptions, isDirectlyControllable, isSortedHierarchically, setConditionFormulas, setHierarchicalOptions
 
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.IGroupOptions
getConditionFormulas, getHierarchicalOptions, isSortedHierarchically, setConditionFormulas, setHierarchicalOptions
 

Constructor Detail

SpecifiedGroupOptions

public SpecifiedGroupOptions(ISpecifiedGroupOptions src)

SpecifiedGroupOptions

public SpecifiedGroupOptions()
Method Detail

clone

public java.lang.Object clone(boolean deepClone)
Overrides:
clone in class GroupOptions

copyTo

public void copyTo(java.lang.Object destObject,
                   boolean deepCopy)
Overrides:
copyTo in class GroupOptions

createMember

public java.lang.Object createMember(java.lang.String eleName,
                                     org.xml.sax.Attributes attrs,
                                     XMLSerializationContext ctxt,
                                     java.util.Map objState,
                                     boolean[] bLoaded)
Description copied from class: GroupOptions
For internal use only.

Overrides:
createMember in class GroupOptions

endElement

public void endElement(java.lang.String eleName,
                       java.util.Map objState)
Description copied from class: GroupOptions
For internal use only.

Overrides:
endElement in class GroupOptions

getSpecifiedValueFilters

public Filters getSpecifiedValueFilters()
Description copied from interface: ISpecifiedGroupOptions
Returns the sorting criteria for the specified group.

Specified by:
getSpecifiedValueFilters in interface ISpecifiedGroupOptions
Returns:
A Filters object containing the sorting criteria for the specified group.

getUnspecifiedValuesName

public java.lang.String getUnspecifiedValuesName()
Description copied from interface: ISpecifiedGroupOptions
Returns the name that is used to group items which do not fall under the specified grouping criteria. This is not a group name. More accurately, it is the name of a totaller node that is used to contain those records that do not match the specified grouping criteria. To specify this property you must set the UnspecifiedValuesType property to UnspecifiedValuesType.

Specified by:
getUnspecifiedValuesName in interface ISpecifiedGroupOptions
Returns:
A String containing the name that is used to group items which do not fall under the specified grouping criteria.

getUnspecifiedValuesType

public UnspecifiedValuesType getUnspecifiedValuesType()
Description copied from interface: ISpecifiedGroupOptions
Indicates how records that do not fall under the specified grouping criteria are treated. If UnspecifiedValuesType is set, the UnspecifiedValuesName property must contain the name under which extraneous records are listed.

Specified by:
getUnspecifiedValuesType in interface ISpecifiedGroupOptions
Returns:
An UnspecifiedValuesType object that indicates how records that do not fall under the specified grouping criteria are treated.

hasContent

public boolean hasContent(java.lang.Object srcSpecifiedGroupOptions)
Overrides:
hasContent in class GroupOptions

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: GroupOptions
For internal use only.

Overrides:
readElement in class GroupOptions

save

public void save(XMLWriter writer,
                 XMLSerializationContext ctxt)
          throws java.io.IOException
Description copied from class: GroupOptions
For internal use only.

Overrides:
save in class GroupOptions
Throws:
java.io.IOException

save

public void save(XMLWriter writer,
                 java.lang.String sTag,
                 XMLSerializationContext ctxt)
          throws java.io.IOException
Description copied from class: GroupOptions
For internal use only.

Overrides:
save in class GroupOptions
Throws:
java.io.IOException

saveContents

public void saveContents(XMLWriter writer,
                         XMLSerializationContext ctxt)
                  throws java.io.IOException
Description copied from class: GroupOptions
For internal use only.

Overrides:
saveContents in class GroupOptions
Throws:
java.io.IOException

setSpecifiedValueFilters

public void setSpecifiedValueFilters(Filters specifiedValueFilters)
Description copied from interface: ISpecifiedGroupOptions
Stores the sorting criteria for the specified group.

Specified by:
setSpecifiedValueFilters in interface ISpecifiedGroupOptions
Parameters:
specifiedValueFilters - A Filters object containing the sorting criteria for the specified group.

setUnspecifiedValuesName

public void setUnspecifiedValuesName(java.lang.String unspecifiedValuesName)
Description copied from interface: ISpecifiedGroupOptions
Sets the name that is used to group items which do not fall under the specified grouping criteria. This is not a group name. More accurately, it is the name of a totaller node that is used to contain those records that do not match the specified grouping criteria. To specify this property you must set the UnspecifiedValuesType property to UnspecifiedValuesType.

Specified by:
setUnspecifiedValuesName in interface ISpecifiedGroupOptions
Parameters:
unspecifiedValuesName - A String containing the name that is used to group items which do not fall under the specified grouping criteria.

setUnspecifiedValuesType

public void setUnspecifiedValuesType(UnspecifiedValuesType unspecifiedValuesType)
Description copied from interface: ISpecifiedGroupOptions
Sets how records that do not fall under the specified grouping criteria are treated. If UnspecifiedValuesType is set, the UnspecifiedValuesName property must contain the name under which extraneous records are listed.

Specified by:
setUnspecifiedValuesType in interface ISpecifiedGroupOptions
Parameters:
unspecifiedValuesType - An UnspecifiedValuesType object that indicates how records that do not fall under the specified grouping criteria are treated.

startElement

public void startElement(java.lang.String eleName,
                         java.util.Map objState,
                         org.xml.sax.Attributes attrs)
Description copied from class: GroupOptions
For internal use only.

Overrides:
startElement in class GroupOptions

enumerateMembers

public void enumerateMembers(IMemberVisitor visitor)
Description copied from class: GroupOptions
For internal use only.

Overrides:
enumerateMembers in class GroupOptions