|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjava.util.AbstractCollection<E>
java.util.AbstractList<E>
java.util.ArrayList<E>
com.crystaldecisions.sdk.occa.report.lib.ClonableList<E>
com.crystaldecisions.sdk.occa.report.lib.ControllableList<E>
com.crystaldecisions.sdk.occa.report.lib.ReportSDKVector<java.lang.Object>
com.crystaldecisions.sdk.occa.report.data.GroupPath
public class GroupPath
This object 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.
When possible, use the interface IGroupPath
to manipulate the
GroupPath
object.
Constructor Summary | |
---|---|
GroupPath()
|
|
GroupPath(GroupPath src)
|
Method Summary | |
---|---|
void |
copyTo(java.lang.Object destObject,
boolean deepCopy)
Copies the contents of the object into the object specified by the first parameter. |
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 |
fromString(java.lang.String stringValue)
This method accepts a new group path string, parses it, and updates the Item array. |
boolean |
getByValue()
For internal use only. |
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). |
boolean |
hasContent(java.lang.Object destObj)
Searches this GroupPath object to see if it contains the specified
Object . |
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 |
setByValue(boolean byValue)
For internal use only. |
void |
startElement(java.lang.String eleName,
java.util.Map objState,
org.xml.sax.Attributes attrs)
For internal use only. |
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 class com.crystaldecisions.sdk.occa.report.lib.ReportSDKVector |
---|
add, add, addElement, elementAt, insertElementAt, isDirectlyControllable, removeAllElements |
Methods inherited from class com.crystaldecisions.sdk.occa.report.lib.ControllableList |
---|
addAll, addAll, clear, doControllerModification, enumerateMembers, getControllableMixin, iterator, listIterator, listIterator, remove, remove, removeAll, retainAll, set, subList |
Methods inherited from class com.crystaldecisions.sdk.occa.report.lib.ClonableList |
---|
clone, findIndexOf |
Methods inherited from class java.util.ArrayList |
---|
clone, contains, ensureCapacity, get, indexOf, isEmpty, lastIndexOf, size, toArray, toArray, trimToSize |
Methods inherited from class java.util.AbstractList |
---|
equals, hashCode |
Methods inherited from class java.util.AbstractCollection |
---|
containsAll |
Methods inherited from class java.lang.Object |
---|
getClass, notify, notifyAll, wait, wait, wait |
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 |
Constructor Detail |
---|
public GroupPath(GroupPath src)
public GroupPath()
Method Detail |
---|
public void copyTo(java.lang.Object destObject, boolean deepCopy)
Copies the contents of the object into the object specified by the first parameter.
copyTo
in class ControllableList<java.lang.Object>
destObject
- The object that will contain a copy.deepCopy
- true
if the method is to copy objects that are referenced by
the object and false
otherwise. If deepCopy
is
false
and the object references other objects or collections, these
objects and/or collections will not be copied; a reference to the objects
referenced by the object will be kept though. If deepCopy
is
false
and you modify the destObject
parameter, the
original object reflects these changes.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.
createMember
in class ClonableList<java.lang.Object>
public void endElement(java.lang.String eleName, java.util.Map objState)
For internal use only.
endElement
in class ClonableList<java.lang.Object>
public void fromString(java.lang.String stringValue)
IGroupPath
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.
fromString
in interface IGroupPath
stringValue
- The new group path as a String
.public java.lang.Object getQualifierItem(int index)
IGroupPath
Returns the qualifier part of the group name path (for example, /Country[USA] will return Country).
getQualifierItem
in interface IGroupPath
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.
public java.lang.Object getValueItem(int index)
IGroupPath
Returns the value part of the group name path (for example, /Country[USA] will return USA).
getValueItem
in interface IGroupPath
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.
public boolean hasContent(java.lang.Object destObj)
Searches this GroupPath
object to see if it contains the specified
Object
.
hasContent
in class ClonableList<java.lang.Object>
destObj
- The Object
to search for.
true
if this collection contains the specified Object
,
false
otherwise.public void readElement(java.lang.String eleName, java.lang.String sVal, org.xml.sax.Attributes attrs, java.util.Map objState)
For internal use only.
readElement
in class ClonableList<java.lang.Object>
public void save(XMLWriter writer, XMLSerializationContext ctxt) throws java.io.IOException
For internal use only.
save
in class ClonableList<java.lang.Object>
java.io.IOException
public void save(XMLWriter writer, java.lang.String sTag, XMLSerializationContext ctxt) throws java.io.IOException
For internal use only.
save
in class ClonableList<java.lang.Object>
java.io.IOException
public void saveContents(XMLWriter writer, XMLSerializationContext ctxt) throws java.io.IOException
For internal use only.
saveContents
in class ClonableList<java.lang.Object>
java.io.IOException
public void startElement(java.lang.String eleName, java.util.Map objState, org.xml.sax.Attributes attrs)
For internal use only.
startElement
in class ClonableList<java.lang.Object>
public int[] toIntArray()
IGroupPath
Returns the group path in an int
array format.
toIntArray
in interface IGroupPath
int
values that represent
the group path.public java.lang.String toString()
IGroupPath
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.
toString
in interface IGroupPath
toString
in class java.util.AbstractCollection<java.lang.Object>
String.
public boolean getByValue()
For internal use only.
public void setByValue(boolean byValue)
For internal use only.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |