org.geotools.data.csv

Class CSVFeatureWriter

Object

CSVFeatureWriter

All Implemented Interfaces:

Closeable, AutoCloseable, FeatureWriter<SimpleFeatureType,SimpleFeature>

public class CSVFeatureWriter
extends Object
implements FeatureWriter<SimpleFeatureType,SimpleFeature>

Iterator supporting writing of feature content.

Author:

Jody Garnett (Boundless), Lee Breisacher, Ian Turton (Astun)

Constructor Summary

Constructors

Constructor and Description
CSVFeatureWriter(CSVFileState csvFileState, CSVStrategy csvStrategy)
CSVFeatureWriter(CSVFileState csvFileState, CSVStrategy csvStrategy, Query query)

Method Summary

Modifier and Type	Method and Description
void	close() Release the underlying resources.
SimpleFeatureType	getFeatureType() FeatureType this reader has been configured to create.
boolean	hasNext() Query whether this FeatureWriter has another Feature.
SimpleFeature	next() Reads a Feature from the underlying AttributeReader.
void	remove() Mark our currentFeature feature as null, it will be skipped when written effectively removing it.
void	write() Writes the current Feature, must be called before hasNext.

Methods inherited from class Object

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

Constructor Detail

CSVFeatureWriter

public CSVFeatureWriter(CSVFileState csvFileState,
                        CSVStrategy csvStrategy)
                 throws IOException

Throws:

IOException

CSVFeatureWriter

public CSVFeatureWriter(CSVFileState csvFileState,
                        CSVStrategy csvStrategy,
                        Query query)
                 throws IOException

Throws:

IOException

Method Detail

getFeatureType

public SimpleFeatureType getFeatureType()

Description copied from interface: FeatureWriter

FeatureType this reader has been configured to create.

Specified by:

getFeatureType in interface FeatureWriter<SimpleFeatureType,SimpleFeature>

Returns:

FeatureType this writer has been configured to create.

hasNext

public boolean hasNext()
                throws IOException

Description copied from interface: FeatureWriter

Query whether this FeatureWriter has another Feature.

Please note: it is more efficient to construct your FeatureWriter with a Filer (to skip entries you do not want), than to force the creation of entire Features only to skip over them.

FeatureWriters that support append operations will allow calls to next, even when hasNext() returns false.

Specified by:

hasNext in interface FeatureWriter<SimpleFeatureType,SimpleFeature>

Returns:

true if an additional Feature is available, false if not.

Throws:

IOException - if an I/O error occurs.

next

public SimpleFeature next()
                   throws IOException,
                          IllegalArgumentException,
                          NoSuchElementException

Description copied from interface: FeatureWriter

Reads a Feature from the underlying AttributeReader.

This method may return a Feature even though hasNext() returns false, this allows FeatureWriters to provide an ability to append content.

Specified by:

next in interface FeatureWriter<SimpleFeatureType,SimpleFeature>

Returns:

Feature from Query, or newly appended Feature

Throws:

IOException - if the writer has been closed or an I/O error occurs reading the next Feature.

IllegalArgumentException

NoSuchElementException

remove

public void remove()
            throws IOException

Mark our currentFeature feature as null, it will be skipped when written effectively removing it.

Specified by:

remove in interface FeatureWriter<SimpleFeatureType,SimpleFeature>

Throws:

IOException

write

public void write()
           throws IOException

Description copied from interface: FeatureWriter

Writes the current Feature, must be called before hasNext.

FeautreWriters will need to allow FeatureSources of the same typeName to issue a FeatureEvent:

• FeatureEvent.FEATURES_ADDED: when next() has been called with hasNext() equal to false.
• FeatureEvent.FEATURES_MODIFIED: when next has been called with hasNext() equal to true and the resulting Feature has indeed been modified.

If this FeatureWriter is opperating against a Transaction the FEATURES_MODIFIED or FEATURES_ADDED events should only be sent to FeatureSources opperating on the same Transaction. When Transaction commit() is called other FeatureSources will be informed of the modifications.

If you have not called write() when you call hasNext() or next(), no modification will occur().

Specified by:

write in interface FeatureWriter<SimpleFeatureType,SimpleFeature>

Throws:

IOException

close

public void close()
           throws IOException

Description copied from interface: FeatureWriter

Release the underlying resources.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Specified by:

close in interface FeatureWriter<SimpleFeatureType,SimpleFeature>

Throws:

IOException - if there there are problems releasing underlying resources, or possibly if close has been called (up to the implementation).