IGPEWriterHandlerImplementor

All Known Implementing Classes:

GPEGmlSFP0WriterHandlerImplementor, GPEGmlv2WriterHandlerImplementor, GPEGmlWriterHandlerImplementor, GPEKml21WriterHandlerImplementor, GPEKmlWriterHandlerImplementor, GPEWriterHandlerImplementor, GPEXmlWriterHandlerImplementor
```
public interface IGPEWriterHandlerImplementor
```
This interface defines the writing process methods. To write a new concrete format it is necessary to create a class that implements this methods and creates the output file whereas the consumer application is invoking these methods.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`close()` It indicates that the writing process has finished.
`void`	`endBbox()` It means that the current bounding box has finished to be written.
`void`	`endElement()` It means that the current element has finished to be written.
`void`	`endFeature()` It means that the current feature has finished to be written.
`void`	`endInnerBoundary()` It means that the current innerPolygon has finished to be written.
`void`	`endLayer()` It means that the current layer has finished to be written.
`void`	`endLinearRing()` It means that the current linearRing has finished to be written.
`void`	`endLineString()` It means that the current lineString has finished to be written.
`void`	`endMultiGeometry()` It means that the current multiGeometry has finished to be written.
`void`	`endMultiLineString()` It means that the current multiLineString has finished to be written.
`void`	`endMultiPoint()` It means that the current multiPoint has finished to be written.
`void`	`endMultiPolygon()` It means that the current multiPolygon has finished to be written.
`void`	`endPoint()` It means that the current point has finished to be written.
`void`	`endPolygon()` It means that the current polygon has finished to be written.
`String`	`getDescription()`
`IGPEErrorHandler`	`getErrorHandler()`
`String`	`getFileExtension()`
`String`	`getFormat()`
`String`	`getName()`
`void`	`initialize()` It must be invoked before to start the reading process.
`void`	`setErrorHandler(IGPEErrorHandler errorHandler)`
`void`	`setOutputStream(OutputStream os)` Sets the outputstream
`void`	`startBbox(String id, ICoordinateSequence coords, String srs)` It is thrown by the consumer application to indicate that it has to write a bounding box.
`void`	`startElement(String namespace, String name, Object value)` It is thrown by the consumer application to indicate that it has to write a element.
`void`	`startFeature(String id, String namespace, String name)` It is thrown by the consumer application to indicate that it has to write a feature.
`void`	`startInnerBoundary(String id, ICoordinateSequence coords, String srs)` It is thrown by the consumer application to indicate that it has to write a innerPolygon.
`void`	`startLayer(String id, String namespace, String name, String description, String srs)` It is thrown by the consumer application to indicate that it has to write a layer.
`void`	`startLinearRing(String id, ICoordinateSequence coords, String srs)` It is thrown by the consumer application to indicate that it has to write a linearRing.
`void`	`startLineString(String id, ICoordinateSequence coords, String srs)` It is thrown by the consumer application to indicate that it has to write a lineString.
`void`	`startMultiGeometry(String id, String srs)` It is thrown by the consumer application to indicate that it has to write a multiGeometry.
`void`	`startMultiLineString(String id, String srs)` It is thrown by the consumer application to indicate that it has to write a multiLineString.
`void`	`startMultiPoint(String id, String srs)` It is thrown by the consumer application to indicate that it has to write a multiPoint.
`void`	`startMultiPolygon(String id, String srs)` It is thrown by the consumer application to indicate that it has to write a multiPolygon.
`void`	`startPoint(String id, ICoordinateSequence coords, String srs)` It is thrown by the consumer application to indicate that it has to write a point.
`void`	`startPolygon(String id, ICoordinateSequence coords, String srs)` It is thrown by the consumer application to indicate that it has to write a polygon.

- Method Detail
  - getName
```
String getName()
```
    Returns:
    
    the writer name
  - getDescription
```
String getDescription()
```
    Returns:
    
    the writer description
  - setOutputStream
```
void setOutputStream(OutputStream os)
```
    Sets the outputstream
  - getFormat
```
String getFormat()
```
    Returns:
    
    the supported format
  - getFileExtension
```
String getFileExtension()
```
    Returns:
    
    the default file extension
  - getErrorHandler
```
IGPEErrorHandler getErrorHandler()
```
    Returns:
    
    the error handler
  - setErrorHandler
```
void setErrorHandler(IGPEErrorHandler errorHandler)
```
    Parameters:
    
    errorHandler - the errorHandler to set
  - initialize
```
void initialize()
```
    It must be invoked before to start the reading process. It is used just to indicate to the writer that the writing process is going to start.
  - close
```
void close()
```
    It indicates that the writing process has finished. The writer can close the file.
  - startLayer
```
void startLayer(String id,
                String namespace,
                String name,
                String description,
                String srs)
```
    It is thrown by the consumer application to indicate that it has to write a layer.
    
    Parameters:
    
    id - Layer identifier
    
    namespace - Layer namespace
    
    name - Layer name
    
    description - Layer description
    
    srs - Layer spatial reference system
  - endLayer
```
void endLayer()
```
    It means that the current layer has finished to be written.
  - startBbox
```
void startBbox(String id,
               ICoordinateSequence coords,
               String srs)
```
    It is thrown by the consumer application to indicate that it has to write a bounding box.
    
    Parameters:
    
    id - Bounding box identifier
    
    coords - A coordinates iterator
    
    srs - Spatial reference system
  - endBbox
```
void endBbox()
```
    It means that the current bounding box has finished to be written.
  - startFeature
```
void startFeature(String id,
                  String namespace,
                  String name)
```
    It is thrown by the consumer application to indicate that it has to write a feature.
    
    Parameters:
    
    id - Feature identifier
    
    namespace - Feature namespace
    
    name - Feature name
  - endFeature
```
void endFeature()
```
    It means that the current feature has finished to be written.
  - startElement
```
void startElement(String namespace,
                  String name,
                  Object value)
```
    It is thrown by the consumer application to indicate that it has to write a element.
    
    Parameters:
    
    namespace - Element namespace
    
    name - Element name
    
    value - Element value
  - endElement
```
void endElement()
```
    It means that the current element has finished to be written.
  - startPoint
```
void startPoint(String id,
                ICoordinateSequence coords,
                String srs)
```
    It is thrown by the consumer application to indicate that it has to write a point.
    
    Parameters:
    
    id - Point identifier
    
    coords - A coordinates iterator
    
    srs - Spatial reference system
  - endPoint
```
void endPoint()
```
    It means that the current point has finished to be written.
  - startMultiPoint
```
void startMultiPoint(String id,
                     String srs)
```
    It is thrown by the consumer application to indicate that it has to write a multiPoint.
    
    Parameters:
    
    id - Geometry identifier
    
    srs - Spatial reference system
  - endMultiPoint
```
void endMultiPoint()
```
    It means that the current multiPoint has finished to be written.
  - startLineString
```
void startLineString(String id,
                     ICoordinateSequence coords,
                     String srs)
```
    It is thrown by the consumer application to indicate that it has to write a lineString.
    
    Parameters:
    
    id - LineString identifier
    
    coords - A coordinates iterator
    
    srs - Spatial reference system
  - endLineString
```
void endLineString()
```
    It means that the current lineString has finished to be written.
  - startMultiLineString
```
void startMultiLineString(String id,
                          String srs)
```
    It is thrown by the consumer application to indicate that it has to write a multiLineString.
    
    Parameters:
    
    id - Geometry identifier
    
    srs - Spatial reference system
  - endMultiLineString
```
void endMultiLineString()
```
    It means that the current multiLineString has finished to be written.
  - startLinearRing
```
void startLinearRing(String id,
                     ICoordinateSequence coords,
                     String srs)
```
    It is thrown by the consumer application to indicate that it has to write a linearRing.
    
    Parameters:
    
    id - LineString identifier
    
    coords - A coordinates iterator
    
    srs - Spatial reference system
  - endLinearRing
```
void endLinearRing()
```
    It means that the current linearRing has finished to be written.
  - startPolygon
```
void startPolygon(String id,
                  ICoordinateSequence coords,
                  String srs)
```
    It is thrown by the consumer application to indicate that it has to write a polygon.
    
    Parameters:
    
    id - LineString identifier
    
    coords - A coordinates iterator
    
    srs - Spatial reference system
  - endPolygon
```
void endPolygon()
```
    It means that the current polygon has finished to be written.
  - startMultiPolygon
```
void startMultiPolygon(String id,
                       String srs)
```
    It is thrown by the consumer application to indicate that it has to write a multiPolygon.
    
    Parameters:
    
    id - Geometry identifier
    
    srs - Spatial reference system
  - endMultiPolygon
```
void endMultiPolygon()
```
    It means that the current multiPolygon has finished to be written.
  - startMultiGeometry
```
void startMultiGeometry(String id,
                        String srs)
```
    It is thrown by the consumer application to indicate that it has to write a multiGeometry.
    
    Parameters:
    
    id - Geometry identifier
    
    srs - Spatial reference system
  - endMultiGeometry
```
void endMultiGeometry()
```
    It means that the current multiGeometry has finished to be written.
  - startInnerBoundary
```
void startInnerBoundary(String id,
                        ICoordinateSequence coords,
                        String srs)
```
    It is thrown by the consumer application to indicate that it has to write a innerPolygon.
    
    Parameters:
    
    id - LineString identifier
    
    coords - A coordinates iterator
    
    srs - Spatial reference system
  - endInnerBoundary
```
void endInnerBoundary()
```
    It means that the current innerPolygon has finished to be written.

Interface IGPEWriterHandlerImplementor

Method Summary

Method Detail

getName

getDescription

setOutputStream

getFormat

getFileExtension

getErrorHandler

setErrorHandler

initialize

close

startLayer

endLayer

startBbox

endBbox

startFeature

endFeature

startElement

endElement

startPoint

endPoint

startMultiPoint

endMultiPoint

startLineString

endLineString

startMultiLineString

endMultiLineString

startLinearRing

endLinearRing

startPolygon

endPolygon

startMultiPolygon

endMultiPolygon

startMultiGeometry

endMultiGeometry

startInnerBoundary

endInnerBoundary