org.kuali.ole.sys.batch

Class AbstractFlatFilePropertySpecificationBase

java.lang.Object

org.kuali.ole.sys.batch.AbstractFlatFilePropertySpecificationBase

All Implemented Interfaces:

FlatFilePropertySpecification

Direct Known Subclasses:

DelimitedFlatFilePropertySpecification, FixedWidthFlatFilePropertySpecification

public abstract class AbstractFlatFilePropertySpecificationBase
extends Object
implements FlatFilePropertySpecification

Base abstract class for configuration element which represents a substring of a given line to be formatted and set on a business object

Field Summary

Fields

Modifier and Type	Field and Description
protected String	dateFormat
protected Class<? extends org.kuali.rice.core.web.format.Formatter>	formatterClass
protected boolean	formatToTimestamp
protected boolean	leftTrim
protected String	propertyName
protected boolean	rightTrim

Constructor Summary

Constructors

Constructor and Description
AbstractFlatFilePropertySpecificationBase()

Method Summary

Methods

Modifier and Type	Method and Description
protected Object	getFormattedObject(String subString, Object parsedObject) This method returns the formatted object for the given string.
protected org.kuali.rice.core.web.format.Formatter	getFormatter(Object parsedObject) Builds a formatter to format the parsed substring before it is set as a property on the business object
protected Class<?>	getFormatterClass(Object parsedObject) Returns the formatter class to format the substring before it is set on the business object
String	getPropertyName()
void	setDateFormat(String dateFormat) If the substring represents a date, then this is the format used to parse that date; it should be compatible with java.text.SimpleDateFormat
void	setFormatterClass(Class<? extends org.kuali.rice.core.web.format.Formatter> formatterClass) Sets the formatter class to use in this proprety specification
void	setFormatToTimestamp(boolean formatToTimestamp) If the formatter for this class is a BatchDateFormatter, then the formatted Date should be in the form of a timestamp
void	setLeftTrim(boolean leftTrim) Determines if the substring should have all whitepsace on the left removed before setting
void	setProperty(String value, Object businessObject, int lineNumber) Sets the property on the business object
void	setPropertyName(String propertyName) Sets the name of the property this property specification will target for filling in the business object to parse into
void	setRightTrim(boolean rightTrim) Determines if the substring should have all whitespace on the right removed before setting

Methods inherited from class java.lang.Object

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

Field Detail

propertyName

protected String propertyName

rightTrim

protected boolean rightTrim

leftTrim

protected boolean leftTrim

formatterClass

protected Class<? extends org.kuali.rice.core.web.format.Formatter> formatterClass

dateFormat

protected String dateFormat

formatToTimestamp

protected boolean formatToTimestamp

Constructor Detail

AbstractFlatFilePropertySpecificationBase

public AbstractFlatFilePropertySpecificationBase()

Method Detail

getPropertyName

public String getPropertyName()

Specified by:

getPropertyName in interface FlatFilePropertySpecification

Returns:

the name of the property that should be set

setProperty

public void setProperty(String value,
               Object businessObject,
               int lineNumber)

Sets the property on the business object

Specified by:

setProperty in interface FlatFilePropertySpecification

Parameters:

value - the substring of the parsed line to set

businessObject - the business object to set the parsed line on

lineNumber - the parsed line number

getFormatterClass

protected Class<?> getFormatterClass(Object parsedObject)

Returns the formatter class to format the substring before it is set on the business object

Parameters:

parsedObject - the object that is being parsed into

Returns:

the class for the formatter

getFormatter

protected org.kuali.rice.core.web.format.Formatter getFormatter(Object parsedObject)

Builds a formatter to format the parsed substring before it is set as a property on the business object

Parameters:

parsedObject - the business object to parse into

Returns:

the formatter

setFormatterClass

public void setFormatterClass(Class<? extends org.kuali.rice.core.web.format.Formatter> formatterClass)

Sets the formatter class to use in this proprety specification

Parameters:

formatterClass - the class of the formatter to use

getFormattedObject

protected Object getFormattedObject(String subString,
                        Object parsedObject)

This method returns the formatted object for the given string. It uses the formatter class define for specification property if exists, otherwise look to the Data Dictionary of the parsedObject , otherwise use the default formatter class.

Parameters:

subString - the parsed subString

the - object to parse into

setPropertyName

public void setPropertyName(String propertyName)

Sets the name of the property this property specification will target for filling in the business object to parse into

Parameters:

propertyName - the name of the target property

setRightTrim

public void setRightTrim(boolean rightTrim)

Determines if the substring should have all whitespace on the right removed before setting

Parameters:

rightTrim - true if all whitespace on the right should be removed, false otherwise

setLeftTrim

public void setLeftTrim(boolean leftTrim)

Determines if the substring should have all whitepsace on the left removed before setting

Parameters:

leftTrim - true if all whitespace on the left should be removed, false otherwise

setDateFormat

public void setDateFormat(String dateFormat)

If the substring represents a date, then this is the format used to parse that date; it should be compatible with java.text.SimpleDateFormat

Parameters:

dateFormat - the date format to utilized

setFormatToTimestamp

public void setFormatToTimestamp(boolean formatToTimestamp)

If the formatter for this class is a BatchDateFormatter, then the formatted Date should be in the form of a timestamp

Parameters:

formatToTimestamp - true if we should format to timestamp, false (the default) if we should not