org.knime.core.data.collection
Interface CollectionDataValue

All Superinterfaces:
DataValue, Iterable<DataCell>
All Known Subinterfaces:
ListDataValue, SetDataValue
All Known Implementing Classes:
ListCell, SetCell

public interface CollectionDataValue
extends DataValue, Iterable<DataCell>

Special interface that is implemented by DataCells that represent collection of cells. A detailed description of this interface is given in the new types manual.

Author:
Bernd Wiswedel, University of Konstanz

Nested Class Summary
static class CollectionDataValue.CollectionUtilityFactory
          Implementations of the meta information of this value class.
 
Nested classes/interfaces inherited from interface org.knime.core.data.DataValue
DataValue.UtilityFactory
 
Field Summary
static DataValue.UtilityFactory UTILITY
          Meta information to collection values.
 
Method Summary
 boolean containsBlobWrapperCells()
          Get whether the collection contains special BlobWrapperDataCell (framework use).
 DataType getElementType()
          Get the common super type of all elements in this collection.
 Iterator<DataCell> iterator()
          
 int size()
          Get the number of elements in this collection.
 

Field Detail

UTILITY

static final DataValue.UtilityFactory UTILITY
Meta information to collection values.

See Also:
DataValue.UTILITY
Method Detail

getElementType

DataType getElementType()
Get the common super type of all elements in this collection.

Returns:
The common super type, never null.

size

int size()
Get the number of elements in this collection.

Returns:
size of the collection.

containsBlobWrapperCells

boolean containsBlobWrapperCells()
Get whether the collection contains special BlobWrapperDataCell (framework use). This method gives a hint to the framwork (specifically to the classes DataContainer and BufferedDataContainer) whether they should handle the cell implementing this interface with care with respect to contained BlobDataCell.

This method should return true only if

Implementation note: This method is really only a helper for the framework. The same information can be retrieved by accessing the iterator. This can be an expensive and unnecessary operation, however.

Returns:
Whether the collection contains blob wrapper cells.

iterator

Iterator<DataCell> iterator()

Specified by:
iterator in interface Iterable<DataCell>


Copyright, 2003 - 2010. All rights reserved.
University of Konstanz, Germany.
Chair for Bioinformatics and Information Mining, Prof. Dr. Michael R. Berthold.
You may not modify, publish, transmit, transfer or sell, reproduce, create derivative works from, distribute, perform, display, or in any way exploit any of the content, in whole or in part, except as otherwise expressly permitted in writing by the copyright owner or as specified in the license file distributed with this product.