public interface ColumnMapper extends Cloneable
Parsed
or
Nested
.
Mappings defined manually take precedence over annotations.ColumnMapping
Modifier and Type | Method and Description |
---|---|
void |
attributesToColumnNames(Map<String,String> mappings)
Maps multiple attributes to multiple column names.
|
void |
attributesToColumns(Map<String,Enum<?>> mappings)
Maps multiple attributes to multiple columns.
|
void |
attributesToIndexes(Map<String,Integer> mappings)
Maps multiple attributes to multiple column positions.
|
void |
attributeToColumn(String attributeName,
Enum<?> column)
Maps an attribute to a column.
|
void |
attributeToColumnName(String attributeName,
String columnName)
Maps an attribute to a column name.
|
void |
attributeToIndex(String attributeName,
int columnIndex)
Maps an attribute to a column position.
|
ColumnMapper |
clone()
Creates a deep copy of this object with all its mappings.
|
void |
methodsToColumnNames(Map<String,String> mappings)
Maps multiple methods to multiple column names.
|
void |
methodsToColumns(Map<String,Enum<?>> mappings)
Maps multiple methods to multiple columns.
|
void |
methodsToIndexes(Map<String,Integer> mappings)
Maps multiple methods to multiple column positions.
|
void |
methodToColumn(String setterName,
Class<?> parameterType,
Enum<?> column)
Maps a setter method to a column.
|
void |
methodToColumn(String methodName,
Enum<?> column)
Maps a method to a column.
|
void |
methodToColumnName(String setterName,
Class<?> parameterType,
String columnName)
Maps a setter method to a column name.
|
void |
methodToColumnName(String methodName,
String columnName)
Maps a method to a column name.
|
void |
methodToIndex(String setterName,
Class<?> parameterType,
int columnIndex)
Maps a setter method to a column position.
|
void |
methodToIndex(String methodName,
int columnIndex)
Maps a method to a column position.
|
void |
remove(String methodOrAttributeName)
Removes any mappings that target a given method or attribute name.
|
void attributeToColumnName(String attributeName, String columnName)
attributeName
- the name of the attribute.
Use the dot character to access attributes of nested objects,
e.g. contact.mobile
will target the attribute "mobile"
from a Contact attribute inside a Customer class.columnName
- the name of the column that:
(a) when parsing, will be read from to populate the given attribute of an object;
(b) when writing, will receive the value of the given attribute of an object;void attributeToColumn(String attributeName, Enum<?> column)
attributeName
- the name of the attribute.
Use the dot character to access attributes of nested objects,
e.g. contact.mobile
will target the attribute "mobile"
from a Contact attribute inside a Customer class.column
- an enumeration representing the column that:
(a) when parsing, will be read from to populate the given attribute of an object;
(b) when writing, will receive the value of the given attribute of an object;void attributeToIndex(String attributeName, int columnIndex)
attributeName
- the name of the attribute.
Use the dot character to access attributes of nested objects,
e.g. contact.mobile
will target the attribute "mobile"
from a Contact attribute inside a Customer class.columnIndex
- the position of the column that:
(a) when parsing, will be read from to populate the given attribute of an object;
(b) when writing, will receive the value of the given attribute of an object;void attributesToColumnNames(Map<String,String> mappings)
mappings
- a map of attribute names associated with a corresponding column name, where:
contact.mobile
will target the attribute "mobile"
from a Contact attribute inside a Customer class.
void attributesToColumns(Map<String,Enum<?>> mappings)
mappings
- a map of attribute names associated with a corresponding column, where:
contact.mobile
will target the attribute "mobile"
from a Contact attribute inside a Customer class.
void attributesToIndexes(Map<String,Integer> mappings)
mappings
- a map of attribute names associated with a corresponding column, where:
contact.mobile
will target the attribute "mobile"
from a Contact attribute inside a Customer class.
void methodToColumnName(String setterName, Class<?> parameterType, String columnName)
methodToColumnName(String, String)
is not enough to uniquely identify the method you need (e.g. when there are
overloaded methods with different parameter types)
Used only for parsing. Will be ignored when writing.setterName
- the name of the setter method.
Use the dot character to access methods of nested objects,
e.g. contact.mobile
will target the setter method "mobile(String)"
from a Contact attribute inside a Customer class.parameterType
- the type of the parameter used in the given setter name.columnName
- the name of the column that when parsing, will be read from to invoke given setter method of an objectvoid methodToColumn(String setterName, Class<?> parameterType, Enum<?> column)
methodToColumnName(String, String)
is not enough to uniquely identify the method you need (e.g. when there are
overloaded methods with different parameter types)
Used only for parsing. Will be ignored when writing.setterName
- the name of the setter method.
Use the dot character to access methods of nested objects,
e.g. contact.mobile
will target the setter method "mobile(String)"
from a Contact attribute inside a Customer class.parameterType
- the type of the parameter used in the given setter name.column
- an enumeration representing the column that when parsing, will be read from to invoke given setter method of an objectvoid methodToIndex(String setterName, Class<?> parameterType, int columnIndex)
methodToColumnName(String, String)
is not enough to uniquely identify the method you need (e.g. when there are
overloaded methods with different parameter types)
Used only for parsing. Will be ignored when writing.setterName
- the name of the setter method.
Use the dot character to access methods of nested objects,
e.g. contact.mobile
will target the setter method "mobile(String)"
from a Contact attribute inside a Customer class.parameterType
- the type of the parameter used in the given setter name.columnIndex
- the position of the column that when parsing, will be read from to invoke given setter method of an objectvoid methodToColumnName(String methodName, String columnName)
methodToColumnName(String, Class, String)
to specify the exact parameter type to match the appropriate setter method.
When writing, only "getter" methods will be used i.e. the given method
doesn't accept any parameters and returns a value.methodName
- the name of the method.
Use the dot character to access methods of nested objects,
e.g. contact.mobile
will target the method "mobile(String)" when parsing, or "String mobile()" when writing,
from a Contact attribute inside a Customer class.columnName
- the name of the column that:
(a) when parsing, will be read from to invoke given setter method of an object;
(b) when writing, will receive the value returned by the given getter method of an object;void methodToColumn(String methodName, Enum<?> column)
methodToColumnName(String, Class, String)
to specify the exact parameter type to match the appropriate setter method.
When writing, only "getter" methods will be used i.e. the given method
doesn't accept any parameters and returns a value.methodName
- the name of the method.
Use the dot character to access methods of nested objects,
* e.g. contact.mobile
will target the method "mobile(String)" when parsing, or "String mobile()" when writing,
* from a Contact attribute inside a Customer class.column
- an enumeration representing the column that:
(a) when parsing, will be read from to invoke given setter method of an object;
(b) when writing, will receive the value returned by the given getter method of an object;void methodToIndex(String methodName, int columnIndex)
methodToColumnName(String, Class, String)
to specify the exact parameter type to match the appropriate setter method.
When writing, only "getter" methods will be used i.e. the given method
doesn't accept any parameters and returns a value.methodName
- the name of the method.
Use the dot character to access methods of nested objects,
* e.g. contact.mobile
will target the method "mobile(String)" when parsing, or "String mobile()" when writing,
* from a Contact attribute inside a Customer class.columnIndex
- the position of the column that:
(a) when parsing, will be read from to invoke given setter method of an object;
(b) when writing, will receive the value returned by the given getter method of an object;void methodsToColumnNames(Map<String,String> mappings)
mappings
- a map of methods names associated with a corresponding column name, where:
contact.mobile
will target the method "mobile(String)" when parsing, or "String mobile()" when writing,
from a Contact attribute inside a Customer class.
void methodsToColumns(Map<String,Enum<?>> mappings)
mappings
- a map of methods names associated with a corresponding column, where:
contact.mobile
will target the method "mobile(String)" when parsing, or "String mobile()" when writing,
from a Contact attribute inside a Customer class.
void methodsToIndexes(Map<String,Integer> mappings)
mappings
- a map of methods names associated with a corresponding column position, where:
contact.mobile
will target the method "mobile(String)" when parsing, or "String mobile()" when writing,
from a Contact attribute inside a Customer class.
ColumnMapper clone()
void remove(String methodOrAttributeName)
methodOrAttributeName
- the name of the method or attribute to be removed.Copyright © 2024 Univocity Software Pty Ltd. All rights reserved.