Enterprise Information Portal APIs

com.ibm.mm.sdk.common
Class DKSegmentedPartsOD

java.lang.Object
  |
  +--com.ibm.mm.sdk.common.DKSequentialCollection
        |
        +--com.ibm.mm.sdk.common.DKParts
              |
              +--com.ibm.mm.sdk.common.DKSegmentedParts
                    |
                    +--com.ibm.mm.sdk.common.DKSegmentedPartsOD
All Implemented Interfaces:
dkCollection, DKConstant, DKMessageId, java.io.Serializable

public class DKSegmentedPartsOD
extends DKSegmentedParts
implements DKConstant, java.io.Serializable

DKSegmentedPartsOD is a subclass of DKSegmentedParts. Its purpose is to hold segments of a large object document. The DDO representing a document has an attribute with reserved name of DKSegmentedParts, its value is a reference to this collection.

DKSegmentedParts inherits the public interface of DKSegmentedParts. In addition to the inherited methods, DKSegmentedPartsOD has two additional methods: getSegment() getSegmentRange().

See Also:
Serialized Form

Fields inherited from interface com.ibm.mm.sdk.common.DKConstant
    For details, see the class or interface
 
Fields inherited from interface com.ibm.mm.sdk.common.DKMessageId
    For details, see the class or interface
 
Constructor Summary
DKSegmentedPartsOD()
          Constructs a DKSegmentedPartsOD object.
 
Method Summary
 void addElement(java.lang.Object element, int pos)
          Adds an element to the specified position within the collection, and invalidates all of the current iterators.
 void addMember(DKDDO item, dkXDO member)
          Add a new member into this parts collection and makes it persistent in the datastore.
 dkIterator createIterator()
          Creates a new iterator for this collection.
 dkXDO getSegment(int pos)
          Gets a segment at positon "pos"
 dkXDO[] getSegmentRange(int startPos, int nSegs)
          Gets a range segments at starting positon "startPos"
 void removeElementAt(dkIterator iter)
          Removes the element the iterator is currently pointing at.
 void removeMember(DKDDO item, dkXDO member)
          Removes a member from this parts collection and reflects the results immediately in the datastore.
 void replaceElementAt(java.lang.Object element, dkIterator iter)
          Replaces the element the iterator is currently pointing at.
 java.lang.Object retrieveElementAt(dkIterator iter)
          Gets the element that the iterator is pointing at.
 void setSegmentCount(int nSegs)
          Sets the total number of segments
 void setSegmentRange(int startPos, dkXDO[] segObjs)
          Sets a range segments at starting positon "startPos" Invalid API for CM OD
 void sort()
          Sorts the elements in this collection.
 void sort(boolean order)
          Sorts the elements in this collection.
 void sort(dkSort sortFunction, boolean sortOrder)
          Sorts the elements in this collection.
 
Methods inherited from class com.ibm.mm.sdk.common.DKSegmentedParts
addElement, cardinality, getAffiliatedTypes, getName, getSegmentCount, getSortFunction, insertElementAt, removeAllElements, setName, setSegment, setSortFunction
 
Methods inherited from class com.ibm.mm.sdk.common.DKSequentialCollection
getAssociatedAttrName, getOwner
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.ibm.mm.sdk.common.dkCollection
addAllElements
 

Constructor Detail

DKSegmentedPartsOD

public DKSegmentedPartsOD()
Constructs a DKSegmentedPartsOD object.
Method Detail

setSegmentCount

public void setSegmentCount(int nSegs)
Sets the total number of segments
Overrides:
setSegmentCount in class DKSegmentedParts
Parameters:
nSegs - number of segments

createIterator

public dkIterator createIterator()
Creates a new iterator for this collection. The default is DKSequentialIterator object.
Overrides:
createIterator in class DKSegmentedParts
Returns:
an iterator

addElement

public void addElement(java.lang.Object element,
                       int pos)
                throws DKUsageError
Adds an element to the specified position within the collection, and invalidates all of the current iterators.
Parameters:
element - element to be added.

getSegment

public dkXDO getSegment(int pos)
                 throws DKException,
                        java.lang.ArrayIndexOutOfBoundsException,
                        java.lang.Exception
Gets a segment at positon "pos"
Overrides:
getSegment in class DKSegmentedParts
Parameters:
pos - index of the segment to be returned
Returns:
dkXDO object containing the segment
Throws:
java.lang.ArrayIndexOutOfBoundsException - if the index "pos" is larger than the total number of segments.

getSegmentRange

public dkXDO[] getSegmentRange(int startPos,
                               int nSegs)
                        throws DKException,
                               java.lang.ArrayIndexOutOfBoundsException,
                               java.lang.Exception
Gets a range segments at starting positon "startPos"
Overrides:
getSegmentRange in class DKSegmentedParts
Parameters:
startPos - index of the starting segment to be returned
nSegs - the number of the segments to be returned
Returns:
an array of dkXDO objects containing the segments
Throws:
java.lang.ArrayIndexOutOfBoundsException - if the index "startPos" or "startPos" plus "nSegs" is larger than the total number of segments.

setSegmentRange

public void setSegmentRange(int startPos,
                            dkXDO[] segObjs)
                     throws DKException,
                            java.lang.Exception
Sets a range segments at starting positon "startPos" Invalid API for CM OD
Overrides:
setSegmentRange in class DKSegmentedParts
Following copied from class: com.ibm.mm.sdk.common.DKSegmentedParts
Parameters:
startPos - index of the starting segment to be set
segObjs - an array of dkXDO objects containing the segments
Throws:
java.lang.ArrayIndexOutOfBoundsException - if the index "startPos" or "startPos" plus length of the inserting array is larger than the total number of segments.

addMember

public void addMember(DKDDO item,
                      dkXDO member)
               throws DKException,
                      java.lang.Exception
Add a new member into this parts collection and makes it persistent in the datastore. Invalid API for CM OD
Overrides:
addMember in class DKSegmentedParts
Following copied from class: com.ibm.mm.sdk.common.DKSegmentedParts
Parameters:
item - the data object that contains this parts collection
member - the member to be added to this parts collection

removeMember

public void removeMember(DKDDO item,
                         dkXDO member)
                  throws DKException,
                         java.lang.Exception
Removes a member from this parts collection and reflects the results immediately in the datastore. Invalid API for CM OD
Overrides:
removeMember in class DKSegmentedParts
Following copied from class: com.ibm.mm.sdk.common.DKSegmentedParts
Parameters:
item - the data object that contains this parts collection
member - thr member to be removed from this parts collection

retrieveElementAt

public java.lang.Object retrieveElementAt(dkIterator iter)
                                   throws DKUsageError
Gets the element that the iterator is pointing at.
Overrides:
retrieveElementAt in class DKSegmentedParts
Parameters:
iter - location in collection to retrieve an object.
Returns:
an element

replaceElementAt

public void replaceElementAt(java.lang.Object element,
                             dkIterator iter)
                      throws DKUsageError
Replaces the element the iterator is currently pointing at. Invalid API for CM OD
Overrides:
replaceElementAt in class DKSegmentedParts
Following copied from class: com.ibm.mm.sdk.common.DKSegmentedParts
Parameters:
element - element to be added.
iter - location in collection.

removeElementAt

public void removeElementAt(dkIterator iter)
                     throws DKUsageError
Removes the element the iterator is currently pointing at. Invalid API for CM OD
Overrides:
removeElementAt in class DKSegmentedParts
Following copied from class: com.ibm.mm.sdk.common.DKSegmentedParts
Parameters:
iter - location in collection .

sort

public void sort()
          throws DKUsageError
Sorts the elements in this collection. Invalid API for CM OD
Overrides:
sort in class DKSegmentedParts
Following copied from class: com.ibm.mm.sdk.common.DKSegmentedParts
See Also:
DKSegmentedParts.sort(dkSort sortFunction, boolean sortOrder)

sort

public void sort(boolean order)
          throws DKUsageError
Sorts the elements in this collection. Invalid API for CM OD
Overrides:
sort in class DKSegmentedParts
Following copied from class: com.ibm.mm.sdk.common.DKSegmentedParts
Parameters:
order - a boolean value indicating the sort order. If true sort in ascending order, otherwise sort in descending order.
See Also:
DKSegmentedParts.sort(dkSort sortFunction, boolean sortOrder)

sort

public void sort(dkSort sortFunction,
                 boolean sortOrder)
          throws DKUsageError
Sorts the elements in this collection. Invalid API for CM OD
Overrides:
sort in class DKSegmentedParts
Following copied from class: com.ibm.mm.sdk.common.DKSegmentedParts
Parameters:
sortFunction - the sort function.
sortOrder - a boolean value indicating the sort order. If true sort in ascending order, otherwise sort in descending order.

EIP Java APIs

(c) Copyright International Business Machines Corporation 1996, 2002. IBM Corp. All rights reserved.