org.gvsig.gpe.lib.api.parser

Interface IGPEContentHandler

All Superinterfaces:

IGPEContentHandlerSFP0

All Known Implementing Classes:

FmapContentHandler, GPEContentHandler, WFSGPEContentHandler

public interface IGPEContentHandler
extends IGPEContentHandlerSFP0

This interface defines the "contract" between the consumer application and libGPE. It has methods that will be invoke by the parser every time that an event happens

Method Summary

Modifier and Type	Method and Description
void	addBboxToFeature(java.lang.Object bbox, java.lang.Object feature) This method adds a bounding box to a feature.
void	addBboxToLayer(java.lang.Object bbox, java.lang.Object layer) It adds a bounding box to one layer that has been previously created using the startLayer method.
void	addDescriptionToLayer(java.lang.String description, java.lang.Object layer) It adds the description to one layer that has been previously created using the startLayer method.
void	addElementToFeature(java.lang.Object element, java.lang.Object feature) This method adds an element to one feature that has been previously created using the startFeature method
void	addFeatureToLayer(java.lang.Object feature, java.lang.Object layer) This method adds a feature to one layer that has been previously created using the startLayer method.
void	addGeometryToFeature(java.lang.Object geometry, java.lang.Object feature) This method adds a geometry to a feature.
void	addGeometryToMultiGeometry(java.lang.Object geometry, java.lang.Object multiGeometry) It is thrown to add a geometry to one multiGeometry.
void	addInnerPolygonToPolygon(java.lang.Object innerPolygon, java.lang.Object Polygon) This method associates a innerPolygon with its polygon
void	addLineStringToMultiLineString(java.lang.Object lineString, java.lang.Object multiLineString) It is thrown to add a lineString to one lineString.
void	addMetadataToFeature(java.lang.Object metadata, java.lang.Object feature) This method adds metadata to feature.
void	addMetadataToMetadata(java.lang.Object metadata, java.lang.Object parent) This method adds metadata to complex metadata.
void	addNameToFeature(java.lang.String name, java.lang.Object feature) This method adds a name to one layer that has been previously created using the startFeature method.
void	addNameToLayer(java.lang.String name, java.lang.Object layer) It adds a name to one layer that has been previously created using the startLayer method.
void	addParentElementToElement(java.lang.Object parent, java.lang.Object element) It is thrown to establish a relationship parent-child between two elements.
void	addParentLayerToLayer(java.lang.Object parent, java.lang.Object layer) It establish the relationship parent-child between two layers that have been previously created using the startLayer method.
void	addPointToMultiPoint(java.lang.Object point, java.lang.Object multiPoint) It is thrown to add a point to one multiPoint.
void	addPolygonToMultiPolygon(java.lang.Object polygon, java.lang.Object multiPolygon) It is thrown to add a polygon to one multiPolygon.
void	addSrsToLayer(java.lang.String srs, java.lang.Object Layer) It adds a spatial reference system to one layer that has been previously created using the startLayer method.
void	addTimeToFeature(java.lang.Object time, java.lang.Object feature) This method adds time to feature.
void	endBbox(java.lang.Object bbox) This method indicates that the parser thas finished to parse the bounding box.
void	endElement(java.lang.Object element) This method is thrown when the parser find the end of an element.
void	endFeature(java.lang.Object feature) This method is thrown when the parser has finished to parse a feature.
void	endInnerPolygon(java.lang.Object innerPolygon) It is thrown when the innerPolygon has been completely parsed.
void	endLayer(java.lang.Object layer) It is thrown when a layer has been finished to parse.
void	endLinearRing(java.lang.Object linearRing) It is thrown when the linearRing has been completely parsed.
void	endLineString(java.lang.Object lineString) It is thrown when the lineString has been completely parsed.
void	endMetadata(java.lang.Object metadata) This method is thrown when the parser find the end of the metadata of an element.
void	endMultiGeometry(java.lang.Object multiGeometry) It is thrown when the multiGeometry has been completely parsed
void	endMultiLineString(java.lang.Object multiLineString) It is thrown when the multiLineString has been completely parsed
void	endMultiPoint(java.lang.Object multiPoint) It is thrown when the multiPoint has been completely parsed
void	endMultiPolygon(java.lang.Object multiPolygon) It is thrown when the multiPolygon has been completely parsed
void	endPoint(java.lang.Object point) It is thrown when the point has been completely parsed.
void	endPolygon(java.lang.Object polygon) It is thrown when the polygon has been completely parsed.
void	endTime(java.lang.Object time) This method is thrown when the parser find the end of and element time tag
java.lang.Object	startBbox(java.lang.String id, ICoordinateIterator coords, java.lang.String srs) This method is thrown when the parser find a new bounding box.
java.lang.Object	startElement(java.lang.String namespace, java.lang.String name, java.lang.Object value, IAttributesIterator attributes, java.lang.Object parentElement) It is thrown when the parser has found a new element
java.lang.Object	startFeature(java.lang.String id, java.lang.String namespace, java.lang.String name, IAttributesIterator attributes, java.lang.Object layer) It is thrown when the parser has found a new feature.
java.lang.Object	startInnerPolygon(java.lang.String id, ICoordinateIterator coords, java.lang.String srs) This method indicates that the parser has found a InnerPolygon.
java.lang.Object	startLayer(java.lang.String id, java.lang.String namespace, java.lang.String name, java.lang.String description, java.lang.String srs, IAttributesIterator attributes, java.lang.Object parentLayer, java.lang.Object bBox) It is thrown every time that a new layer is detected.
java.lang.Object	startLinearRing(java.lang.String id, ICoordinateIterator coords, java.lang.String srs) This method indicates that the parser has found a linearRing.
java.lang.Object	startLineString(java.lang.String id, ICoordinateIterator coords, java.lang.String srs) This method indicates that the parser has found a lineString.
java.lang.Object	startMetadata(java.lang.String type, java.lang.String data, IAttributesIterator attributes) It is thrown when the parser has found a new metadata tag
java.lang.Object	startMultiGeometry(java.lang.String id, java.lang.String srs) This method indicates that the parser has found a multiGeometry.
java.lang.Object	startMultiLineString(java.lang.String id, java.lang.String srs) This method indicates that the parser has found a multiLineString.
java.lang.Object	startMultiLineString(java.lang.String id, java.lang.String srs, int dimension)
java.lang.Object	startMultiPoint(java.lang.String id, java.lang.String srs) This method indicates that the parser has found a multipoint.
java.lang.Object	startMultiPoint(java.lang.String id, java.lang.String srs, int dimension)
java.lang.Object	startMultiPolygon(java.lang.String id, java.lang.String srs) This method indicates that the parser has found a multiPolygon.
java.lang.Object	startMultiPolygon(java.lang.String id, java.lang.String srs, int dimension)
java.lang.Object	startPoint(java.lang.String id, ICoordinateIterator coords, java.lang.String srs) This method indicates that the parser has found a point.
java.lang.Object	startPolygon(java.lang.String id, ICoordinateIterator coords, java.lang.String srs) This method indicates that the parser has found a polygon.
java.lang.Object	startTime(java.lang.String type, java.lang.String time)
java.lang.Object	startTime(java.lang.String name, java.lang.String description, java.lang.String type, java.lang.String time, java.lang.Object previous, java.lang.Object next) It is thrown when the parser has found a new time tag tag

Methods inherited from interface org.gvsig.gpe.lib.api.parser.IGPEContentHandlerSFP0

addCurveToMultiCurve, addSegmentToCurve, endCurve, endMultiCurve, startCurve, startCurve, startMultiCurve, startMultiCurve

Method Detail

startBbox

java.lang.Object startBbox(java.lang.String id,
                           ICoordinateIterator coords,
                           java.lang.String srs)

This method is thrown when the parser find a new bounding box.

Parameters:

id - Bounding box identifier

coords - A coordinates iterator

srs - Spatial reference system

Returns:

The consumer application object that represents a bounding box

endBbox

void endBbox(java.lang.Object bbox)

This method indicates that the parser thas finished to parse the bounding box.

Parameters:

bbox - The consumer application object that represents a bounding box

startLayer

java.lang.Object startLayer(java.lang.String id,
                            java.lang.String namespace,
                            java.lang.String name,
                            java.lang.String description,
                            java.lang.String srs,
                            IAttributesIterator attributes,
                            java.lang.Object parentLayer,
                            java.lang.Object bBox)

It is thrown every time that a new layer is detected.

Parameters:

id - Layer identifier

namespace - XML namespace

name - Layer name

description - Layer description

srs - Layer spatial reference system

attributes - Layer attributes

parentLayer - Layer that contains it

bBox - Layer bounding box

Returns:

The consumer application object that represents a layer

endLayer

void endLayer(java.lang.Object layer)

It is thrown when a layer has been finished to parse.

Parameters:

layer - The consumer application object that represents a layer

addNameToLayer

void addNameToLayer(java.lang.String name,
                    java.lang.Object layer)

It adds a name to one layer that has been previously created using the startLayer method.

Parameters:

name - Layer name

layer - The consumer application object that represents a layer

addDescriptionToLayer

void addDescriptionToLayer(java.lang.String description,
                           java.lang.Object layer)

It adds the description to one layer that has been previously created using the startLayer method.

Parameters:

description - Layer description

layer - The consumer application object that represents a layer

addSrsToLayer

void addSrsToLayer(java.lang.String srs,
                   java.lang.Object Layer)

It adds a spatial reference system to one layer that has been previously created using the startLayer method.

Parameters:

srs - Spatial reference system

layer - The consumer application object that represents a layer

addParentLayerToLayer

void addParentLayerToLayer(java.lang.Object parent,
                           java.lang.Object layer)

It establish the relationship parent-child between two layers that have been previously created using the startLayer method.

Parameters:

parent - The consumer application object that represents the parent layer

layer - The consumer application object that represents the child layer

addBboxToLayer

void addBboxToLayer(java.lang.Object bbox,
                    java.lang.Object layer)

It adds a bounding box to one layer that has been previously created using the startLayer method.

Parameters:

bbox - Layer bounding box

layer - The consumer application object that represents a layer

startFeature

java.lang.Object startFeature(java.lang.String id,
                              java.lang.String namespace,
                              java.lang.String name,
                              IAttributesIterator attributes,
                              java.lang.Object layer)

It is thrown when the parser has found a new feature.

Parameters:

id - Feature identifier

name - Feature name

namespace - XML namespace

attributes - Feature attributes

layer - Consumer application object that represents a layer

Returns:

Consumer application object that represents a feature

endFeature

void endFeature(java.lang.Object feature)

This method is thrown when the parser has finished to parse a feature.

Parameters:

feature - Consumer application object that represents a feature

addNameToFeature

void addNameToFeature(java.lang.String name,
                      java.lang.Object feature)

This method adds a name to one layer that has been previously created using the startFeature method.

Parameters:

name - Feature name

feature - Consumer application object that represents a feature

addFeatureToLayer

void addFeatureToLayer(java.lang.Object feature,
                       java.lang.Object layer)

This method adds a feature to one layer that has been previously created using the startLayer method.

Parameters:

feature - Consumer application object that represents a feature

layer - Consumer application object that represents a layer

startElement

java.lang.Object startElement(java.lang.String namespace,
                              java.lang.String name,
                              java.lang.Object value,
                              IAttributesIterator attributes,
                              java.lang.Object parentElement)

It is thrown when the parser has found a new element

Parameters:

namespace - XML namespace

name - Element name

value - Element value

attributes - Element attributes

parentElement - The parent of this element (if exists)

Returns:

Consumer application object that represents an element

endElement

void endElement(java.lang.Object element)

This method is thrown when the parser find the end of an element.

Parameters:

element - Consumer application object that represents an element

addParentElementToElement

void addParentElementToElement(java.lang.Object parent,
                               java.lang.Object element)

It is thrown to establish a relationship parent-child between two elements.

Parameters:

parent - Consumer application object that represents the parent element

element - Consumer application object that represents the child element

addElementToFeature

void addElementToFeature(java.lang.Object element,
                         java.lang.Object feature)

This method adds an element to one feature that has been previously created using the startFeature method

Parameters:

element - Consumer application object that represents an element

feature - Consumer application object that represents the feature

startPoint

java.lang.Object startPoint(java.lang.String id,
                            ICoordinateIterator coords,
                            java.lang.String srs)

This method indicates that the parser has found a point.

Parameters:

id - Point identifier

coords - A coordinates iterator

srs - Spatial reference system

Returns:

Consumer application object that represents a point

endPoint

void endPoint(java.lang.Object point)

It is thrown when the point has been completely parsed.

Parameters:

point - Consumer application object that represents a point

startLineString

java.lang.Object startLineString(java.lang.String id,
                                 ICoordinateIterator coords,
                                 java.lang.String srs)

This method indicates that the parser has found a lineString.

Parameters:

id - LineString identifier

coords - A coordinates iterator

srs - Spatial reference system

Returns:

Consumer application object that represents a lineString

endLineString

void endLineString(java.lang.Object lineString)

It is thrown when the lineString has been completely parsed.

Parameters:

lineString - Consumer application object that represents a lineString

startLinearRing

java.lang.Object startLinearRing(java.lang.String id,
                                 ICoordinateIterator coords,
                                 java.lang.String srs)

This method indicates that the parser has found a linearRing.

Parameters:

id - LinearRing identifier

coords - A coordinates iterator

srs - Spatial reference system

Returns:

Consumer application object that represents a linarRing

endLinearRing

void endLinearRing(java.lang.Object linearRing)

It is thrown when the linearRing has been completely parsed.

Parameters:

linearRing - Consumer application object that represents a linearRing

startPolygon

java.lang.Object startPolygon(java.lang.String id,
                              ICoordinateIterator coords,
                              java.lang.String srs)

This method indicates that the parser has found a polygon.

Parameters:

id - Polygon identifier

coords - A coordinates iterator

srs - Spatial reference system

Returns:

Consumer application object that represents a polygon

endPolygon

void endPolygon(java.lang.Object polygon)

It is thrown when the polygon has been completely parsed.

Parameters:

polygon - Consumer application object that represents a polygon

addInnerPolygonToPolygon

void addInnerPolygonToPolygon(java.lang.Object innerPolygon,
                              java.lang.Object Polygon)

This method associates a innerPolygon with its polygon

Parameters:

innerPolygon - Consumer application object that represents a innerPolygon

Polygon - Consumer application object that represents a polygon

startInnerPolygon

java.lang.Object startInnerPolygon(java.lang.String id,
                                   ICoordinateIterator coords,
                                   java.lang.String srs)

This method indicates that the parser has found a InnerPolygon.

Parameters:

id - InnerPolygon identifier

coords - A coordinates iterator

srs - Spatial reference system

Returns:

Consumer application object that represents a innerPolygon

endInnerPolygon

void endInnerPolygon(java.lang.Object innerPolygon)

It is thrown when the innerPolygon has been completely parsed.

Parameters:

innerPolygon - Consumer application object that represents a innerPolygon

startMultiPoint

java.lang.Object startMultiPoint(java.lang.String id,
                                 java.lang.String srs)

This method indicates that the parser has found a multipoint.

Parameters:

id - MultiPoint identifier

srs - Spatial reference system

Returns:

Consumer application object that represents a multiPoint

startMultiPoint

java.lang.Object startMultiPoint(java.lang.String id,
                                 java.lang.String srs,
                                 int dimension)

endMultiPoint

void endMultiPoint(java.lang.Object multiPoint)

It is thrown when the multiPoint has been completely parsed

Parameters:

multiPoint - Consumer application object that represents a multiPoint

addPointToMultiPoint

void addPointToMultiPoint(java.lang.Object point,
                          java.lang.Object multiPoint)

It is thrown to add a point to one multiPoint.

Parameters:

point - Consumer application object that represents a point

multiPoint - Consumer application object that represents a multiPoint

startMultiLineString

java.lang.Object startMultiLineString(java.lang.String id,
                                      java.lang.String srs)

This method indicates that the parser has found a multiLineString.

Parameters:

id - MultiLineString identifier

srs - Spatial reference system

Returns:

Consumer application object that represents a multiLineString

startMultiLineString

java.lang.Object startMultiLineString(java.lang.String id,
                                      java.lang.String srs,
                                      int dimension)

endMultiLineString

void endMultiLineString(java.lang.Object multiLineString)

It is thrown when the multiLineString has been completely parsed

Parameters:

multiLineString - Consumer application object that represents a multiLineString

addLineStringToMultiLineString

void addLineStringToMultiLineString(java.lang.Object lineString,
                                    java.lang.Object multiLineString)

It is thrown to add a lineString to one lineString.

Parameters:

lineString - Consumer application object that represents a lineString

multiLineString - Consumer application object that represents a multiLineString

startMultiPolygon

java.lang.Object startMultiPolygon(java.lang.String id,
                                   java.lang.String srs)

This method indicates that the parser has found a multiPolygon.

Parameters:

id - MultiPolygon identifier

srs - Spatial reference system

Returns:

Consumer application object that represents a multiPolygon

startMultiPolygon

java.lang.Object startMultiPolygon(java.lang.String id,
                                   java.lang.String srs,
                                   int dimension)

endMultiPolygon

void endMultiPolygon(java.lang.Object multiPolygon)

It is thrown when the multiPolygon has been completely parsed

Parameters:

multiPolygon - Consumer application object that represents a multiPolygon

addPolygonToMultiPolygon

void addPolygonToMultiPolygon(java.lang.Object polygon,
                              java.lang.Object multiPolygon)

It is thrown to add a polygon to one multiPolygon.

Parameters:

polygon - Consumer application object that represents a polygon

multiPolygon - Consumer application object that represents a multiPolygon

startMultiGeometry

java.lang.Object startMultiGeometry(java.lang.String id,
                                    java.lang.String srs)

This method indicates that the parser has found a multiGeometry.

Parameters:

id - MultiGeometry identifier

srs - Spatial reference system

Returns:

Consumer application object that represents a multiGeometry

endMultiGeometry

void endMultiGeometry(java.lang.Object multiGeometry)

It is thrown when the multiGeometry has been completely parsed

Parameters:

multiGeometry - Consumer application object that represents a multiGeometry

addGeometryToMultiGeometry

void addGeometryToMultiGeometry(java.lang.Object geometry,
                                java.lang.Object multiGeometry)

It is thrown to add a geometry to one multiGeometry.

Parameters:

geometry - Consumer application object that represents a geometry

multiGeometry - Consumer application object that represents a multiGeometry

addBboxToFeature

void addBboxToFeature(java.lang.Object bbox,
                      java.lang.Object feature)

This method adds a bounding box to a feature.

Parameters:

bbox - Consumer application object that represents a bounding box

feature - Consumer application object that represents a feature

addGeometryToFeature

void addGeometryToFeature(java.lang.Object geometry,
                          java.lang.Object feature)

This method adds a geometry to a feature.

Parameters:

geometry - Consumer application object that represents a geometry

feature - Consumer application object that represents a feature

startMetadata

java.lang.Object startMetadata(java.lang.String type,
                               java.lang.String data,
                               IAttributesIterator attributes)

It is thrown when the parser has found a new metadata tag

Parameters:

type - String with the type of metadata, if is a description or any else

data - String with the value of the data.

attributes - Object to pass the Atributtes

Returns:

Consumer application object that represents metadata

addMetadataToFeature

void addMetadataToFeature(java.lang.Object metadata,
                          java.lang.Object feature)

This method adds metadata to feature.

Parameters:

metadata - Consumer application object that represents metadata

feature - Consumer application object that represents a feature

addMetadataToMetadata

void addMetadataToMetadata(java.lang.Object metadata,
                           java.lang.Object parent)

This method adds metadata to complex metadata.

Parameters:

metadata - Consumer application object that represents metadata

parent - Consumer application object that represents the complex metadata

endMetadata

void endMetadata(java.lang.Object metadata)

This method is thrown when the parser find the end of the metadata of an element.

Parameters:

metadata - Consumer application object that represents metadata

endTime

void endTime(java.lang.Object time)

This method is thrown when the parser find the end of and element time tag

Parameters:

time - Consumer application object that represents time

startTime

java.lang.Object startTime(java.lang.String name,
                           java.lang.String description,
                           java.lang.String type,
                           java.lang.String time,
                           java.lang.Object previous,
                           java.lang.Object next)

It is thrown when the parser has found a new time tag tag

Parameters:

type - String with the type of time, if is a description or any else

data - String with the value of the data.

Returns:

Consumer application object that represents time

startTime

java.lang.Object startTime(java.lang.String type,
                           java.lang.String time)

addTimeToFeature

void addTimeToFeature(java.lang.Object time,
                      java.lang.Object feature)

This method adds time to feature.

Parameters:

time - Consumer application object that represents time

feature - Consumer application object that represents a feature