org.geotools.data
Class EmptyFeatureWriter

Object
  extended by EmptyFeatureWriter
All Implemented Interfaces:
FeatureWriter<SimpleFeatureType,SimpleFeature>

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

Represents an Empty, Typed, FeatureWriter.

Author:
Jody Garnett, Refractions Research
Module:
modules/library/main (gt-main.jar)

Constructor Summary
EmptyFeatureWriter(SimpleFeatureType featureType)
          An Empty FeatureWriter of the provided featureType.
 
Method Summary
 void close()
          Cleans up after Empty FeatureWriter.
 SimpleFeatureType getFeatureType()
          FeatureType this reader has been configured to create.
 boolean hasNext()
          There is no next Feature.
 SimpleFeature next()
          Throws NoSuchElementException as this is an Empty FeatureWriter.
 void remove()
          Removes current Feature, must be called before hasNext.
 void write()
          Wrties 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

EmptyFeatureWriter

public EmptyFeatureWriter(SimpleFeatureType featureType)
An Empty FeatureWriter of the provided featureType.

Parameters:
featureType -
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.
See Also:
FeatureWriter.getFeatureType()

next

public SimpleFeature next()
                   throws NoSuchElementException
Throws NoSuchElementException as this is an Empty FeatureWriter.

Specified by:
next in interface FeatureWriter<SimpleFeatureType,SimpleFeature>
Returns:
Does not return
Throws:
NoSuchElementException
See Also:
FeatureWriter.next()

remove

public void remove()
            throws IOException
Description copied from interface: FeatureWriter
Removes current Feature, must be called before hasNext.

FeatureWriters will need to allow all FeatureSources of the same typeName to issue a FeatureEvent event of type FeatureEvent.FEATURES_REMOVED when this method is called.

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

When the current Feature has been provided as new content, this method "cancels" the add opperation (and notification needed).

Specified by:
remove in interface FeatureWriter<SimpleFeatureType,SimpleFeature>
Throws:
IOException - DOCUMENT ME!
See Also:
FeatureWriter.remove()

write

public void write()
           throws IOException
Description copied from interface: FeatureWriter
Wrties the current Feature, must be called before hasNext.

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

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
See Also:
FeatureWriter.remove()

hasNext

public boolean hasNext()
There is no next Feature.

Specified by:
hasNext in interface FeatureWriter<SimpleFeatureType,SimpleFeature>
Returns:
false
See Also:
FeatureWriter.hasNext()

close

public void close()
Cleans up after Empty FeatureWriter.

Specified by:
close in interface FeatureWriter<SimpleFeatureType,SimpleFeature>
See Also:
FeatureWriter.close()


Copyright © 1996-2009 Geotools. All Rights Reserved.