com.ricebridge.csvman
Class LineProviderSupportImpl

java.lang.Object
  com.ricebridge.csvman.LineProviderSupportImpl

All Implemented Interfaces:

LineProvider

Direct Known Subclasses:

CustomLineProvider, LineProviderFixer

public abstract class LineProviderSupportImpl

extends Object

implements LineProvider

Helper class for implementing the LineProvider interface.

Please do not extend this class directly. CustomLineProvider extends this class, and CustomLineProvider is the class you should should extend when implementing your own LineProviders. This class only provides internal error checking.

Compatibility note: This class will replace LineProviderSupport in CSV Manager 2.x. The current LineProviderSupport class in CSV Manager 1.x is a compatibility class for existing customers with custom LineProviders, and should not be used for new code. If this means nothing to you, just remember that the golden rule is "use CustomLineProvider, and things will just work."

The Source Code of this Java class is available under a BSD-style license.

See Also:

LineProvider, LineProviderSupport, CustomLineProvider

Constructor Summary

LineProviderSupportImpl()

Method Summary

void	endProcess() Helper implementation of LineProvider.endProcess.
protected abstract void	endProcessImpl()
boolean	hasNextLine() Helper implementation of LineProvider.hasNextLine.
protected abstract boolean	hasNextLineImpl()
String[]	nextLine() Helper implementation of LineProvider.nextLine.
protected abstract String[]	nextLineImpl()
void	setCsvSpec(CsvSpec pCsvSpec) Helper implementation of LineProvider.setCsvSpec.
protected abstract void	setCsvSpecImpl(CsvSpec pCsvSpec)
void	setLineSpec(LineSpec pLineSpec) Helper implementation of LineProvider.setLineSpec.
protected abstract void	setLineSpecImpl(LineSpec pLineSpec)
void	startProcess() Helper implementation of LineProvider.startProcess.
protected abstract void	startProcessImpl()

Methods inherited from class java.lang.Object

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

Constructor Detail

LineProviderSupportImpl

public LineProviderSupportImpl()

Method Detail

setCsvSpec

public void setCsvSpec(CsvSpec pCsvSpec)

Helper implementation of LineProvider.setCsvSpec. Subclasses should implement setCsvSpecImpl.

Specified by:

setCsvSpec in interface LineProvider

Parameters:

pCsvSpec - CsvSpec object

setLineSpec

public void setLineSpec(LineSpec pLineSpec)

Helper implementation of LineProvider.setLineSpec. Subclasses should implement setLineSpecImpl.

Specified by:

setLineSpec in interface LineProvider

Parameters:

pLineSpec - field specification

startProcess

public void startProcess()

Helper implementation of LineProvider.startProcess. Subclasses should implement startProcessImpl.

Specified by:

startProcess in interface LineProvider

hasNextLine

public boolean hasNextLine()

Helper implementation of LineProvider.hasNextLine. Sub classes should implement hasNextLineImpl.

Specified by:

hasNextLine in interface LineProvider

nextLine

public String[] nextLine()

Helper implementation of LineProvider.nextLine. Sub classes should implement nextLineImpl.

Specified by:

nextLine in interface LineProvider

endProcess

public void endProcess()

Helper implementation of LineProvider.endProcess. Subclasses should implement endProcessImpl.

Specified by:

endProcess in interface LineProvider

setCsvSpecImpl

protected abstract void setCsvSpecImpl(CsvSpec pCsvSpec)
                                throws Exception

Throws:

Exception

setLineSpecImpl

protected abstract void setLineSpecImpl(LineSpec pLineSpec)
                                 throws Exception

Throws:

Exception

startProcessImpl

protected abstract void startProcessImpl()
                                  throws Exception

Throws:

Exception

hasNextLineImpl

protected abstract boolean hasNextLineImpl()
                                    throws Exception

Throws:

Exception

nextLineImpl

protected abstract String[] nextLineImpl()
                                  throws Exception

Throws:

Exception

endProcessImpl

protected abstract void endProcessImpl()
                                throws Exception

Throws:

Exception