OraWriter (com.vividsolutions:jts-ora 1.14.0 API)

java.lang.Object
- com.vividsolutions.jts.io.oracle.OraWriter

```
public class OraWriter
extends Object
```
Translates a JTS Geometry into an Oracle STRUCT representing an MDSYS.SDO_GEOMETRY object. Supports writing all JTS geometry types into an equivalent Oracle representation.
To write an Oracle STRUCT a connection to an Oracle instance with access to the definition of the MDSYS.SDO_GEOMETRY type is required. Oracle SDO_GEOMETRY SQL strings may be written without a connection, however.
By default, a single Point is written using the optimized SDO_POINT_TYPE attribute. This can be overridden to use the (less compact) SDO_ELEM_INFO/SDOORDINATES representation by using setOptimizePoint(boolean).
By default, rectangular polygons are written as regular 5-point polygons. This can be changed to use the optimized RECTANGLE points by using setOptimizeRectangle(boolean). Note that RECTANGLEs do not support LRS Measure ordinate values. Also, this class only writes RECTANGLEs for polygons containing a single ring (i.e. the shell).
Oracle cannot represent MultiPolygons or MultiLineStrings directly as elements of a GeometryCollection. Instead, their components are written individually. MultiPoints are represented directly, however. The dimension of the output SDO_GEOMETRY is determined as follows:
- by default, the dimension matches that of the input
- currently the coordinate dimension of the input is determined by inspecting a sample coordinate. If the Z value is NaN, the coordinate dimension is assumed to be 2. (In the future this will be determined from the underlying CoordinateSequences.
- the dimension can be set explicitly by the setDimension(int) method. This allows forcing Z output even if the Z values are NaN. Conversely, if Z values are present this allows forcing 2D output.
LIMITATIONS
- Since JTS does not support Measures, they cannot be written. (A future release could allow forcing interpreting Z as M, or else providing a fixed M value).
Author:

Martin Davis, David Zwiers, Vivid Solutions.

Constructor Summary

Constructors
Constructor and Description
`OraWriter()` Creates a writer for Oracle geometry formats.
`OraWriter(int outputDimension)` Creates a writer for Oracle geometry formats, specifying the maximum output dimension.
`OraWriter(oracle.jdbc.OracleConnection con)` Deprecated. use `OraWriter()` instead
`OraWriter(oracle.jdbc.OracleConnection con, int outputDimension)` Deprecated. use `OraWriter(int)` instead

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`setDimension(int outputDimension)` Sets the coordinate dimension for the created Oracle geometries.
`void`	`setOptimizePoint(boolean isOptimizePoint)` Sets whether points should be written using the optimized SDO_POINT_TYPE format.
`void`	`setOptimizeRectangle(boolean isOptimizeRectangle)` Sets whether rectangle polygons should be written using the optimized 4-coordinate RECTANGLE format (ETYPE=1003, INTERPRETATION=3).
`void`	`setSRID(int srid)` Forces geometries to be written using the specified SRID.
`oracle.sql.STRUCT`	`write(Geometry geom)` Deprecated.
`oracle.sql.STRUCT`	`write(Geometry geom, oracle.jdbc.OracleConnection connection)` Converts a `Geometry` into an Oracle MDSYS.SDO_GEOMETRY STRUCT.
`String`	`writeSQL(Geometry geom)` Writes a Geometry in Oracle SDO_GEOMETRY SQL literal format.

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

- Constructor Detail
  - OraWriter
```
public OraWriter()
```
    Creates a writer for Oracle geometry formats. The output dimension will be whatever the dimension of the input is.
  - OraWriter
```
public OraWriter(int outputDimension)
```
    Creates a writer for Oracle geometry formats, specifying the maximum output dimension.
    
    Parameters:
    outputDimension - the coordinate dimension to use for the output
  - OraWriter
```
public OraWriter(oracle.jdbc.OracleConnection con)
```
    Deprecated. use OraWriter() instead
    
    Creates a writer using a valid Oracle connection.
    To simplify connection resource handling, the connection should be provided in the write(Geometry, OracleConnection) method. Accordingly, this constructor has been deprecated.
    The connection should have sufficient privileges to view the description of the MDSYS.SDO_GEOMETRY type.
    The output dimension will be whatever the dimension of the input is.
    
    Parameters:
    con - a valid Oracle connection
  - OraWriter
```
public OraWriter(oracle.jdbc.OracleConnection con,
         int outputDimension)
```
    Deprecated. use OraWriter(int) instead
    
    Creates a writer using a valid Oracle connection, and specifying the maximum output dimension.
    To simplify connection resource handling, the connection should be provided in the write(Geometry, OracleConnection) method. Accordingly, this constructor has been deprecated.
    The connection should have sufficient privileges to view the description of the MDSYS.SDO_GEOMETRY type.
    
    Parameters:
    con - a valid Oracle connection
    outputDimension - the coordinate dimension to use for the output
- Method Detail
  - setDimension
```
public void setDimension(int outputDimension)
```
    Sets the coordinate dimension for the created Oracle geometries.
    
    Parameters:
    outputDimension - the coordinate dimension to use for the output
  - setSRID
```
public void setSRID(int srid)
```
    Forces geometries to be written using the specified SRID. This is useful in two cases:
    - to avoid using the native geometry's SRID
    - to ensure an entire table is written using a fixed SRID.
    Parameters:
    srid - the srid to use
  - setOptimizeRectangle
```
public void setOptimizeRectangle(boolean isOptimizeRectangle)
```
    Sets whether rectangle polygons should be written using the optimized 4-coordinate RECTANGLE format (ETYPE=1003, INTERPRETATION=3). If this option is false, rectangles are written as 5-coordinate polygons. The default setting is false.
    
    Parameters:
    isOptimizeRectangle - whether to optimize rectangle writing
  - setOptimizePoint
```
public void setOptimizePoint(boolean isOptimizePoint)
```
    Sets whether points should be written using the optimized SDO_POINT_TYPE format. If this option is false, points are written using the SDO_ORDINATES attribute. The default setting is true.
    
    Parameters:
    isOptimizePoint - whether to optimize point writing
  - write
```
public oracle.sql.STRUCT write(Geometry geom)
                        throws SQLException
```
    Deprecated.
    Converts a Geometry into an Oracle MDSYS.SDO_GEOMETRY STRUCT.
    Although invalid geometries may be encoded, and inserted into an Oracle DB, this is not recommended. It is the responsibility of the user to ensure the geometry is valid prior to calling this method.
    The SRID of the created SDO_GEOMETRY is the SRID defined explicitly for the writer, if any; otherwise it is the SRID contained in the input geometry. The caller should ensure the the SRID is valid for the intended use, since an incorrect SRID may cause indexing exceptions during an INSERT or UPDATE.
    When a null Geometry is passed in, a non-null, empty SDO_GEOMETRY STRUCT is returned. Therefore, inserting the output of the writer into a table will never result in NULL insertions. To pass a NULL Geometry into an Oracle SDO_GEOMETRY-valued parameter using JDBC, use
```
 java.sql.CallableStatement.setNull(index, java.sql.Types.STRUCT, "MDSYS.SDO_GEOMETRY"). 
 
```
    Parameters:
    geom - the geometry to encode
    
    Returns:
    a Oracle MDSYS.SDO_GEOMETRY STRUCT representing the geometry
    
    Throws:
    
    SQLException - if an encoding error was encountered
  - write
```
public oracle.sql.STRUCT write(Geometry geom,
                      oracle.jdbc.OracleConnection connection)
                        throws SQLException
```
    Converts a Geometry into an Oracle MDSYS.SDO_GEOMETRY STRUCT.
    Although invalid geometries may be encoded, and inserted into an Oracle DB, this is not recommended. It is the responsibility of the user to ensure the geometry is valid prior to calling this method.
    The SRID of the created SDO_GEOMETRY is the SRID defined explicitly for the writer, if any; otherwise it is the SRID contained in the input geometry. The caller should ensure the the SRID is valid for the intended use, since an incorrect SRID may cause indexing exceptions during an INSERT or UPDATE.
    When a null Geometry is passed in, a non-null, empty SDO_GEOMETRY STRUCT is returned. Therefore, inserting the output of the writer into a table will never result in NULL insertions. To pass a NULL Geometry into an Oracle SDO_GEOMETRY-valued parameter using JDBC, use
```
 java.sql.CallableStatement.setNull(index, java.sql.Types.STRUCT, "MDSYS.SDO_GEOMETRY"). 
 
```
    Parameters:
    geom - the geometry to encode
    
    Returns:
    a Oracle MDSYS.SDO_GEOMETRY STRUCT representing the geometry
    
    Throws:
    
    SQLException - if an encoding error was encountered
  - writeSQL
```
public String writeSQL(Geometry geom)
```
    Writes a Geometry in Oracle SDO_GEOMETRY SQL literal format.
    Examples of output are:
```
 SDO_GEOMETRY(2001,NULL,NULL,SDO_ELEM_INFO_ARRAY(1,1,1),SDO_ORDINATE_ARRAY(50,50))
 SDO_GEOMETRY(3001,NULL,SDO_POINT_TYPE(50,50,100,),NULL,NULL)
 SDO_GEOMETRY(3006,8307,NULL,SDO_ELEM_INFO_ARRAY(1,2,1,  7,2,1),SDO_ORDINATE_ARRAY(0,0,2,  50,50,100,  10,10,12,  150,150,110))
 
```
    Parameters:
    geom - the Geometry to write
    
    Returns:
    a string representing the geometry as an SDO_GEOMETRY literal

Class OraWriter

LIMITATIONS

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

OraWriter

OraWriter

OraWriter

OraWriter

Method Detail

setDimension

setSRID

setOptimizeRectangle

setOptimizePoint

write

write

writeSQL