|
Enterprise Information Portal APIs |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
dkCollection is a base interface to a collection of any type of objects. A collection may have a name, the default is an empty string. It can be set to anything; for example, the name of the Digital Library index class where the members belong.
dkCollection is not queryable, and only supports dkIterator, the base class for all iterators.
Method Summary | |
void |
addAllElements(dkCollection elements)
Adds all elements in the collection, and invalidates all current iterators. |
void |
addElement(java.lang.Object element)
Adds an element to the end of the collection, and invalidates all 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. |
void |
insertElementAt(java.lang.Object element,
dkIterator where)
Adds a new element, after the element the iterator is currently pointing at. |
void |
removeAllElements()
Removes all elements in the collection and invalidates all iterators. |
void |
removeElementAt(dkIterator where)
Removes the element the iterator is currently pointing at. |
void |
replaceElementAt(java.lang.Object element,
dkIterator where)
Replaces the element the iterator is currently pointing at. |
java.lang.Object |
retrieveElementAt(dkIterator where)
Gets the element that the iterator is pointing at. |
void |
setName(java.lang.String name)
Sets the name of the collection. |
Method Detail |
public int cardinality()
public dkIterator createIterator()
public java.lang.Object retrieveElementAt(dkIterator where) throws DKUsageError
where
- the iterator for this collection pointing to the element.public void addElement(java.lang.Object element) throws DKUsageError
element
- element to be addedpublic void addAllElements(dkCollection elements) throws DKUsageError
elements
- collection of elements to be addedpublic void insertElementAt(java.lang.Object element, dkIterator where) throws DKUsageError
element
- element to be addedwhere
- location in collectionpublic void replaceElementAt(java.lang.Object element, dkIterator where) throws DKUsageError
element
- element to be addedwhere
- location in collectionpublic void removeElementAt(dkIterator where) throws DKUsageError
where
- location in collection.public void removeAllElements() throws DKUsageError
public void setName(java.lang.String name)
name
- collection name.public java.lang.String getName()
public dkDataObjectBase getOwner()
public java.lang.String getAssociatedAttrName()
|
EIP Java APIs | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |