Package org.apache.sis.internal.metadata.sql

Class Syntax

java.lang.Object

org.apache.sis.internal.metadata.sql.Syntax

Direct Known Subclasses:

Database, SQLBuilder

public class Syntax
extends Object

Information about the syntax to use for building SQL statements. This object extract from DatabaseMetaData the information needed by SQLBuilder. It can be cached if many SQLBuilder instances are going to be created.

Since:

1.1

Version:

1.1

Field Summary

Fields

Modifier and Type	Field	Description
final Dialect	dialect	The database dialect.
(package private) final String	escape	The string that can be used to escape wildcard characters.
(package private) final String	quote	The characters used for quoting identifiers, or an empty string if none.
(package private) final boolean	quoteSchema	Whether the schema name should be written between quotes.

Constructor Summary

Constructors

Constructor	Description
Syntax(DatabaseMetaData metadata, boolean quoteSchema)	Creates a new Syntax initialized from the given database metadata.
Syntax(Syntax other)	Creates a new Syntax initialized to the same metadata than the given template.

Method Summary

Methods inherited from class java.lang.Object

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

Field Details

dialect

public final Dialect dialect

The database dialect. This is used for a few database-dependent syntax.

quote

final String quote

The characters used for quoting identifiers, or an empty string if none. This is the value returned by DatabaseMetaData.getIdentifierQuoteString().

quoteSchema

final boolean quoteSchema

Whether the schema name should be written between quotes. If false, we will let the database engine uses its default lower case / upper case policy.

See Also:

• SQLBuilder.appendIdentifier(String, String)

escape

final String escape

The string that can be used to escape wildcard characters. This is the value returned by DatabaseMetaData.getSearchStringEscape().

Constructor Details

Syntax

public Syntax(DatabaseMetaData metadata,
 boolean quoteSchema)
       throws SQLException

Creates a new Syntax initialized from the given database metadata.

Parameters:

metadata - the database metadata.

quoteSchema - whether the schema name should be written between quotes.

Throws:

SQLException - if an error occurred while fetching the database metadata.

Syntax

Syntax(Syntax other)

Creates a new Syntax initialized to the same metadata than the given template.

Parameters:

other - the template from which to copy metadata.