Class OracleDialect


  • public class OracleDialect
    extends PreparedStatementSQLDialect
    Abstract dialect implementation for Oracle. Subclasses differ on the way used to parse and encode the JTS geometries into Oracle MDSYS.SDO_GEOMETRY structures.
    Author:
    Justin Deoliveira, OpenGEO, Andrea Aime, OpenGEO, Mark Prins, B3Partners
    • Field Detail

      • GEODETIC

        public static final String GEODETIC
        Marks a geometry column as geodetic
        See Also:
        Constant Field Values
      • CLASSES_TO_GEOM

        public static final Map<Class,​String> CLASSES_TO_GEOM
        A map from JTS Geometry type to Oracle geometry type. See Oracle Spatial documentation, Table 2-1, Valid SDO_GTYPE values.
    • Constructor Detail

      • OracleDialect

        public OracleDialect​(JDBCDataStore dataStore)
    • Method Detail

      • initVersion

        public void initVersion​(Connection cx)
      • setRemarksReporting

        public void setRemarksReporting​(Connection cx,
                                        boolean reportRemarks)
                                 throws SQLException
        Turns on return of column comments metadata.
        Parameters:
        cx - the connection to use
        reportRemarks - true to turn on column comments metadata
        Throws:
        SQLException - if the connection is not valid or there is a problem setting the flag
      • initializeConnection

        public void initializeConnection​(Connection cx)
                                  throws SQLException
        Description copied from class: SQLDialect
        Initializes a newly created database connection.

        Subclasses should override this method if there is some additional action that needs to be taken when a new connection to the database is created. The default implementation does nothing.

        Overrides:
        initializeConnection in class SQLDialect
        Parameters:
        cx - The new database connection.
        Throws:
        SQLException
      • isAggregatedSortSupported

        public boolean isAggregatedSortSupported​(String function)
        Description copied from class: SQLDialect
        Returns true if this dialect supports sorting together with the given aggregation function.
        Overrides:
        isAggregatedSortSupported in class SQLDialect
      • setGetColumnRemarksEnabled

        public void setGetColumnRemarksEnabled​(boolean getColumnRemarksEnabled)
      • isLooseBBOXEnabled

        public boolean isLooseBBOXEnabled()
      • setLooseBBOXEnabled

        public void setLooseBBOXEnabled​(boolean looseBBOXEnabled)
      • isEstimatedExtentsEnabled

        public boolean isEstimatedExtentsEnabled()
      • setEstimatedExtentsEnabled

        public void setEstimatedExtentsEnabled​(boolean estimatedExtenstEnabled)
      • includeTable

        public boolean includeTable​(String schemaName,
                                    String tableName,
                                    Connection cx)
                             throws SQLException
        Description copied from class: SQLDialect
        Determines if the specified table should be included in those published by the datastore.

        This method returns true if the table should be published as a feature type, otherwise it returns false. Subclasses should override this method, this default implementation returns true.

        A database connection is provided to the dialect but it should not be closed. However any statements objects or result sets that are instantiated from it must be closed.

        Overrides:
        includeTable in class SQLDialect
        Parameters:
        schemaName - The schema of the table, might be null..
        tableName - The name of the table.
        cx - Database connection.
        Throws:
        SQLException
      • registerSqlTypeNameToClassMappings

        public void registerSqlTypeNameToClassMappings​(Map<String,​Class<?>> mappings)
        Description copied from class: SQLDialect
        Registers the sql type name to java type mappings that the dialect uses when reading and writing objects to and from the database.

        Subclasses should extend (not override) this method to provide additional mappings, or to override mappings provided by this implementation. This implementation provides the following mappings:

        Overrides:
        registerSqlTypeNameToClassMappings in class SQLDialect
      • getNameEscape

        public String getNameEscape()
        Description copied from class: SQLDialect
        Returns the string used to escape names.

        This value is used to escape any name in a query. This includes columns, tables, schemas, indexes, etc... If no escape is necessary this method should return the empty string, and never return null.

        This default implementation returns a single double quote ("), subclasses must override to provide a different espcape.

        Overrides:
        getNameEscape in class SQLDialect
      • encodeColumnName

        public void encodeColumnName​(String prefix,
                                     String raw,
                                     StringBuffer sql)
        Description copied from class: SQLDialect
        Encodes the name of a column in an SQL statement.

        This method escapes raw using method SQLDialect.escapeName(String). Subclasses usually don't override this method and instead override SQLDialect.getNameEscape().

        The prefix parameter may be null so subclasses that do override must handle that case.

        Overrides:
        encodeColumnName in class SQLDialect
      • decodeGeometryEnvelope

        public Envelope decodeGeometryEnvelope​(ResultSet rs,
                                               int column,
                                               Connection cx)
                                        throws SQLException,
                                               IOException
        Description copied from class: SQLDialect
        Decodes the result of a spatial extent function in a SELECT statement.

        This method is given direct access to a result set. The column parameter is the index into the result set which contains the spatial extent value. The query for this value is build with the SQLDialect.encodeGeometryEnvelope(String, String, StringBuffer) method.

        This method must not read any other objects from the result set other then the one referenced by column.

        Specified by:
        decodeGeometryEnvelope in class SQLDialect
        Parameters:
        rs - A result set
        column - Index into the result set which points at the spatial extent value.
        cx - The database connection.
        Throws:
        SQLException
        IOException
      • decodeGeometryValue

        public Geometry decodeGeometryValue​(GeometryDescriptor descriptor,
                                            ResultSet rs,
                                            String column,
                                            GeometryFactory factory,
                                            Connection cx,
                                            Hints hints)
                                     throws IOException,
                                            SQLException
        Description copied from class: SQLDialect
        Decodes a geometry value from the result of a query.

        This method is given direct access to a result set. The column parameter is the index into the result set which contains the geometric value.

        An implementation should deserialize the value provided by the result set into Geometry object. For example, consider an implementation which deserializes from well known text:

           String wkt = rs.getString( column );
           if ( wkt == null ) {
             return null;
           }
           return new WKTReader(factory).read( wkt );
           
        Note that implementations must handle null values.

        The factory parameter should be used to instantiate any geometry objects.

        Specified by:
        decodeGeometryValue in class SQLDialect
        Throws:
        IOException
        SQLException
      • decodeGeometryValue

        public Geometry decodeGeometryValue​(GeometryDescriptor descriptor,
                                            ResultSet rs,
                                            int column,
                                            GeometryFactory factory,
                                            Connection cx,
                                            Hints hints)
                                     throws IOException,
                                            SQLException
        Description copied from class: SQLDialect
        Decodes a geometry value from the result of a query specifying the column as an index.

        See #decodeGeometryValue(GeometryDescriptor, ResultSet, String, GeometryFactory) for a more in depth description.

        Overrides:
        decodeGeometryValue in class SQLDialect
        Throws:
        IOException
        SQLException
      • setGeometryValue

        public void setGeometryValue​(Geometry g,
                                     int dimension,
                                     int srid,
                                     Class binding,
                                     PreparedStatement ps,
                                     int column)
                              throws SQLException
        Description copied from class: PreparedStatementSQLDialect
        Sets the geometry value into the prepared statement.
        Specified by:
        setGeometryValue in class PreparedStatementSQLDialect
        Parameters:
        g - The geometry
        srid - the geometry native srid (should be forced into the encoded geometry)
        binding - the geometry type
        ps - the prepared statement
        column - the column index where the geometry is to be set
        Throws:
        SQLException
      • createFilterToSQL

        public FilterToSQL createFilterToSQL()
      • getGeometrySRID

        public Integer getGeometrySRID​(String schemaName,
                                       String tableName,
                                       String columnName,
                                       Connection cx)
                                throws SQLException
        Description copied from class: SQLDialect
        Returns the spatial reference system identifier (srid) for a particular geometry column.

        This method is given a direct connection to the database. The connection must not be closed. However any statements or result sets instantiated from the connection must be closed.

        In the event that the srid cannot be determined, this method should return null .

        Overrides:
        getGeometrySRID in class SQLDialect
        Parameters:
        schemaName - The database schema, could be null.
        tableName - The table, never null.
        columnName - The column name, never null
        cx - The database connection.
        Throws:
        SQLException
      • getGeometryDimension

        public int getGeometryDimension​(String schemaName,
                                        String tableName,
                                        String columnName,
                                        Connection cx)
                                 throws SQLException
        Description copied from class: SQLDialect
        Returns the dimension of the coordinates in the geometry. Defaults to 2, subclasses can override it.

        This method is given a direct connection to the database. The connection must not be closed. However any statements or result sets instantiated from the connection must be closed.

        In the event that the dimension cannot be determined, this method should return 2

        Overrides:
        getGeometryDimension in class SQLDialect
        Parameters:
        schemaName - The database schema, could be null.
        tableName - The table, never null.
        columnName - The column name, never null
        cx - The database connection.
        Throws:
        SQLException
      • createCRS

        public CoordinateReferenceSystem createCRS​(int srid,
                                                   Connection cx)
                                            throws SQLException
        Description copied from class: SQLDialect
        Turns the specified srid into a CoordinateReferenceSystem, or returns null if not possible.

        Note this implementation takes account of SQLDialect.forceLongitudeFirst which should be set when longitude first (XY) axis ordering is required.

        The implementation might just use CRS.decode("EPSG:" + srid), but most spatial databases will have their own SRS database that can be queried as well.

        As a rule of thumb you should override this method if your spatial database uses codes that are not part of the EPSG standard database, of if for some reason you deem it preferable to use your database definition instead of an official EPSG one.

        Most overrides will try out to decode the official EPSG code first, and fall back on the custom database definition otherwise

        Overrides:
        createCRS in class SQLDialect
        Throws:
        SQLException
      • encodeGeometryEnvelope

        public void encodeGeometryEnvelope​(String tableName,
                                           String geometryColumn,
                                           StringBuffer sql)
        Description copied from class: SQLDialect
        Encodes the spatial extent function of a geometry column in a SELECT statement.

        This method must also be sure to properly encode the name of the column with the #encodeColumnName(String, StringBuffer) function.

        Specified by:
        encodeGeometryEnvelope in class SQLDialect
      • getOptimizedBounds

        public List<ReferencedEnvelope> getOptimizedBounds​(String schema,
                                                           SimpleFeatureType featureType,
                                                           Connection cx)
                                                    throws SQLException,
                                                           IOException
        Description copied from class: SQLDialect
        Returns the bounds of all geometry columns in the layer using any approach that proves to be faster than the plain bounds aggregation (e.g., better than the "plain select extent(geom) from table" on PostGIS), or null if none exists or the fast method has not been enabled (e.g., if the fast method is just an estimate of the bounds you probably want the user to enable it manually)
        Overrides:
        getOptimizedBounds in class SQLDialect
        Parameters:
        schema - The database schema, if any, or null
        featureType - The feature type containing the geometry columns whose bounds need to computed. Mind, it may be retyped and thus contain less geometry columns than the table
        Returns:
        a list of referenced envelopes (some of which may be null or empty)
        Throws:
        SQLException
        IOException
      • getOptimizedBoundsSDO_TUNE

        public List<ReferencedEnvelope> getOptimizedBoundsSDO_TUNE​(String schema,
                                                                   SimpleFeatureType featureType,
                                                                   Connection cx)
                                                            throws SQLException,
                                                                   IOException
        Throws:
        SQLException
        IOException
      • postCreateTable

        public void postCreateTable​(String schemaName,
                                    SimpleFeatureType featureType,
                                    Connection cx)
                             throws SQLException
        Description copied from class: SQLDialect
        Callback to execute any additional sql statements post a create table statement.

        This method should be implemented by subclasses that need to do some post processing on the database after a table has been created. Examples might include:

        • Creating a sequence for a primary key
        • Registering geometry column metadata
        • Creating a spatial index

        A common case is creating an auto incrementing sequence for the primary key of a table. It should be noted that all tables created through the datastore use the column "fid" as the primary key.

        A direct connection to the database is provided (cx). This connection must not be closed, however any statements or result sets instantiated from the connection must be closed.

        Overrides:
        postCreateTable in class SQLDialect
        Parameters:
        schemaName - The name of the schema, may be null.
        featureType - The feature type that has just been created on the database.
        cx - Database connection.
        Throws:
        SQLException
      • getSequenceForColumn

        public String getSequenceForColumn​(String schemaName,
                                           String tableName,
                                           String columnName,
                                           Connection cx)
                                    throws SQLException
        Description copied from class: SQLDialect
        Determines the name of the sequence (if any) which is used to increment generate values for a table column.

        This method should return null if no such sequence exists.

        This method is given a direct connection to the database, but this connection should never be closed. However any statements or result sets instantiated from the connection must be closed.

        Overrides:
        getSequenceForColumn in class SQLDialect
        Parameters:
        schemaName - The schema name, this might be null.
        tableName - The table name.
        columnName - The column name.
        cx - The database connection.
        Throws:
        SQLException
      • getNextSequenceValue

        public Object getNextSequenceValue​(String schemaName,
                                           String sequenceName,
                                           Connection cx)
                                    throws SQLException
        Description copied from class: SQLDialect
        Obtains the next value of a sequence, incrementing the sequence to the next state in the process.

        Implementations should determine the next value of a column for which values are automatically generated by the database.

        This method is given a direct connection to the database, but this connection should never be closed. However any statements or result sets instantiated from the connection must be closed.

        Implementations should handle the case where schemaName is null.

        Overrides:
        getNextSequenceValue in class SQLDialect
        Parameters:
        schemaName - The schema name, this might be null.
        sequenceName - The name of the sequence.
        cx - The database connection.
        Returns:
        The next value of the sequence, or null.
        Throws:
        SQLException
      • encodeNextSequenceValue

        public String encodeNextSequenceValue​(String schemaName,
                                              String sequenceName)
        Description copied from class: SQLDialect
        Encodes how to get the next sequence value from the DB.

        Implementations should handle the case where schemaName is null.

        Overrides:
        encodeNextSequenceValue in class SQLDialect
      • postDropTable

        public void postDropTable​(String schemaName,
                                  SimpleFeatureType featureType,
                                  Connection cx)
                           throws SQLException
        Description copied from class: SQLDialect
        Callback which executes after a table has been dropped.

        This base implementation does nothing, subclasses should override as need be.

        Overrides:
        postDropTable in class SQLDialect
        Parameters:
        schemaName - The database schema containing the table.
        featureType - The featureType/table being dropped.
        cx - The database connection.
        Throws:
        SQLException
      • isGeodeticSrid

        protected boolean isGeodeticSrid​(Integer srid,
                                         Connection cx)
        Checks if the specified srid is geodetic or not
      • applyLimitOffset

        public void applyLimitOffset​(StringBuffer sql,
                                     int limit,
                                     int offset)
        Description copied from class: SQLDialect
        Alters the query provided so that limit and offset are natively dealt with. This might mean simply appending some extra directive to the query, or wrapping it into a bigger one.
        Overrides:
        applyLimitOffset in class SQLDialect
      • encodeTableAlias

        public void encodeTableAlias​(String raw,
                                     StringBuffer sql)
        Description copied from class: SQLDialect
        Encodes the alias of a table in an sql query.

        This default implementation uses the syntax:

        as "alias"
        . Subclasses should override to provide a different syntax.
        Overrides:
        encodeTableAlias in class SQLDialect
      • registerSqlTypeToSqlTypeNameOverrides

        public void registerSqlTypeToSqlTypeNameOverrides​(Map<Integer,​String> overrides)
        Description copied from class: SQLDialect
        Registers any overrides that should occur when mapping an integer sql type value to an underlying sql type name.

        The default implementation of this method does nothing. Subclasses should override in cases where:

        • database type metadata does not provide enough information to properly map
        • to support custom types (those not in Types)
        Overrides:
        registerSqlTypeToSqlTypeNameOverrides in class SQLDialect
      • postCreateAttribute

        public void postCreateAttribute​(AttributeDescriptor att,
                                        String tableName,
                                        String schemaName,
                                        Connection cx)
                                 throws SQLException
        Description copied from class: SQLDialect
        Callback which executes after an attribute descriptor has been built from a table column.

        The result set columnMetadata should not be modified in any way (including scrolling) , it should only be read from.

        This base implementation does nothing, subclasses should override as need be.

        Overrides:
        postCreateAttribute in class SQLDialect
        Parameters:
        att - The built attribute descriptor.
        tableName - The name of the table containing the column
        schemaName - The name of the database scheam containing the table containing the column
        cx - The database connection.
        Throws:
        SQLException
      • getGeometryMetadataTable

        public String getGeometryMetadataTable()
        The geometry metadata table in use, if any
      • setGeometryMetadataTable

        public void setGeometryMetadataTable​(String geometryMetadataTable)
        Sets the geometry metadata table
      • setMetadataBboxEnabled

        public void setMetadataBboxEnabled​(boolean metadataBboxEnabled)
        Sets the decision if the table MDSYS.USER_SDO_GEOM_METADATA can be used for index calculation
      • splitFilter

        public Filter[] splitFilter​(Filter filter,
                                    SimpleFeatureType schema)
        Description copied from class: SQLDialect
        Splits the filter into two parts, an encodable one, and a non encodable one. The default implementation uses the filter capabilities to split the filter, subclasses can implement their own logic if need be.
        Overrides:
        splitFilter in class SQLDialect
      • getDefaultVarcharSize

        public int getDefaultVarcharSize()
        Description copied from class: SQLDialect
        Determines the default length that a varchar field should be when creating datastore tables from feature types.

        Some dialects allow no length to be specified for varchar fields (PostGIS for example) however others require a maximum length to be set.

        Subclasses can override this method and either return -1 to specify that no length is required, or otherwise return an appropriate default length for varchars of that dialect.

        Overrides:
        getDefaultVarcharSize in class SQLDialect