GMLUtils (SWE Common OM and GML Models 1.1-beta1 API)

java.lang.Object
- org.vast.xml.XMLBindingsUtils
- - org.vast.ogc.gml.GMLUtils

```
public class GMLUtils
extends XMLBindingsUtils
```
Utility methods to read/write GML documents. This class is not thread-safe.

Since:

Feb 8, 2014

Author:

Alex Robin

Field Summary

Fields
Modifier and Type Field and Description

static String GML

static String V3_2

Fields
Modifier and Type	Field and Description
`static String`	`GML`
`static String`	`V3_2`

Constructor Summary

Constructors
Constructor and Description

GMLUtils(String version)

Constructors
Constructor and Description
`GMLUtils(String version)`

Method Summary

Methods
Modifier and Type	Method and Description
`Envelope`	`bboxToEnvelope(Bbox bbox)` Utility method to convert a `Bbox` object to a GML `Envelope`
`static Envelope`	`bboxToEnvelope(Bbox bbox, GMLFactory gmlFac)` Utility method to convert a `Bbox` object to a GML `Envelope`
`static Bbox`	`envelopeToBbox(Envelope env)` Utility method to convert from a GML `Envelope` to a `Bbox` object
`GMLFactory`	`getGmlFactory()`
`Envelope`	`readEnvelope(DOMHelper dom, Element envElt)` Reads a GML envelope from a DOM element
`Bbox`	`readEnvelopeAsBbox(DOMHelper dom, Element envElt)` Reads a GML `Envelope` from a DOM element as a `Bbox` object
`GenericFeature`	`readFeature(DOMHelper dom, Element featureElt)` Reads a GML generic feature from a DOM element
`GenericFeature`	`readFeature(InputStream inputStream)` Reads a GML generic feature directly from an input stream
`AbstractGeometry`	`readGeometry(DOMHelper dom, Element geomElt)` Reads a GML geometry from a DOM element
`AbstractTimeGeometricPrimitive`	`readTimePrimitive(DOMHelper dom, Element timeElt)` Reads a GML time primitive from a DOM element
`TimeExtent`	`readTimePrimitiveAsTimeExtent(DOMHelper dom, Element timeElt)` Reads a GML time primitive from a DOM element as a `TimeExtent` object
`AbstractTimeGeometricPrimitive`	`timeExtentToTimePrimitive(TimeExtent timeExtent, boolean forcePeriod)` Utility method to convert a `TimeExtent` to a `AbstractTimeGeometricPrimitive` object
`TimeExtent`	`timePrimitiveToTimeExtent(AbstractTimeGeometricPrimitive timePrimitive)` Utility method to convert a `AbstractTimeGeometricPrimitive` to a `TimeExtent` object
`Element`	`writeBboxAsEnvelope(DOMHelper dom, Bbox bbox)` Writes a `Bbox` object as a GML `Envelope` DOM element
`Element`	`writeEnvelope(DOMHelper dom, Envelope env)` Writes a GML envelope as a DOM element
`Element`	`writeFeature(DOMHelper dom, AbstractFeature feature)` Writes a GML feature as a DOM element
`void`	`writeFeature(OutputStream os, AbstractFeature feature, boolean indent)`
`Element`	`writeGeometry(DOMHelper dom, AbstractGeometry geom)` Writes a GML geometry as a DOM element
`Element`	`writeTimeExtentAsTimePeriod(DOMHelper dom, TimeExtent timeExtent)` Writes a `TimeExtent` object as a GML time period DOM element
`Element`	`writeTimeExtentAsTimePrimitive(DOMHelper dom, TimeExtent timeExtent)` Writes a `TimeExtent` object as a GML time primitive DOM element
`Element`	`writeTimePrimitive(DOMHelper dom, AbstractTimeGeometricPrimitive timePrimitive)` Writes a GML time primitive as a DOM element

Methods inherited from class org.vast.xml.XMLBindingsUtils
readFromStream, setEncoding

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - GML
```
public static final String GML
```
    See Also:
    Constant Field Values
  - V3_2
```
public static final String V3_2
```
    See Also:
    Constant Field Values
- Constructor Detail
  - GMLUtils
```
public GMLUtils(String version)
```
- Method Detail
  - readFeature
```
public GenericFeature readFeature(InputStream inputStream)
                           throws XMLReaderException
```
    Reads a GML generic feature directly from an input stream
    
    Parameters:
    inputStream - input stream to parse from
    
    Returns:
    the new feature instance
    
    Throws:
    
    XMLReaderException
  - readFeature
```
public GenericFeature readFeature(DOMHelper dom,
                         Element featureElt)
                           throws XMLReaderException
```
    Reads a GML generic feature from a DOM element
    
    Parameters:
    dom - parent DOM helper instance
    featureElt - element to parse from
    
    Returns:
    the new feature instance
    
    Throws:
    
    XMLReaderException
  - readGeometry
```
public AbstractGeometry readGeometry(DOMHelper dom,
                            Element geomElt)
                              throws XMLReaderException
```
    Reads a GML geometry from a DOM element
    
    Parameters:
    dom - parent DOM helper instance
    geomElt - element to parse from
    
    Returns:
    the new geometry instance
    
    Throws:
    
    XMLReaderException
  - readTimePrimitive
```
public AbstractTimeGeometricPrimitive readTimePrimitive(DOMHelper dom,
                                               Element timeElt)
                                                 throws XMLReaderException
```
    Reads a GML time primitive from a DOM element
    
    Parameters:
    dom - parent DOM helper instance
    timeElt - element to parse from
    
    Returns:
    the new time primitive instance
    
    Throws:
    
    XMLReaderException
  - readTimePrimitiveAsTimeExtent
```
public TimeExtent readTimePrimitiveAsTimeExtent(DOMHelper dom,
                                       Element timeElt)
                                         throws XMLReaderException
```
    Reads a GML time primitive from a DOM element as a TimeExtent object
    
    Parameters:
    dom - parent DOM helper instance
    timeElt - element to parse from
    
    Returns:
    the new TimeExtent instance
    
    Throws:
    
    XMLReaderException
  - readEnvelope
```
public Envelope readEnvelope(DOMHelper dom,
                    Element envElt)
                      throws XMLReaderException
```
    Reads a GML envelope from a DOM element
    
    Parameters:
    dom - parent DOM helper instance
    envElt - element to parse from
    
    Returns:
    the new envelope instance
    
    Throws:
    
    XMLReaderException
  - readEnvelopeAsBbox
```
public Bbox readEnvelopeAsBbox(DOMHelper dom,
                      Element envElt)
                        throws XMLReaderException
```
    Reads a GML Envelope from a DOM element as a Bbox object
    
    Parameters:
    dom - parent DOM helper instance
    envElt - element to parse from
    
    Returns:
    the new Bbox instance
    
    Throws:
    
    XMLReaderException
  - writeFeature
```
public Element writeFeature(DOMHelper dom,
                   AbstractFeature feature)
                     throws XMLWriterException
```
    Writes a GML feature as a DOM element
    
    Parameters:
    dom - parent DOM helper instance
    feature - generic feature instance to serialize
    
    Returns:
    the newly created DOM element
    
    Throws:
    
    XMLWriterException
  - writeFeature
```
public void writeFeature(OutputStream os,
                AbstractFeature feature,
                boolean indent)
                  throws XMLWriterException,
                         IOException
```
    Throws:
    
    XMLWriterException
    
    IOException
  - writeGeometry
```
public Element writeGeometry(DOMHelper dom,
                    AbstractGeometry geom)
                      throws XMLWriterException
```
    Writes a GML geometry as a DOM element
    
    Parameters:
    dom - parent DOM helper instance
    geom - geometry instance to serialize
    
    Returns:
    the newly created DOM element
    
    Throws:
    
    XMLWriterException
  - writeTimePrimitive
```
public Element writeTimePrimitive(DOMHelper dom,
                         AbstractTimeGeometricPrimitive timePrimitive)
                           throws XMLWriterException
```
    Writes a GML time primitive as a DOM element
    
    Parameters:
    dom - parent DOM helper instance
    timePrimitive - time primitive instance to serialize
    
    Returns:
    the newly created DOM element
    
    Throws:
    
    XMLWriterException
  - writeTimeExtentAsTimePeriod
```
public Element writeTimeExtentAsTimePeriod(DOMHelper dom,
                                  TimeExtent timeExtent)
                                    throws XMLWriterException
```
    Writes a TimeExtent object as a GML time period DOM element
    
    Parameters:
    dom - parent DOM helper instance
    timeExtent - TimeExtent instance to serialize
    
    Returns:
    the newly created DOM element
    
    Throws:
    
    XMLWriterException
  - writeTimeExtentAsTimePrimitive
```
public Element writeTimeExtentAsTimePrimitive(DOMHelper dom,
                                     TimeExtent timeExtent)
                                       throws XMLWriterException
```
    Writes a TimeExtent object as a GML time primitive DOM element
    
    Parameters:
    dom - parent DOM helper instance
    timeExtent - TimeExtent instance to serialize
    
    Returns:
    the newly created DOM element
    
    Throws:
    
    XMLWriterException
  - writeEnvelope
```
public Element writeEnvelope(DOMHelper dom,
                    Envelope env)
                      throws XMLWriterException
```
    Writes a GML envelope as a DOM element
    
    Parameters:
    dom - parent DOM helper instance
    env - envelope instance to serialize
    
    Returns:
    the newly created DOM element
    
    Throws:
    
    XMLWriterException
  - writeBboxAsEnvelope
```
public Element writeBboxAsEnvelope(DOMHelper dom,
                          Bbox bbox)
                            throws XMLWriterException
```
    Writes a Bbox object as a GML Envelope DOM element
    
    Parameters:
    dom - parent DOM helper instance
    bbox - Bbox instance to serialize
    
    Returns:
    the newly created DOM element
    
    Throws:
    
    XMLWriterException
  - timePrimitiveToTimeExtent
```
public TimeExtent timePrimitiveToTimeExtent(AbstractTimeGeometricPrimitive timePrimitive)
```
    Utility method to convert a AbstractTimeGeometricPrimitive to a TimeExtent object
    
    Parameters:
    timePrimitive - GML time primitive
    
    Returns:
    new TimeExtent instance
  - timeExtentToTimePrimitive
```
public AbstractTimeGeometricPrimitive timeExtentToTimePrimitive(TimeExtent timeExtent,
                                                       boolean forcePeriod)
```
    Utility method to convert a TimeExtent to a AbstractTimeGeometricPrimitive object
    
    Parameters:
    timeExtent - TimeExtent object
    forcePeriod - Set to true to force output to be a GML time period
    
    Returns:
    new GML time primitive instance
  - bboxToEnvelope
```
public Envelope bboxToEnvelope(Bbox bbox)
```
    Utility method to convert a Bbox object to a GML Envelope
    
    Parameters:
    bbox - Bbox object
    
    Returns:
    GML envelope
  - bboxToEnvelope
```
public static Envelope bboxToEnvelope(Bbox bbox,
                      GMLFactory gmlFac)
```
    Utility method to convert a Bbox object to a GML Envelope
    
    Parameters:
    bbox - Bbox object
    gmlFac - FActory used to create GML objects
    
    Returns:
    GML envelope
  - envelopeToBbox
```
public static Bbox envelopeToBbox(Envelope env)
```
    Utility method to convert from a GML Envelope to a Bbox object
    
    Parameters:
    env - GML envelope
    
    Returns:
    Bbox instance
  - getGmlFactory
```
public GMLFactory getGmlFactory()
```

Class GMLUtils

Field Summary

Constructor Summary

Method Summary

Methods inherited from class org.vast.xml.XMLBindingsUtils

Methods inherited from class java.lang.Object

Field Detail

GML

V3_2

Constructor Detail

GMLUtils

Method Detail

readFeature

readFeature

readGeometry

readTimePrimitive

readTimePrimitiveAsTimeExtent

readEnvelope

readEnvelopeAsBbox

writeFeature

writeFeature

writeGeometry

writeTimePrimitive

writeTimeExtentAsTimePeriod

writeTimeExtentAsTimePrimitive

writeEnvelope

writeBboxAsEnvelope

timePrimitiveToTimeExtent

timeExtentToTimePrimitive

bboxToEnvelope

bboxToEnvelope

envelopeToBbox

getGmlFactory