Top Description Inners Constructors Methods
com.opencsv.bean

public Class FuzzyMappingStrategy<T>

extends HeaderColumnNameMappingStrategy<T>
Class Inheritance
Type Parameters
<T>
The type of bean being processed
Imports
com.opencsv.CSVReader, com.opencsv.exceptions.CsvRequiredFieldEmptyException, org.apache.commons.collections4.ListValuedMap, org.apache.commons.lang3.StringUtils, org.apache.commons.text.similarity.LevenshteinDistance, java.io.IOException, java.lang.reflect.Field, java.util.LinkedList, .List, .Objects, .Set, java.util.stream.Collectors, .Stream

A mapping strategy that tries to make the best match between header names and non-annotated member variables.
Author
Andrew Rucker Jones
Since
5.0

Nested and Inner Type Summary

Modifier and TypeClass and Description
private static class
FuzzyMappingStrategy.FuzzyComparison

This is a simple class for grouping header name, member variable name, and the result of fuzzy matching in one sortable place.

Constructor Summary

AccessConstructor and Description
public
FuzzyMappingStrategy()

Nullary constructor.

public
FuzzyMappingStrategy(boolean
If set, every record will be shortened or lengthened to match the number of headers
forceCorrectRecordLength
)

Constructor to allow setting options for header name mapping.

Method Summary

Modifier and TypeMethod and Description
public void
captureHeader(CSVReader reader)

Overrides com.opencsv.bean.HeaderNameBaseMappingStrategy.captureHeader.

Implements com.opencsv.bean.MappingStrategy.captureHeader.

Implementation of this method can grab the header line before parsing begins to use to map columns to bean properties.

protected void
loadUnadornedFieldMap(ListValuedMap<Class<?>, Field> fields)

Overrides com.opencsv.bean.HeaderNameBaseMappingStrategy.loadUnadornedFieldMap.

This implementation intentionally does nothing in order to allow fuzzy matching in case there are no annotations at all in the class in question.

Inherited from com.opencsv.bean.HeaderColumnNameMappingStrategy:
getBindingAnnotationsloadAnnotatedFieldMap

Constructor Detail

FuzzyMappingStrategyback to summary
public FuzzyMappingStrategy()

Nullary constructor. Considered stable.

See Also
FuzzyMappingStrategyBuilder
FuzzyMappingStrategyback to summary
public FuzzyMappingStrategy(boolean forceCorrectRecordLength)

Constructor to allow setting options for header name mapping. Not considered stable. As new options are introduced for the mapping strategy, they will be introduced here. You are encouraged to use FuzzyMappingStrategyBuilder.

Parameters
forceCorrectRecordLength:boolean

If set, every record will be shortened or lengthened to match the number of headers

See Also
FuzzyMappingStrategyBuilder

Method Detail

captureHeaderback to summary
public void captureHeader(CSVReader reader) throws IOException, CsvRequiredFieldEmptyException

Overrides com.opencsv.bean.HeaderNameBaseMappingStrategy.captureHeader.

Implements com.opencsv.bean.MappingStrategy.captureHeader.

Doc from com.opencsv.bean.MappingStrategy.captureHeader.

Implementation of this method can grab the header line before parsing begins to use to map columns to bean properties.

Annotations
@Override
Exceptions
IOException:
If parsing fails
CsvRequiredFieldEmptyException:
If a field is required, but the header or column position for the field is not present in the input
loadUnadornedFieldMapback to summary
protected void loadUnadornedFieldMap(ListValuedMap<Class<?>, Field> fields)

Overrides com.opencsv.bean.HeaderNameBaseMappingStrategy.loadUnadornedFieldMap.

This implementation intentionally does nothing in order to allow fuzzy matching in case there are no annotations at all in the class in question.

Annotations
@Override
com.opencsv.bean back to summary

private Class FuzzyMappingStrategy.FuzzyComparison

extends Object
implements Comparable<FuzzyMappingStrategy.FuzzyComparison>
Class Inheritance
All Implemented Interfaces
java.lang.Comparable

This is a simple class for grouping header name, member variable name, and the result of fuzzy matching in one sortable place.

Field Summary

Modifier and TypeField and Description
pack-priv final Integer
pack-priv final Field
pack-priv final String
pack-priv final Class<?>

Constructor Summary

AccessConstructor and Description
pack-priv
FuzzyComparison(Integer distance, String header, Class<?> type, Field field)

Method Summary

Modifier and TypeMethod and Description
public int
compareTo(FuzzyMappingStrategy.FuzzyComparison o)

Implements java.lang.Comparable.compareTo.

Compares this object with the specified object for order.

public boolean
equals(Object o)

Overrides java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.

Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAlltoStringwaitwaitwait

Field Detail

distanceback to summary
pack-priv final Integer distance
fieldback to summary
pack-priv final Field field
headerback to summary
pack-priv final String header
typeback to summary
pack-priv final Class<?> type

Constructor Detail

FuzzyComparisonback to summary
pack-priv FuzzyComparison(Integer distance, String header, Class<?> type, Field field)

Method Detail

compareToback to summary
public int compareTo(FuzzyMappingStrategy.FuzzyComparison o)

Implements java.lang.Comparable.compareTo.

Doc from java.lang.Comparable.compareTo.

Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

The implementor must ensure signum(x.compareTo(y)) == -signum(y.compareTo(x)) for all x and y. (This implies that x.compareTo(y) must throw an exception if and only if y.compareTo(x) throws an exception.)

The implementor must also ensure that the relation is transitive: (x.compareTo(y) > 0 && y.compareTo(z) > 0) implies x.compareTo(z) > 0.

Finally, the implementor must ensure that x.compareTo(y)==0 implies that signum(x.compareTo(z)) == signum(y.compareTo(z)), for all z.

Annotations
@Override
equalsback to summary
public boolean equals(Object o)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Annotations
@Override
hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
Annotations
@Override