|
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
DKSequentialCollection is a subclass of dkCollection which supports sorting and sequential access in a bi-directional manner, i.e. forward and backward. A sequential collection is not queryable. DKSequentialCollection can create and support DKSequentialIterator, which is also bi-directional.
Fields inherited from interface com.ibm.mm.sdk.common.DKMessageId |
For details, see the class or interface |
Constructor Summary | |
DKSequentialCollection()
Constructs a DKSequentialCollection |
|
DKSequentialCollection(dkSort sortFunction)
Constructs a DKSequentialCollection with the given sort function. |
Method Summary | |
void |
addElement(java.lang.Object element)
Adds an element to the end of the collection, and invalidates all of the current iterators. |
int |
cardinality()
Gets the number of elements in the collection. |
dkIterator |
createIterator()
Creates a new iterator for this collection. |
java.lang.String |
getAssociatedAttrName()
Gets the associated attribute name |
java.lang.String |
getName()
Gets the name of the collection. |
dkDataObjectBase |
getOwner()
Gets the owner data object for this collection. |
dkSort |
getSortFunction()
Gets the sort function. |
void |
insertElementAt(java.lang.Object element,
dkIterator iter)
Adds a new element, after the element the iterator is currently pointing at. |
void |
removeAllElements()
Removes all elements in the collection and invalidates all other iterators. |
void |
removeElementAt(dkIterator iter)
Removes the element the iterator is currently pointing at. |
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 |
setName(java.lang.String name)
Sets the name of the collection. |
void |
setSortFunction(dkSort sortFunction)
Sets the sort function for sorting this collection. |
void |
sort()
Sorts the elements in this collection using the sort function. |
void |
sort(boolean order)
Sorts the elements in this collection in the given order using the sort function. |
void |
sort(dkSort sortFunction,
boolean sortOrder)
Sorts the elements in this collection using the given sort function and sort order. |
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 DKSequentialCollection()
public DKSequentialCollection(dkSort sortFunction)
sortFounction
- sort function.Method Detail |
public int cardinality()
cardinality
in interface dkCollection
public dkIterator createIterator()
createIterator
in interface dkCollection
public java.lang.Object retrieveElementAt(dkIterator iter) throws DKUsageError
retrieveElementAt
in interface dkCollection
iter
- location in collection to retrieve an object.public void addElement(java.lang.Object element) throws DKUsageError
addElement
in interface dkCollection
element
- element to be added.public void insertElementAt(java.lang.Object element, dkIterator iter) throws DKUsageError
insertElementAt
in interface dkCollection
element
- element to be added.iter
- location in collection.public void replaceElementAt(java.lang.Object element, dkIterator iter) throws DKUsageError
replaceElementAt
in interface dkCollection
element
- element to be added.iter
- location in collection.public void removeElementAt(dkIterator iter) throws DKUsageError
removeElementAt
in interface dkCollection
iter
- location in collection .public void removeAllElements() throws DKUsageError
removeAllElements
in interface dkCollection
public void setName(java.lang.String name)
setName
in interface dkCollection
name
- collection name.public java.lang.String getName()
getName
in interface dkCollection
public dkDataObjectBase getOwner()
getOwner
in interface dkCollection
public java.lang.String getAssociatedAttrName()
getAssociatedAttrName
in interface dkCollection
public void setSortFunction(dkSort sortFunction)
sortFunction
- the sort function.public dkSort getSortFunction()
public void sort() throws DKUsageError
sort(dkSort sortFunction, boolean sortOrder)
public void sort(boolean order) throws DKUsageError
order
- a boolean value indicating the sort order.
If true sort in ascending order, otherwise sort in descending order.sort(dkSort sortFunction, boolean sortOrder)
public void sort(dkSort sortFunction, boolean sortOrder) throws DKUsageError
sortFunction
is a function object which defines the method to get
the object key and perform comparison on them.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 |