org.geotools.gml2.simple

Interface GMLDelegate

All Known Implementing Classes:

GML2FeatureCollectionEncoderDelegate.GML2Delegate, GML32FeatureCollectionEncoderDelegate.GML32Delegate

public interface GMLDelegate

Interface factoring out the differences between GML versions

Author:

Justin Deoliveira, OpenGeo, Andrea Aime - GeoSolutions

Method Summary

Modifier and Type	Method and Description
ObjectEncoder	createEnvelopeEncoder(Encoder e) Creates the envelope encoder
void	endFeature(GMLWriter handler) Closes a single feature
void	endFeatures(GMLWriter handler) Closes a collection of features
void	endTuple(GMLWriter handler) Closes a tuple
boolean	forceDecimalEncoding() Returns true if coordinates should be encoded as xs:decimal instead of xs:double
default boolean	getEncodeMeasures() Controls if coordinates measures should be included in WFS outputs.
List	getFeatureProperties(SimpleFeature f, XSDElementDeclaration element, Encoder e) Lists all properties that should be encoded for a given feature
String	getGmlPrefix() The GML prefix used by this encoding session
int	getNumDecimals() Number of decimals used in the output
XSD	getSchema() The XSD schema used by this GML version
void	initFidAttribute(AttributesImpl atts) Initializes an empty feature id attribute, the attribute must be the first one in "atts"
boolean	padWithZeros() Returns true if coordinates should be right-padded with zeros up to the requested number of decimals.
void	registerGeometryEncoders(Map<Class,GeometryEncoder> encoders, Encoder encoder) Registers all the geometry encoders for this GML version in a map, by geometry class (different versions support different types of geometries, e.g., GML3 supports also curved ones)
void	setGeometryDimensionAttribute(AttributesImpl srsatts, int dimension) Sets the dimensions attribute, if available for the current GML version
void	setSrsNameAttribute(AttributesImpl atts, CoordinateReferenceSystem crs) Sets the SRS attribute with the proper syntax for the given GML version
void	startFeature(GMLWriter handler) Writes whatever per feature preamble is needed in this GML version
void	startFeatures(GMLWriter handler) Writes whatever per collection preamble is needed in this GML version
void	startTuple(GMLWriter handler) Writes the tuple preamble
boolean	supportsTuples() Returns true if tuple encoding is supported in this standard

Method Detail

getFeatureProperties

List getFeatureProperties(SimpleFeature f,
                          XSDElementDeclaration element,
                          Encoder e)

Lists all properties that should be encoded for a given feature

Parameters:

f - A sample feature

element - The xml element holding the feature type

e - The encoder

Returns:

createEnvelopeEncoder

ObjectEncoder createEnvelopeEncoder(Encoder e)

Creates the envelope encoder

Parameters:

e -

Returns:

registerGeometryEncoders

void registerGeometryEncoders(Map<Class,GeometryEncoder> encoders,
                              Encoder encoder)

Registers all the geometry encoders for this GML version in a map, by geometry class (different versions support different types of geometries, e.g., GML3 supports also curved ones)

Parameters:

encoders -

encoder -

setSrsNameAttribute

void setSrsNameAttribute(AttributesImpl atts,
                         CoordinateReferenceSystem crs)

Sets the SRS attribute with the proper syntax for the given GML version

Parameters:

atts -

crs -

setGeometryDimensionAttribute

void setGeometryDimensionAttribute(AttributesImpl srsatts,
                                   int dimension)

Sets the dimensions attribute, if available for the current GML version

Parameters:

srsatts -

dimension -

initFidAttribute

void initFidAttribute(AttributesImpl atts)

Initializes an empty feature id attribute, the attribute must be the first one in "atts"

Parameters:

atts -

startFeatures

void startFeatures(GMLWriter handler)
            throws Exception

Writes whatever per collection preamble is needed in this GML version

Parameters:

handler -

Throws:

Exception

startFeature

void startFeature(GMLWriter handler)
           throws Exception

Writes whatever per feature preamble is needed in this GML version

Parameters:

handler -

Throws:

Exception

endFeatures

void endFeatures(GMLWriter handler)
          throws Exception

Closes a collection of features

Parameters:

handler -

Throws:

Exception

endFeature

void endFeature(GMLWriter handler)
         throws Exception

Closes a single feature

Parameters:

handler -

Throws:

Exception

getGmlPrefix

String getGmlPrefix()
             throws Exception

The GML prefix used by this encoding session

Returns:

Throws:

Exception

supportsTuples

boolean supportsTuples()

Returns true if tuple encoding is supported in this standard

Returns:

startTuple

void startTuple(GMLWriter handler)
         throws SAXException

Writes the tuple preamble

Parameters:

handler -

Throws:

SAXException

endTuple

void endTuple(GMLWriter handler)
       throws SAXException

Closes a tuple

Parameters:

handler -

Throws:

SAXException

getSchema

XSD getSchema()

The XSD schema used by this GML version

Returns:

getNumDecimals

int getNumDecimals()

Number of decimals used in the output

Returns:

forceDecimalEncoding

boolean forceDecimalEncoding()

Returns true if coordinates should be encoded as xs:decimal instead of xs:double

Returns:

padWithZeros

boolean padWithZeros()

Returns true if coordinates should be right-padded with zeros up to the requested number of decimals.

Returns:

getEncodeMeasures

default boolean getEncodeMeasures()

Controls if coordinates measures should be included in WFS outputs.

Returns:

TRUE if measures should be encoded, otherwise FALSE