opencsv 5.12.0 · com.opencsv.bean.FieldMapByPosition

Modifier and Type	Field and Description
private int	maxIndex
private Comparator<Integer>	writeOrder Holds a `java.util.Comparator` to sort columns on writing.

Access	Constructor and Description
public	FieldMapByPosition(final Locale The locale to be used for error messages errorLocale) Initializes this `FieldMap`.

Method Summary

Modifier and Type	Method and Description
public String[]	generateHeader(final T bean) Implements com.opencsv.bean.FieldMap.generateHeader. This method generates a header that can be used for writing beans of the type provided back to a file.
public Iterator<FieldMapByPositionEntry<T>>	iterator() Implements java.lang.Iterable.iterator. Returns an iterator over elements of type `T`.
public void	putComplex(final String A string describing the column positions to be matched. rangeDefinition, final BeanField<T, Integer> field) Implements com.opencsv.bean.FieldMap.putComplex. Adds a `BeanField` to this map indexed by the data in `initializer`.
public void	setColumnOrderOnWrite(Comparator<Integer> The `java.util.Comparator` to use. May be `null`, in which case the natural ordering is used. writeOrder) Sets the `java.util.Comparator` to be used to sort columns when writing beans to a CSV file.
public void	setMaxIndex(int The maximum index in the data being imported maxIndex) Sets the maximum index for all ranges specified in the entire field map.

Inherited from com.opencsv.bean.AbstractFieldMap:: get put setErrorLocale values

maxIndex	back to summary
private int maxIndex

writeOrder	back to summary
private Comparator<Integer> writeOrder Holds a `java.util.Comparator` to sort columns on writing.

FieldMapByPosition	back to summary
public FieldMapByPosition(final Locale errorLocale) Initializes this `FieldMap`. Parameters errorLocale:Locale The locale to be used for error messages

Method Detail

generateHeader back to summary

generateHeader	back to summary
public String[] generateHeader(final T bean) throws CsvRequiredFieldEmptyException Implements com.opencsv.bean.FieldMap.generateHeader. This method generates a header that can be used for writing beans of the type provided back to a file. The ordering of the headers can be determined with the `java.util.Comparator` passed in to `setColumnOrderOnWrite(Comparator)`. Otherwise, it is ascending according to position. Annotations @Override Exceptions CsvRequiredFieldEmptyException: Doc from com.opencsv.bean.FieldMap.generateHeader. If a required header is missing while attempting to write. Since every other header is hard-wired through the bean fields and their associated annotations, this can only happen with multi-valued fields.

public String[] generateHeader(final T bean) throws CsvRequiredFieldEmptyException

Implements com.opencsv.bean.FieldMap.generateHeader.

This method generates a header that can be used for writing beans of the type provided back to a file. The ordering of the headers can be determined with the java.util.Comparator passed in to setColumnOrderOnWrite(Comparator). Otherwise, it is ascending according to position.

Annotations

@Override

Exceptions

CsvRequiredFieldEmptyException:

Doc from com.opencsv.bean.FieldMap.generateHeader.

If a required header is missing while attempting to write. Since every other header is hard-wired through the bean fields and their associated annotations, this can only happen with multi-valued fields.

iterator back to summary

iterator	back to summary
public Iterator<FieldMapByPositionEntry<T>> iterator() Implements java.lang.Iterable.iterator. Doc from java.lang.Iterable.iterator. Returns an iterator over elements of type `T`. Annotations @Override

public Iterator<FieldMapByPositionEntry<T>> iterator()

Implements java.lang.Iterable.iterator.

Doc from java.lang.Iterable.iterator.

Returns an iterator over elements of type T.

Annotations

@Override

putComplex back to summary

putComplex	back to summary
public void putComplex(final String rangeDefinition, final BeanField<T, Integer> field) Implements com.opencsv.bean.FieldMap.putComplex. Doc from com.opencsv.bean.FieldMap.putComplex. Adds a `BeanField` to this map indexed by the data in `initializer`. This is what makes this map special: It allows one to define characteristics of a method to match multiple keys. Parameters rangeDefinition:String A string describing the column positions to be matched. Annotations @Override See Also `CsvBindAndJoinByPosition#position()`

public void putComplex(final String rangeDefinition, final BeanField<T, Integer> field)

Implements com.opencsv.bean.FieldMap.putComplex.

Doc from com.opencsv.bean.FieldMap.putComplex.

Adds a BeanField to this map indexed by the data in initializer. This is what makes this map special: It allows one to define characteristics of a method to match multiple keys.

Parameters

rangeDefinition:String: A string describing the column positions to be matched.

Annotations

@Override

See Also

CsvBindAndJoinByPosition#position()

setColumnOrderOnWrite back to summary

setColumnOrderOnWrite	back to summary
public void setColumnOrderOnWrite(Comparator<Integer> writeOrder) Sets the `java.util.Comparator` to be used to sort columns when writing beans to a CSV file. Parameters writeOrder:Comparator<Integer> The `java.util.Comparator` to use. May be `null`, in which case the natural ordering is used. Since 4.3

public void setColumnOrderOnWrite(Comparator<Integer> writeOrder)

Sets the java.util.Comparator to be used to sort columns when writing beans to a CSV file.

Parameters

writeOrder:Comparator<Integer>: The java.util.Comparator to use. May be null, in which case the natural ordering is used.

Since

4.3

setMaxIndex back to summary

setMaxIndex	back to summary
public void setMaxIndex(int maxIndex) Sets the maximum index for all ranges specified in the entire field map. No ranges or mappings are ever removed so as to preserve information about required fields, but upper boundries are shortened as much as possible. If ranges or individual column positions were specified that lie wholly above `maxIndex`, these are preserved, though ranges are shortened to a single value (the lower boundry). Parameters maxIndex:int The maximum index in the data being imported

public void setMaxIndex(int maxIndex)

Sets the maximum index for all ranges specified in the entire field map. No ranges or mappings are ever removed so as to preserve information about required fields, but upper boundries are shortened as much as possible. If ranges or individual column positions were specified that lie wholly above maxIndex, these are preserved, though ranges are shortened to a single value (the lower boundry).

Parameters

maxIndex:int: The maximum index in the data being imported

public Class FieldMapByPosition<T>

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail