com.crystaldecisions.sdk.occa.report.partsdefinition
Class ReportPartNodes

java.lang.Object
  extended by java.util.AbstractCollection<E>
      extended by java.util.AbstractList<E>
          extended by java.util.Vector
              extended by com.crystaldecisions.sdk.occa.report.partsdefinition.ReportPartNodes
All Implemented Interfaces:
java.io.Serializable, java.lang.Cloneable, java.lang.Iterable, java.util.Collection, java.util.List, java.util.RandomAccess

public class ReportPartNodes
extends java.util.Vector

This class is a collection of ReportPartNode objects. In turn, each ReportPartNode object itself contains a ReportPartNodes collection for defining which report objects to display when the user drills down on the node.

The ReportPartNodes collection is used in a ReportPartsDefinition object.

See the Getting Started > Tutorials section of the Viewer Java SDK Guide for an example of how to use the ReportPartNodes class.

See Also:
Serialized Form

Constructor Summary
ReportPartNodes()
           
 
Method Summary
 void add(ReportPartNode node)
          Adds a ReportPartNode object to the collection.
 boolean containsReportPartIDs(ReportPartIDs ids)
          For internal use only.
 ReportPartIDs findDrillDownParts(java.lang.String name)
          For internal use only.
 ReportPartNode findParentNode(java.lang.String name)
          For internal use only.
 ReportPartIDs getReportPartIDs()
          For internal use only.
 ReportPartNode getReportPartNode(int index)
          Returns a ReportPartNode from the collection using the index position.
 ReportPartNode getReportPartNode(java.lang.String name)
          Returns a ReportPartNode from the collection using the ReportPartNode name.
 int size()
          Returns the number of items in the collection.
 
Methods inherited from class java.util.Vector
add, add, addAll, addAll, addElement, capacity, clear, clone, contains, containsAll, copyInto, elementAt, elements, ensureCapacity, equals, firstElement, get, hashCode, indexOf, indexOf, insertElementAt, isEmpty, lastElement, lastIndexOf, lastIndexOf, remove, remove, removeAll, removeAllElements, removeElement, removeElementAt, retainAll, set, setElementAt, setSize, subList, toArray, toArray, toString, trimToSize
 
Methods inherited from class java.util.AbstractList
iterator, listIterator, listIterator
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface java.util.List
iterator, listIterator, listIterator
 

Constructor Detail

ReportPartNodes

public ReportPartNodes()
Method Detail

add

public void add(ReportPartNode node)
Adds a ReportPartNode object to the collection.

Parameters:
node - A ReportPartNode object to add to the collection.

containsReportPartIDs

public boolean containsReportPartIDs(ReportPartIDs ids)
For internal use only.


findDrillDownParts

public ReportPartIDs findDrillDownParts(java.lang.String name)
For internal use only.


findParentNode

public ReportPartNode findParentNode(java.lang.String name)
For internal use only.


getReportPartIDs

public ReportPartIDs getReportPartIDs()
For internal use only.


getReportPartNode

public ReportPartNode getReportPartNode(int index)
Returns a ReportPartNode from the collection using the index position. The index is zero-based.

Parameters:
index - An int that specifies the index position of the ReportPartNode.
Returns:
An item in the collection as a ReportPartNode.
See Also:
getReportPartNode, size

getReportPartNode

public ReportPartNode getReportPartNode(java.lang.String name)
Returns a ReportPartNode from the collection using the ReportPartNode name.

Parameters:
name - A String that specifies the name of the ReportPartNode.
Returns:
An item in the collection as a ReportPartNode.
See Also:
getReportPartNode, size

size

public int size()
Returns the number of items in the collection.

Specified by:
size in interface java.util.Collection
Specified by:
size in interface java.util.List
Overrides:
size in class java.util.Vector
Returns:
An int that specifies the number of items in the collection.
See Also:
getReportPartNode, getReportPartNode