|
Enterprise Information Portal APIs |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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
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()
.
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 |
public DKSegmentedPartsOD()
Method Detail |
public void setSegmentCount(int nSegs)
setSegmentCount
in class DKSegmentedParts
nSegs
- number of segmentspublic dkIterator createIterator()
createIterator
in class DKSegmentedParts
public void addElement(java.lang.Object element, int pos) throws DKUsageError
element
- element to be added.public dkXDO getSegment(int pos) throws DKException, java.lang.ArrayIndexOutOfBoundsException, java.lang.Exception
getSegment
in class DKSegmentedParts
pos
- index of the segment to be returnedjava.lang.ArrayIndexOutOfBoundsException
- if the index "pos" is larger
than the total number of segments.public dkXDO[] getSegmentRange(int startPos, int nSegs) throws DKException, java.lang.ArrayIndexOutOfBoundsException, java.lang.Exception
getSegmentRange
in class DKSegmentedParts
startPos
- index of the starting segment to be returnednSegs
- the number of the segments to be returnedjava.lang.ArrayIndexOutOfBoundsException
- if the index "startPos" or "startPos"
plus "nSegs" is larger than the total number of segments.public void setSegmentRange(int startPos, dkXDO[] segObjs) throws DKException, java.lang.Exception
setSegmentRange
in class DKSegmentedParts
com.ibm.mm.sdk.common.DKSegmentedParts
startPos
- index of the starting segment to be setsegObjs
- an array of dkXDO objects containing the segmentsjava.lang.ArrayIndexOutOfBoundsException
- if the index "startPos" or "startPos"
plus length of the inserting array is larger than the total number of segments.public void addMember(DKDDO item, dkXDO member) throws DKException, java.lang.Exception
addMember
in class DKSegmentedParts
com.ibm.mm.sdk.common.DKSegmentedParts
item
- the data object that contains this parts collectionmember
- the member to be added to this parts collectionpublic void removeMember(DKDDO item, dkXDO member) throws DKException, java.lang.Exception
removeMember
in class DKSegmentedParts
com.ibm.mm.sdk.common.DKSegmentedParts
item
- the data object that contains this parts collectionmember
- thr member to be removed from this parts collectionpublic java.lang.Object retrieveElementAt(dkIterator iter) throws DKUsageError
retrieveElementAt
in class DKSegmentedParts
iter
- location in collection to retrieve an object.public void replaceElementAt(java.lang.Object element, dkIterator iter) throws DKUsageError
replaceElementAt
in class DKSegmentedParts
com.ibm.mm.sdk.common.DKSegmentedParts
element
- element to be added.iter
- location in collection.public void removeElementAt(dkIterator iter) throws DKUsageError
removeElementAt
in class DKSegmentedParts
com.ibm.mm.sdk.common.DKSegmentedParts
iter
- location in collection .public void sort() throws DKUsageError
sort
in class DKSegmentedParts
com.ibm.mm.sdk.common.DKSegmentedParts
DKSegmentedParts.sort(dkSort sortFunction, boolean sortOrder)
public void sort(boolean order) throws DKUsageError
sort
in class DKSegmentedParts
com.ibm.mm.sdk.common.DKSegmentedParts
order
- a boolean value indicating the sort order.
If true sort in ascending order, otherwise sort in descending order.DKSegmentedParts.sort(dkSort sortFunction, boolean sortOrder)
public void sort(dkSort sortFunction, boolean sortOrder) throws DKUsageError
sort
in class DKSegmentedParts
com.ibm.mm.sdk.common.DKSegmentedParts
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 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |