com.projectnine.csvmapper
Class CsvFieldMapping

java.lang.Object
  com.projectnine.csvmapper.CsvFieldMapping

All Implemented Interfaces:

java.lang.Cloneable

public class CsvFieldMapping
extends java.lang.Object
implements java.lang.Cloneable

This class represents the mapping between one CSV field and one property of an Object.

Author:

robweber

Constructor Summary

CsvFieldMapping()

Method Summary

java.lang.Object	clone()
java.lang.String	getBeanName()
int	getColumnIndex() Get the value of the column index.
java.lang.String	getCsvFieldHeader()
java.lang.String	getCsvFieldValueFromObject(java.lang.Object object) This method returns the "adjusted" (post validation and formatting) property value.
java.lang.String	getCsvToObjectExpression()
java.lang.String	getObjectToCsvExpression()
java.lang.Object	getObjectValueFromCsvField(java.lang.String rawPropertyValue, java.lang.Object generatedObject, java.util.List<java.lang.String> line) This method returns the "adjusted" (post validation and formatting) property value.
void	setBeanName(java.lang.String beanName)
void	setColumnIndex(int columnIndex)
void	setCsvFieldHeader(java.lang.String csvFieldHeader)
void	setCsvToObjectExpression(java.lang.String csvToObjectExpression)
void	setFormatter(CsvFieldFormatter formatter)
void	setObjectToCsvExpression(java.lang.String objectToCsvExpression)
void	setValidationCommand(org.apache.commons.chain.Command validationCommand)

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CsvFieldMapping

public CsvFieldMapping()

Method Detail

getColumnIndex

public final int getColumnIndex()

Get the value of the column index.

Returns:

the value of the column index.

setColumnIndex

public final void setColumnIndex(int columnIndex)

Parameters:

columnIndex - the columnIndex to set

setFormatter

public final void setFormatter(CsvFieldFormatter formatter)

Parameters:

formatter - the formatter to set

getObjectValueFromCsvField

public final java.lang.Object getObjectValueFromCsvField(java.lang.String rawPropertyValue,
                                                         java.lang.Object generatedObject,
                                                         java.util.List<java.lang.String> line)
                                                  throws ValidationException

This method returns the "adjusted" (post validation and formatting) property value. If there is a problem with validation or formatting, a ValidationException is thrown. While this is bad, it may not indicate that the whole file is bad; it might just be the current record. Just call CsvToObjectMapper.loadNextRecord() and try CsvToObjectMapper.generateObjectFromCurrentCsvRecord() again.

Parameters:

rawPropertyValue - The raw property value as it appears in the CSV file.

generatedObject - The object to which the property will ultimately be stored.

line - A list of all of the other CSV String values in the same line.

Returns:

The value of the Object from the CSV Field.

Throws:

ValidationException - when the CSV field value cannot be validated.

getCsvFieldValueFromObject

public final java.lang.String getCsvFieldValueFromObject(java.lang.Object object)
                                                  throws ValidationException

This method returns the "adjusted" (post validation and formatting) property value. If there is a problem with validation or formatting, a ValidationException is thrown. While this is bad, it may not indicate that the whole file is bad; it might just be the current record. Just call CsvToObjectMapper.loadNextRecord() and try CsvToObjectMapper.generateObjectFromCurrentCsvRecord() again.

Parameters:

object - The object to convert to CSV field representation.

Returns:

CSV field representation of the given object.

Throws:

ValidationException - if the object cannot be validated.

setValidationCommand

public void setValidationCommand(org.apache.commons.chain.Command validationCommand)

Parameters:

validationCommand - the validators to set

setBeanName

public final void setBeanName(java.lang.String beanName)

Parameters:

beanName - the beanName to set

getBeanName

public final java.lang.String getBeanName()

Returns:

the beanName

getCsvToObjectExpression

public final java.lang.String getCsvToObjectExpression()

Returns:

the csvToObjectExpression

setCsvToObjectExpression

public final void setCsvToObjectExpression(java.lang.String csvToObjectExpression)

Parameters:

csvToObjectExpression - the csvToObjectExpression to set

getObjectToCsvExpression

public final java.lang.String getObjectToCsvExpression()

Returns:

the objectToCsvExpression

setObjectToCsvExpression

public final void setObjectToCsvExpression(java.lang.String objectToCsvExpression)

Parameters:

objectToCsvExpression - the objectToCsvExpression to set

clone

public final java.lang.Object clone()

Overrides:

clone in class java.lang.Object

getCsvFieldHeader

public final java.lang.String getCsvFieldHeader()

Returns:

the csvFieldHeader

setCsvFieldHeader

public final void setCsvFieldHeader(java.lang.String csvFieldHeader)

Parameters:

csvFieldHeader - the csvFieldHeader to set