org.kuali.ole.sys.batch

Class AbstractRegexSpecificationBase

java.lang.Object

org.kuali.ole.sys.batch.AbstractFlatFileSpecificationBase

org.kuali.ole.sys.batch.AbstractRegexSpecificationBase

All Implemented Interfaces:

FlatFileSpecification, org.springframework.beans.factory.InitializingBean

Direct Known Subclasses:

FixedWidthFlatFileRegexSpecification

public abstract class AbstractRegexSpecificationBase
extends AbstractFlatFileSpecificationBase

The abstract parent of flat file specifications which use regexes to determine what line is parsed into what object

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	fullMatch
protected List<Pattern>	insignificantPatterns
protected List<String>	insignificantRegexPatterns
protected boolean	trimLineBeforeMatch

Fields inherited from class org.kuali.ole.sys.batch.AbstractFlatFileSpecificationBase

defaultBusinessObjectClass, objectSpecifications

Constructor Summary

Constructors

Constructor and Description
AbstractRegexSpecificationBase()

Method Summary

Methods

Modifier and Type	Method and Description
Class<?>	determineClassForLine(String line) Matches the given line with an object to parse into, or null if no object could be found
List<Pattern>	getInsignificantPatterns()
boolean	isFullMatch()
boolean	isTrimLineBeforeMatch()
protected boolean	matches(Pattern pattern, String line) Determines if the given line matches the given pattern, following the full match rule
void	setFullMatch(boolean fullMatch) Sets whether the regular expression associated with this object specification will attempt to match against the whole line or search for the pattern within the line.
void	setInsignificantRegexPatterns(List<String> insignificantRegexPatterns) Sets the insignificant regex patterns
void	setTrimLineBeforeMatch(boolean trimLineBeforeMatch) Sets whether this will strip trailing spaces before parsing the line.
protected String	trimLine(String line) Trims the trailing space only from the given line, though only if trimLineBeforeMatch is true

Methods inherited from class org.kuali.ole.sys.batch.AbstractFlatFileSpecificationBase

afterPropertiesSet, getObjectSpecification, getObjectSpecifications, setDefaultBusinessObjectClass, setObjectSpecifications

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.kuali.ole.sys.batch.FlatFileSpecification

parseLineIntoObject

Field Detail

insignificantRegexPatterns

protected List<String> insignificantRegexPatterns

insignificantPatterns

protected List<Pattern> insignificantPatterns

trimLineBeforeMatch

protected boolean trimLineBeforeMatch

fullMatch

protected boolean fullMatch

Constructor Detail

AbstractRegexSpecificationBase

public AbstractRegexSpecificationBase()

Method Detail

determineClassForLine

public Class<?> determineClassForLine(String line)

Matches the given line with an object to parse into, or null if no object could be found

Parameters:

line - the current line of the flat file parser being parsed

Returns:

the Class of the business object that the given line will be parsed into

See Also:

FlatFileSpecification.determineClassForLine(java.lang.String)

trimLine

protected String trimLine(String line)

Trims the trailing space only from the given line, though only if trimLineBeforeMatch is true

Parameters:

line - the line to perhaps trim trailing spaces from

Returns:

the maybe trimmed line

setInsignificantRegexPatterns

public void setInsignificantRegexPatterns(List<String> insignificantRegexPatterns)

Sets the insignificant regex patterns

Parameters:

insignificantRegexPatterns - the regex patterns for lines to ignore

matches

protected boolean matches(Pattern pattern,
              String line)

Determines if the given line matches the given pattern, following the full match rule

Parameters:

pattern - the pattern to match against

line - the parsed line to match

Returns:

true if the line matches and the line should be parsed by this object specification; false if this line should be given to the next object specification

getInsignificantPatterns

public List<Pattern> getInsignificantPatterns()

Returns:

the List of compiled insignificant patterns

isTrimLineBeforeMatch

public boolean isTrimLineBeforeMatch()

Returns:

whether a parsed line will have trailing spaces removed (and trailing spaces only!)

setTrimLineBeforeMatch

public void setTrimLineBeforeMatch(boolean trimLineBeforeMatch)

Sets whether this will strip trailing spaces before parsing the line. Defaults to false.

Parameters:

trimLineBeforeMatch - true if trailing spaces should be stripped, false otherwise

isFullMatch

public boolean isFullMatch()

Returns:

whether the regular expression associated with this object specification will attempt to match the full line or (if false) simply find the pattern somewhere within the line

setFullMatch

public void setFullMatch(boolean fullMatch)

Sets whether the regular expression associated with this object specification will attempt to match against the whole line or search for the pattern within the line. If true, it will match the full line, and this is the default.

Parameters:

fullMatch - true if match against the full line should be carried out, false otherwise