Package org.supercsv.cellprocessor
Class Collector
- java.lang.Object
-
- org.supercsv.cellprocessor.CellProcessorAdaptor
-
- org.supercsv.cellprocessor.Collector
-
- All Implemented Interfaces:
BoolCellProcessor
,CellProcessor
,DateCellProcessor
,DoubleCellProcessor
,LongCellProcessor
,StringCellProcessor
public class Collector extends CellProcessorAdaptor implements BoolCellProcessor, DateCellProcessor, DoubleCellProcessor, LongCellProcessor, StringCellProcessor
This processor collects each value it encounters and adds it to the supplied Collection. You could supply a Set to collect all of the unique values for a column, or a List to collect every value in a column in order. Just remember that the larger your CSV file, the larger this Collection will be, so use with caution!- Since:
- 2.1.0
- Author:
- James Bassett
-
-
Field Summary
-
Fields inherited from class org.supercsv.cellprocessor.CellProcessorAdaptor
next
-
-
Constructor Summary
Constructors Constructor Description Collector(java.util.Collection<java.lang.Object> collection)
Constructs a new Collector, which collects each value it encounters and adds it to the supplied Collection.Collector(java.util.Collection<java.lang.Object> collection, CellProcessor next)
Constructs a new Collector, which collects each value it encounters, adds it to the supplied Collection, then calls the next processor in the chain.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.Object
execute(java.lang.Object value, CsvContext context)
This method is invoked by the framework when the processor needs to process data or check constraints.java.util.Collection<java.lang.Object>
getCollection()
Gets the collection of collected values.-
Methods inherited from class org.supercsv.cellprocessor.CellProcessorAdaptor
toString, validateInputNotNull
-
-
-
-
Constructor Detail
-
Collector
public Collector(java.util.Collection<java.lang.Object> collection)
Constructs a new Collector, which collects each value it encounters and adds it to the supplied Collection.- Parameters:
collection
- the collection to add to- Throws:
java.lang.NullPointerException
- if collection is null
-
Collector
public Collector(java.util.Collection<java.lang.Object> collection, CellProcessor next)
Constructs a new Collector, which collects each value it encounters, adds it to the supplied Collection, then calls the next processor in the chain.- Parameters:
collection
- the collection to add tonext
- the next processor in the chain- Throws:
java.lang.NullPointerException
- if collection or next is null
-
-
Method Detail
-
execute
public java.lang.Object execute(java.lang.Object value, CsvContext context)
This method is invoked by the framework when the processor needs to process data or check constraints.- Specified by:
execute
in interfaceCellProcessor
- Parameters:
value
- the value to be processedcontext
- the CSV context- Returns:
- the result of cell processor execution
-
getCollection
public java.util.Collection<java.lang.Object> getCollection()
Gets the collection of collected values.- Returns:
- the collection of collected values
-
-