ilog.views.maps.format.oracle.objectmodel

Class IlvObjectSDOWriter

java.lang.Object

ilog.views.maps.format.oracle.objectmodel.IlvObjectSDOWriter

public class IlvObjectSDOWriter
extends Object

This class can write features to an Oracle Spatial layer, using the object model. Once the geometries are written into the layer, you have to call the close() method.

Since:

JViews 3.5

Constructor Summary

Constructors

Constructor and Description
IlvObjectSDOWriter(Connection connection, String layerName, String geometryColumnName, String xDimName, String yDimName, boolean createTable) Constructs a writer to write data to an Oracle Spatial layer.
IlvObjectSDOWriter(Connection connection, String layerName, String geometryColumnName, String xDimName, String yDimName, boolean createTable, IlvAttributeInfoProperty info, IlvCoordinate upperLeftCorner, IlvCoordinate lowerRightCorner) Constructs a writer to write data to an Oracle Spatial layer.

Method Summary

Modifier and Type	Method and Description
void	close(double tolerance, Long srID) Closes this writer.
Connection	getConnection() Returns the current connection of the writer.
String	getLayerName() Returns the name of the current SDO layer in use.
protected String	getSDOGeometryString(IlvMapFeature feature, Long srID) Returns the string corresponding to the SQL description of the specified feature.
boolean	isCheckingStringAttributes() Returns whether the writer is checking string attributes or not.
boolean	isUsingOrderedRings() Returns a boolean that indicates whether the order of the IlvMapRings used in IlvMapPolygons is known or not.
void	populateIndexes(int fixedTilingLevel, int sdoNumtiles, String indexName, String sdoLayerName, String sdoGeometryColumnName) Creates the spatial index table.
void	populateIndexes(int fixedTilingLevel, int sdoNumtiles, String indexName, String sdoLayerName, String sdoGeometryColumnName, int sdoMaxlevel, int sdoCommitInterval, String layerGtype, String sdoTableSpace, String sdoInitialExtent, String sdoNextExtent, int sdoMinExtents, int sdoMaxExtents, int sdoPCTincrease, String btreeInitialExtent, String btreeNextExtent, int btreePCTincrease) Creates the spatial index table.
void	setCheckingStringAttributes(boolean check) Enables/disables the checking of string attributes.
void	setUsingOrderedRings(boolean set) Sets whether the order of the IlvMapRings used in IlvMapPolygons is known or not.
void	updateFeatureAttribute(String keyColumnName, IlvFeatureAttribute keyAttribute, String attributeColumnName, IlvFeatureAttribute attributeToUpdate) Updates a row in the SDO layer with one attribute.
void	updateFeatureAttributes(IlvFeatureAttributeProperty attributes, int keyPos) Updates a row in the SDO layer with new attributes.
void	writeFeature(IlvMapFeature feature, boolean saveAttributes, Long srID) Puts the specified map feature in the database.
int	writeFeatureIterator(IlvMapFeatureIterator reader, boolean saveAttributes, Long srID) Writes the iterator passed as its argument into the Oracle SDO database.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

IlvObjectSDOWriter

public IlvObjectSDOWriter(Connection connection,
                          String layerName,
                          String geometryColumnName,
                          String xDimName,
                          String yDimName,
                          boolean createTable)
                   throws SQLException

Constructs a writer to write data to an Oracle Spatial layer.

Parameters:

connection - The Connection to the Oracle Database. The writer turns off the connection auto commit mode.

layerName - The name of the SDO layer table. It can be made of the owner name and the table name ("OwnerName.TableName").

geometryColumnName - The name of the column containing the geometries objects.

xDimName - The name of the X dimension.

yDimName - The name of the Y dimension.

createTable - If set to true, the writer will create the necessary table and entries (note that you can do this only under certain Oracle privileges).

Throws:

SQLException

IlvObjectSDOWriter

public IlvObjectSDOWriter(Connection connection,
                          String layerName,
                          String geometryColumnName,
                          String xDimName,
                          String yDimName,
                          boolean createTable,
                          IlvAttributeInfoProperty info,
                          IlvCoordinate upperLeftCorner,
                          IlvCoordinate lowerRightCorner)
                   throws SQLException

Constructs a writer to write data to an Oracle Spatial layer.

Parameters:

connection - The Connection to the Oracle Database. The writer turns off the connection auto commit mode.

layerName - The name of the SDO layer table. It can be made of the owner name and the table name ("OwnerName.TableName").

geometryColumnName - The name of the column containing the geometries objects.

xDimName - The name of the X dimension.

yDimName - The name of the Y dimension.

createTable - If set to true, the writer will create the necessary table and entries (note that you can do this only under certain Oracle privileges).

info - If this parameter is set, it will be used in the creation of attributes columns of the layer.

upperLeftCorner - The upper left corner of the extent of the SDO layer. If set to null, the corner is computed so that it fits the written data.

lowerRightCorner - The lower right corner of the extent of the SDO layer. If set to null, the corner is computed so that it fits the written data.

Throws:

SQLException

Method Detail

getLayerName

public String getLayerName()

Returns the name of the current SDO layer in use. The returned String may be of type "OwnerName.TableName".

getConnection

public Connection getConnection()

Returns the current connection of the writer.

setUsingOrderedRings

public void setUsingOrderedRings(boolean set)

Sets whether the order of the IlvMapRings used in IlvMapPolygons is known or not. Since Oracle 8.1.6, there is an optimized mode for ordered IlvMapRings in SDO. If you are sure that the polygons you want to write into SDO have IlvMapRings that have :

• the counter-clockwise order for exterior rings.
• the clockwise order for interior rings.

then call this method with the true parameter. The default mode is false (the orders of the rings are unknown).

Parameters:

set - If set to true, the orders of the rings are supposed to be known as the Oracle scheme described above.

isUsingOrderedRings

public boolean isUsingOrderedRings()

Returns a boolean that indicates whether the order of the IlvMapRings used in IlvMapPolygons is known or not.

See Also:

setUsingOrderedRings(boolean)

isCheckingStringAttributes

public boolean isCheckingStringAttributes()

Returns whether the writer is checking string attributes or not.

Returns:

Whether the writer is checking string attributes or not.

Since:

JViews 5.0

See Also:

setCheckingStringAttributes(boolean)

setCheckingStringAttributes

public void setCheckingStringAttributes(boolean check)

Enables/disables the checking of string attributes. This method allows to enable the checking of string attibutes so that any string attribute handled by the writer will be checked looking for any "'" character. This is necessary if you want to insert the string attributes into Oracle because the "'" characters have to be doubled ("''") in order to avoid an ORA-01756 error. String checking can be time consuming. By default, the writer doesn't check the string attributes.

Parameters:

check - When true, the writer checks the string attributes before inserting them into the database.

Since:

JViews 5.0

See Also:

isCheckingStringAttributes(), writeFeature(ilog.views.maps.IlvMapFeature, boolean, java.lang.Long), writeFeatureIterator(ilog.views.maps.IlvMapFeatureIterator, boolean, java.lang.Long), updateFeatureAttribute(java.lang.String, ilog.views.maps.IlvFeatureAttribute, java.lang.String, ilog.views.maps.IlvFeatureAttribute), updateFeatureAttributes(ilog.views.maps.IlvFeatureAttributeProperty, int)

updateFeatureAttributes

public void updateFeatureAttributes(IlvFeatureAttributeProperty attributes,
                                    int keyPos)
                             throws SQLException,
                                    ClassNotFoundException

Updates a row in the SDO layer with new attributes. To perform this operation, you should give as argument an IlvFeatureAttributeProperty which has an attribute that identifies the row in the SDO layer to be modified. This attribute has to be a KEY in order to modify one unique row in the layer after each call to this method. No commit is done. This method handles the following attributes: IlvStringAttribute, IlvIntegerAttribute, IlvDoubleAttribute and IlvBooleanAttribute. The update is done only if the attributes are columns of the SDO layer itself. If the Key targets more than one row, then they will all be updated. For instance, let FOO be an SDO layer with 3 columns: GEOMETRY (type SDO_GEOMETRY), keyID (type VARCHAR and created as not null key), intID (type NUMBER). Imagine you have the following: GEOMETRY = whatever ; keyID = "UniqueKey1" ; intID = 122 If you need to update this row with the new intID 1098, then use the following code:

 // Construction of the IlvAttributeInfoProperty : it can be done just once.
 Class[] attributeClasses = new Class[2];
 boolean[] nullable = new boolean[2];
 nullable[0] = nullable[1] = true;
 try {
   attributeClasses[0] = Class.forName("IlvStringAttribute");
   attributeClasses[1] = Class.forName("IlvIntegerAttribute");
 } catch (ClassNotFoundException e) {
   e.printStackTrace();
 }
 String[] names = new String[2];
 names[0] = new String("keyID"); // the first one must be the KEY
 names[1] = new String("intID");
 IlvAttributeInfoProperty info = 

  new IlvAttributeInfoProperty(names, attributeClasses, nullable);
 
 // the update itself
 IlvFeatureAttribute[] attributes = new IlvFeatureAttribute[2];
 attributes[0] = new IlvStringAttribute("UniqueKey1");
 attributes[1] = new IlvIntegerAttribute(1098); // the new value for update
 IlvFeatureAttributeProperty prop = 

  new IlvFeatureAttributeProperty(info, attributes);
 myWriter.updateFeatureAttributes(prop, 0);
 

Parameters:

attributes - The list of the attributes.

keyPos - The position of the key attribute in the attributes list.

Throws:

SQLException

ClassNotFoundException

updateFeatureAttribute

public void updateFeatureAttribute(String keyColumnName,
                                   IlvFeatureAttribute keyAttribute,
                                   String attributeColumnName,
                                   IlvFeatureAttribute attributeToUpdate)
                            throws SQLException,
                                   ClassNotFoundException

Updates a row in the SDO layer with one attribute. This method updates in the SDO layer, the attribute named attributeColumnName and valued attributeToUpdate in the row identified by the key named keyColumnName and valued keyAttribute (Oracle KEY). If the Key targets more than one row, then they will all be updated. No commit is done. This method handles the following attributes: IlvStringAttribute, IlvIntegerAttribute, IlvDoubleAttribute and IlvBooleanAttribute. This method executes the following update statement : "UPDATE tableName SET attributeColumnName = 'attributeToUpdate' WHERE keyColumnName = 'keyAttribute';"

Parameters:

keyColumnName - The name of the column in the SDO layer representing the KEY.

keyAttribute - The value of the key which is an IlvFeatureAttribute.

attributeColumnName - The name of the column in the SDO layer to be updated.

attributeToUpdate - The value of the attribute to be updated which is an IlvFeatureAttribute.

Throws:

SQLException

ClassNotFoundException

writeFeature

public void writeFeature(IlvMapFeature feature,
                         boolean saveAttributes,
                         Long srID)
                  throws SQLException,
                         ClassNotFoundException

Puts the specified map feature in the database. It's up to you to commit the written feature if needed.

Parameters:

feature - The map feature to be written in the Database.

saveAttributes - If set to false, only the IlvMapGeometry of the feature is saved into the SDO layer. If set to true, the writer will also insert the IlvFeatureAttributes contained in the IlvFeatureAttributeProperty of the feature. Note that in this last case, the name of the attributes must be the same that the column names of the Oracle SDO layer table in the database.

srID - The ID of the coordinate system as described in the CS_SRS table. This ID will be saved in the SDO_SRID column of the SDO_GEOMETRY object wrote. You can pass it as null.

Throws:

SQLException

ClassNotFoundException

Since:

JViews 5.0

writeFeatureIterator

public int writeFeatureIterator(IlvMapFeatureIterator reader,
                                boolean saveAttributes,
                                Long srID)
                         throws Exception

Writes the iterator passed as its argument into the Oracle SDO database. It also closes the writer and commits the data.

Parameters:

reader - The IlvMapFeatureIterator instance.

saveAttributes - If set to false, only the IlvMapGeometry of the feature is saved into the SDO layer. If set to true, the writer will also insert the IlvFeatureAttributes contained in the IlvFeatureAttributeProperty of the feature. Note that in this last case, the name of the attributes must be the same that the column names of the Oracle SDO layer table in the database.

srID - The ID of the coordinate system as described in the CS_SRS table. This ID will be saved in the SDO_SRID column of the SDO_GEOMETRY objects wrote. You can pass it as null.

Returns:

The number of saved objects.

Throws:

Exception

Since:

JViews 5.0

See Also:

writeFeature(ilog.views.maps.IlvMapFeature, boolean, java.lang.Long)

getSDOGeometryString

protected String getSDOGeometryString(IlvMapFeature feature,
                                      Long srID)
                               throws ClassNotFoundException,
                                      SQLException

Returns the string corresponding to the SQL description of the specified feature. For example, for a linestring geometry, this should be:

 (0,50,0,-50);
 insert into OwnerName.TableName(GEOMETRY) values 

  (MDSYS.SDO_GEOMETRY(2, srID, NULL, MDSYS.SDO_ELEM_INFO_ARRAY(1,2,1), v));
 

The 'v' argument passed to the values statement is necessary because the final request for the linestring will be for instance of the following shape:

 declare
 v MDSYS.SDO_ORDINATE_ARRAY;
 begin
 v:= MDSYS.SDO_ORDINATE_ARRAY(0,50,0,-50);
 insert into OwnerName.TableName(GEOMETRY) values 

  (MDSYS.SDO_GEOMETRY(2, srID, NULL, MDSYS.SDO_ELEM_INFO_ARRAY(1,2,1), v));
 end;
 

If you use a JDBC driver provided by Oracle (like "thin" for instance), do not override this method: the writer uses the mechanism of SQL parameters instead of strings in order to write geometries so that this method is not used.

Parameters:

feature - The IlvMapFeature to be mapped into a string.

srID - The ID of the coordinate system as described in the CS_SRS table. This ID will appear in the geometry string returned by this method. You can pass it as null.

Returns:

The string corresponding to the SQL description of the specified feature.

Throws:

ClassNotFoundException

SQLException

Since:

JViews 5.0

populateIndexes

public void populateIndexes(int fixedTilingLevel,
                            int sdoNumtiles,
                            String indexName,
                            String sdoLayerName,
                            String sdoGeometryColumnName,
                            int sdoMaxlevel,
                            int sdoCommitInterval,
                            String layerGtype,
                            String sdoTableSpace,
                            String sdoInitialExtent,
                            String sdoNextExtent,
                            int sdoMinExtents,
                            int sdoMaxExtents,
                            int sdoPCTincrease,
                            String btreeInitialExtent,
                            String btreeNextExtent,
                            int btreePCTincrease)
                     throws SQLException

Creates the spatial index table. Creating a spatial index is mandatory for the use of an IlvObjectSDOLayer. This method just calls the Oracle SDO CREATE INDEX statement. The parameters are the same as the ones of this statement. To have your data correctly indexed, please refer to the Oracle SDO documentation (this is strongly recommended). Note that Oracle recommends the use of R-Tree indexes since Oracle 9i. To have an R-Tree index, set the first two parameters of the method to 0.

Throws:

SQLException

populateIndexes

public void populateIndexes(int fixedTilingLevel,
                            int sdoNumtiles,
                            String indexName,
                            String sdoLayerName,
                            String sdoGeometryColumnName)
                     throws SQLException

Creates the spatial index table. Creating a spatial index is mandatory for the use of an IlvObjectSDOLayer.

Throws:

SQLException

close

public void close(double tolerance,
                  Long srID)
           throws SQLException

Closes this writer. This method updates the [USER_]SDO_GEOM_METADATA table and commits the current Connection. This method should be called after each set of calls to #writeFeature.

Parameters:

tolerance - The tolerance of the layer that is inserted in the [USER_]SDO_GEOM_METADATA table.

srID - The id of the Coordinate System as described in the CS_SRS table. This id will be saved in the [USER_]SDO_GEOM_METADATA in the SRID column. You can pass it as null.

Throws:

SQLException

Since:

JViews 5.0