com.crystaldecisions.sdk.occa.report.data
Interface IGroupPath

All Superinterfaces:
java.util.Collection<java.lang.Object>, IClone, java.lang.Iterable<java.lang.Object>, java.util.List<java.lang.Object>
All Known Implementing Classes:
GroupPath

public interface IGroupPath
extends java.util.List<java.lang.Object>, IClone

This interface is used to identify the location of a node in the totaller tree. In a string format, the group path is represented by a group path name or a string of numbers separated by a dash. The group path string is stored as an array.

There are two ways to modify the group path: Retrieve the path using the toString() method, modify the string, and store it using the fromString(java.lang.String) method. You can manipulate the items contained in this object by using the add, remove, and getItem methods inherited from java.util.List.

Note:This will not alter the totaller tree, only the GroupPath object, even if you have retrieved the group path from a totaller node.


Method Summary
 void fromString(java.lang.String stringValue)
          This method accepts a new group path string, parses it, and updates the Item array.
 java.lang.Object getQualifierItem(int index)
          Returns the qualifier part of the group name path (for example, /Country[USA] will return Country).
 java.lang.Object getValueItem(int index)
          Returns the value part of the group name path (for example, /Country[USA] will return USA).
 int[] toIntArray()
          Returns the group path in an int array format.
 java.lang.String toString()
          Returns the group path in a string format.
 
Methods inherited from interface java.util.List
add, add, addAll, addAll, clear, contains, containsAll, equals, get, hashCode, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, retainAll, set, size, subList, toArray, toArray
 

Method Detail

fromString

void fromString(java.lang.String stringValue)

This method accepts a new group path string, parses it, and updates the Item array. You may use this method, or any of the methods that act on the item array, to modify the group path.

Parameters:
stringValue - The new group path as a String.

getQualifierItem

java.lang.Object getQualifierItem(int index)

Returns the qualifier part of the group name path (for example, /Country[USA] will return Country).

Parameters:
index - The position of the node in the tree, as it is represented in the group path string. For example, if the group string is /Country[USA]/ Region[California]/City[Los Angeles], then the value 2 returns City.
Returns:
The qualifier part of the group name as an object.

getValueItem

java.lang.Object getValueItem(int index)

Returns the value part of the group name path (for example, /Country[USA] will return USA).

Parameters:
index - The position of the node in the tree, as it is represented in the group path string. For example, if the group string is /Country[USA]/ Region[California]/City[Los Angeles], then the value 2 returns City.
Returns:
java.lang.Object

toIntArray

int[] toIntArray()

Returns the group path in an int array format.

Returns:
An array of int values that represent the group path.

toString

java.lang.String toString()

Returns the group path in a string format. The string value can be either a group path name (for example, /Canada/BC/Vancouver) or a series of numbers indicating each segment of the path in the group from the top-most node to the node represented by the group path. The numbers are separated by a dash.

Overrides:
toString in class java.lang.Object
Returns:
The group path as a String.