info.informatica.data
Class EmptyDataset

java.lang.Object
  extended by info.informatica.data.AbstractDataset
      extended by info.informatica.data.GenericDataset
          extended by info.informatica.data.EmptyDataset
All Implemented Interfaces:
Dataset

public final class EmptyDataset
extends GenericDataset

An empty Dataset.

Author:
amengual at informatica dot info

Constructor Summary
EmptyDataset()
           
EmptyDataset(Collection<String> column_names)
           
EmptyDataset(List<String> column_names)
           
 
Method Summary
 Map<FieldName,Object> getMap()
          Gets a name-> values map containing the current data row.
 boolean isAfterLast()
          Retrieves wether the dataset is after its last row.
 boolean isEmpty()
           
 boolean isLast()
          Retrieves wether the dataset is on its last row.
 boolean next()
          Positions the Dataset at the next row of data.
 void reset()
          Puts the Dataset cursor in the initial state, regardless of the current cursor state.
 
Methods inherited from class info.informatica.data.GenericDataset
close, getDate, getDate, getDouble, getDouble, getInt, getInt, getLong, getLong, getMetaData, getNestedSet, getObject, getObject, getString, getString, setMetaData
 
Methods inherited from class info.informatica.data.AbstractDataset
evaluate, findColumn, getCatalogName, getColumnCount, getColumnName, getEnviron, getLabel, setEnviron, setLabel
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

EmptyDataset

public EmptyDataset(List<String> column_names)

EmptyDataset

public EmptyDataset(Collection<String> column_names)

EmptyDataset

public EmptyDataset()
Method Detail

isEmpty

public boolean isEmpty()
                throws DatasetException
Returns:
true if the Dataset is empty, false otherwise.
Throws:
DatasetException

next

public boolean next()
             throws DatasetException
Description copied from interface: Dataset
Positions the Dataset at the next row of data.

Specified by:
next in interface Dataset
Overrides:
next in class AbstractDataset
Returns:
false if there were no more rows, true otherwise.
Throws:
DatasetException - if the data repository produced an error.

isAfterLast

public boolean isAfterLast()
                    throws DatasetException
Description copied from interface: Dataset
Retrieves wether the dataset is after its last row.

Returns:
true if the dataset is after its last row, false otherwise.
Throws:
DatasetException - if the data repository produced an error.

isLast

public boolean isLast()
               throws DatasetException
Description copied from interface: Dataset
Retrieves wether the dataset is on its last row.

Evaluation of this method could be expensive.

Returns:
true if the dataset is on its last row, false otherwise.
Throws:
DatasetException - if the data repository produced an error.

reset

public void reset()
           throws DatasetException
Description copied from interface: Dataset
Puts the Dataset cursor in the initial state, regardless of the current cursor state.

This method allows the reuse of a Dataset object after all rows have been extracted by the use of the next() function.

This method is optional. Implementations are required to throw an UnsupportedOperationException in case they do not implement it.

Throws:
DatasetException - if an error happened when resetting the data.

getMap

public Map<FieldName,Object> getMap()
                             throws DatasetException
Description copied from class: GenericDataset
Gets a name-> values map containing the current data row.

Specified by:
getMap in interface Dataset
Overrides:
getMap in class GenericDataset
Returns:
a Map with the current data row. Cannot return null.
Throws:
DatasetException - if an error happens when creating the Map.