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

java.lang.Object
  extended by com.crystaldecisions.sdk.occa.report.data.TotallerNode
All Implemented Interfaces:
ITotallerNode, IClone

public class TotallerNode
extends java.lang.Object
implements ITotallerNode, IClone

This object implements a node from the totaller tree. A totaller node contains the records for a particular group in the report. Since groups may contain groups, a node may contains child nodes: the getChildren() method is used for this purpose. When possible, use the ITotallerNode interface to manipulate this object.


Constructor Summary
TotallerNode()
           
TotallerNode(ITotallerNode 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, com.crystaldecisions.xml.serialization.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.
 TotallerNodes getChildren()
           Returns the node's subnodes.
 int getFirstRecordKey()
           Returns the key from the first record that the node contains.
 IGroupPath getGroupPath()
           Returns the path of the node in the totaller tree.
 java.lang.String getName()
           Returns the name of the node.
 TotallerNodeOptions getOptions()
           Returns the options for the totaller node.
 int getRecordCount()
           Returns the number of records that the node contains.
 boolean hasContent(java.lang.Object srcNode)
           
 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(com.crystaldecisions.xml.serialization.XMLWriter writer, com.crystaldecisions.xml.serialization.XMLSerializationContext ctxt)
           For internal use only.
 void save(com.crystaldecisions.xml.serialization.XMLWriter writer, java.lang.String sTag, com.crystaldecisions.xml.serialization.XMLSerializationContext ctxt)
           For internal use only.
 void saveContents(com.crystaldecisions.xml.serialization.XMLWriter writer, com.crystaldecisions.xml.serialization.XMLSerializationContext ctxt)
           For internal use only.
 void setChildren(TotallerNodes newVal)
           Sets the node's subnodes.
 void setFirstRecordKey(int newVal)
           Sets the key from the first record that the node contains.
 void setGroupPath(IGroupPath newVal)
           Sets the path of the node in the totaller tree.
 void setName(java.lang.String name)
           Sets the name of the node.
 void setOptions(TotallerNodeOptions newVal)
           Sets the options for the totaller node.
 void setRecordCount(int newVal)
           Sets the number of records that the node contains.
 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

TotallerNode

public TotallerNode(ITotallerNode src)

TotallerNode

public TotallerNode()
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,
                                     com.crystaldecisions.xml.serialization.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.


getChildren

public TotallerNodes getChildren()
Description copied from interface: ITotallerNode

Returns the node's subnodes.

Specified by:
getChildren in interface ITotallerNode
Returns:
A TotallerNodes object containing the node's subnodes.

getFirstRecordKey

public int getFirstRecordKey()
Description copied from interface: ITotallerNode

Returns the key from the first record that the node contains.

Specified by:
getFirstRecordKey in interface ITotallerNode
Returns:
An int that specifies the key from the first record that the node contains.

getGroupPath

public IGroupPath getGroupPath()
Description copied from interface: ITotallerNode

Returns the path of the node in the totaller tree.

Specified by:
getGroupPath in interface ITotallerNode
Returns:
An IGroupPath object containing the path of the node in the totaller tree.

getName

public java.lang.String getName()
Description copied from interface: ITotallerNode

Returns the name of the node. This is equivalent to the group's name.

Specified by:
getName in interface ITotallerNode
Returns:
A String containing the name of the node.

getOptions

public TotallerNodeOptions getOptions()
Description copied from interface: ITotallerNode

Returns the options for the totaller node.

Specified by:
getOptions in interface ITotallerNode
Returns:
A TotallerNodeOptions object containing the options for the totaller node.

getRecordCount

public int getRecordCount()
Description copied from interface: ITotallerNode

Returns the number of records that the node contains.

Specified by:
getRecordCount in interface ITotallerNode
Returns:
An int that specifies the number of records that the node contains.

hasContent

public boolean hasContent(java.lang.Object srcNode)

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(com.crystaldecisions.xml.serialization.XMLWriter writer,
                 com.crystaldecisions.xml.serialization.XMLSerializationContext ctxt)
          throws java.io.IOException

For internal use only.

Throws:
java.io.IOException

save

public void save(com.crystaldecisions.xml.serialization.XMLWriter writer,
                 java.lang.String sTag,
                 com.crystaldecisions.xml.serialization.XMLSerializationContext ctxt)
          throws java.io.IOException

For internal use only.

Throws:
java.io.IOException

saveContents

public void saveContents(com.crystaldecisions.xml.serialization.XMLWriter writer,
                         com.crystaldecisions.xml.serialization.XMLSerializationContext ctxt)
                  throws java.io.IOException

For internal use only.

Throws:
java.io.IOException

setChildren

public void setChildren(TotallerNodes newVal)
Description copied from interface: ITotallerNode

Sets the node's subnodes.

Specified by:
setChildren in interface ITotallerNode
Parameters:
newVal - A TotallerNodes object containing the node's subnodes.

setFirstRecordKey

public void setFirstRecordKey(int newVal)
Description copied from interface: ITotallerNode

Sets the key from the first record that the node contains.

Specified by:
setFirstRecordKey in interface ITotallerNode
Parameters:
newVal - An int that specifies the key from the first record that the node contains.

setGroupPath

public void setGroupPath(IGroupPath newVal)
Description copied from interface: ITotallerNode

Sets the path of the node in the totaller tree.

Specified by:
setGroupPath in interface ITotallerNode
Parameters:
newVal - An IGroupPath object containing the path of the node in the totaller tree.

setName

public void setName(java.lang.String name)
Description copied from interface: ITotallerNode

Sets the name of the node. This is equivalent to the group's name.

Specified by:
setName in interface ITotallerNode
Parameters:
name - A String containing the name of the node.

setOptions

public void setOptions(TotallerNodeOptions newVal)
Description copied from interface: ITotallerNode

Sets the options for the totaller node.

Specified by:
setOptions in interface ITotallerNode
Parameters:
newVal - A TotallerNodeOptions object containing the options for the totaller node.

setRecordCount

public void setRecordCount(int newVal)
Description copied from interface: ITotallerNode

Sets the number of records that the node contains.

Specified by:
setRecordCount in interface ITotallerNode
Parameters:
newVal - An int that specifies the number of records that the node contains.

startElement

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

For internal use only.