org.knime.core.data.collection
Class ListCell

java.lang.Object
  org.knime.core.data.DataCell
      org.knime.core.data.collection.ListCell

All Implemented Interfaces:

Serializable, Iterable<DataCell>, CollectionDataValue, ListDataValue, DataValue

public class ListCell
extends DataCell
implements ListDataValue

Default implementation of a CollectionDataValue, whereby the underlying data structure is a list.

Author:

Bernd Wiswedel, University of Konstanz

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.knime.core.data.collection.CollectionDataValue

CollectionDataValue.CollectionUtilityFactory

Nested classes/interfaces inherited from interface org.knime.core.data.DataValue

DataValue.UtilityFactory

Field Summary

Fields inherited from interface org.knime.core.data.collection.CollectionDataValue

UTILITY

Constructor Summary

protected

ListCell(BlobSupportDataCellList list) Rather use one of the factory methods.

Method Summary

boolean	containsBlobWrapperCells() Get whether the collection contains special BlobWrapperDataCell (framework use).
protected boolean	equalsDataCell(DataCell dc) Derived classes implement their specific equals function here.
DataCell	get(int index) Returns the cell at the specified position in the list.
static DataCellSerializer<ListCell>	getCellSerializer() Get serializer as required by DataCell.
static DataType	getCollectionType(DataType elementType) Convenience method to determine the type of collection.
DataType	getElementType() Get the common super type of all elements in this collection.
protected BlobSupportDataCellList	getList()
int	hashCode() This method must be implemented in order to ensure that two equal DataCell objects return the same hash code.
Iterator<DataCell>	iterator()
int	size() Get the number of elements in this collection.
String	toString() Returns the String representation of this cell's value.

Methods inherited from class org.knime.core.data.DataCell

equals, getType, isMissing

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ListCell

protected ListCell(BlobSupportDataCellList list)

Rather use one of the factory methods.

Parameters:

list - the list that will be taken over.

See Also:

CollectionCellFactory.createListCell(Collection), CollectionCellFactory.createListCell(DataRow, int[])

Method Detail

getCollectionType

public static final DataType getCollectionType(DataType elementType)

Convenience method to determine the type of collection. This is a shortcut for DataType.getType(ListCell.class, elementType).

Parameters:

elementType - The type of the elements

Returns:

a DataType representing the collection.

getCellSerializer

public static final DataCellSerializer<ListCell> getCellSerializer()

Get serializer as required by DataCell.

Returns:

Such a serializer.

getElementType

public DataType getElementType()

Get the common super type of all elements in this collection.

Specified by:

getElementType in interface CollectionDataValue

Returns:

The common super type, never null.

iterator

public Iterator<DataCell> iterator()

Specified by:

iterator in interface Iterable<DataCell>

Specified by:

iterator in interface CollectionDataValue

get

public DataCell get(int index)

Returns the cell at the specified position in the list.

Specified by:

get in interface ListDataValue

Parameters:

index - the position of the element to return (first element has index zero).

Returns:

the cell at the specified position in the list

size

public int size()

Get the number of elements in this collection.

Specified by:

size in interface CollectionDataValue

Returns:

size of the collection.

containsBlobWrapperCells

public 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

• The iterator returned by CollectionDataValue.iterator() implements BlobSupportDataCellIterator (which allows the framework to access the BlobWrapperDataCell without touching the contained BlobDataCell (which is an expensive operation) and
• at least one element returned by the iterator is indeed a BlobWrapperDataCell.

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.

Specified by:

containsBlobWrapperCells in interface CollectionDataValue

Returns:

Whether the collection contains blob wrapper cells.

equalsDataCell

protected boolean equalsDataCell(DataCell dc)

Derived classes implement their specific equals function here. The argument is guaranteed to be not null or a missing value, to be of the same class like this.

Specified by:

equalsDataCell in class DataCell

Parameters:

dc - the cell to compare this to

Returns:

true if this is equal to the argument, false if not

hashCode

public int hashCode()

This method must be implemented in order to ensure that two equal DataCell objects return the same hash code.

Specified by:

hashCode in class DataCell

Returns:

the hash code of your specific DataCell

See Also:

Object.hashCode(), DataCell.equals(java.lang.Object)

toString

public String toString()

Returns the String representation of this cell's value.

Specified by:

toString in class DataCell

Returns:

a String representation of this cell's value

getList

protected BlobSupportDataCellList getList()

Returns:

the list