Package org.apache.sis.referencing.factory.sql

Class TableInfo

java.lang.Object

org.apache.sis.referencing.factory.sql.TableInfo

final class TableInfo
extends Object

Information about a specific table. The MS-Access dialect of SQL is assumed; it will be translated into ANSI SQL later by SQLTranslator.apply(String) if needed.

Since:

0.7

Version:

1.0

Field Summary

Fields

Modifier and Type	Field	Description
(package private) final String	codeColumn	Column name for the code (usually with the "_CODE" suffix).
(package private) static final TableInfo	CRS	The EPSG item used for coordinate reference systems.
(package private) static final TableInfo	DATUM	The EPSG item used for datums.
(package private) static final TableInfo	ELLIPSOID	The EPSG item used for ellipsoids.
(package private) static final String	ENUM_REPLACEMENT	The SQL type to use as a replacement for enumerated values on databases that do not support enumerations.
(package private) static final TableInfo[]	EPSG	List of tables and columns to test for codes values.
(package private) final String	nameColumn	Column name for the name (usually with the "_NAME" suffix), or null.
(package private) final String	showColumn	The column that specify if the object should be shown, or null if none.
private final Class<?>[]	subTypes	Sub-interfaces of type to handle, or null if none.
(package private) final String	table	The table name for SQL queries.
(package private) final Class<?>	type	The class of object to be created.
private final String	typeColumn	Column type for the type (usually with the "_TYPE" suffix), or null.
private final String[]	typeNames	Names of subTypes in the database, or null if none.

Constructor Summary

Constructors

Modifier	Constructor	Description
private	TableInfo(Class<?> type, String table, String codeColumn, String nameColumn, String typeColumn, Class<?>[] subTypes, String[] typeNames, String showColumn)	Stores information about a specific table.

Method Summary

Modifier and Type	Method	Description
(package private) static boolean	tableMatches(String expected, String name)	Returns true if the given table name matches the expected name.
(package private) final String	unquoted()	Returns the table name without brackets.
(package private) final Class<?>	where(Class<?> userType, StringBuilder buffer)	Appends a WHERE clause together with a condition for searching the most specific subtype, if such condition can be added.

Methods inherited from class java.lang.Object

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

Field Details

CRS

static final TableInfo CRS

The EPSG item used for coordinate reference systems.

DATUM

static final TableInfo DATUM

The EPSG item used for datums.

ELLIPSOID

static final TableInfo ELLIPSOID

The EPSG item used for ellipsoids.

EPSG

static final TableInfo[] EPSG

List of tables and columns to test for codes values. Those tables are used by the EPSGDataAccess.createObject(String) method in order to detect which of the following methods should be invoked for a given code: EPSGDataAccess.createCoordinateReferenceSystem(String) EPSGDataAccess.createCoordinateSystem(String) EPSGDataAccess.createDatum(String) EPSGDataAccess.createEllipsoid(String) EPSGDataAccess.createUnit(String) The order is significant: it is the key for a switch statement.

type

final Class<?> type

The class of object to be created.

table

final String table

The table name for SQL queries. May contains a "JOIN" clause.

See Also:

• unquoted()

codeColumn

final String codeColumn

Column name for the code (usually with the "_CODE" suffix).

nameColumn

final String nameColumn

Column name for the name (usually with the "_NAME" suffix), or null.

typeColumn

private final String typeColumn

Column type for the type (usually with the "_TYPE" suffix), or null. EPSGDataAccess and AuthorityCodes assumes that values in this column have the maximal length described in the "VARCHAR(80)" statement.

ENUM_REPLACEMENT

static final String ENUM_REPLACEMENT

The SQL type to use as a replacement for enumerated values on databases that do not support enumerations.

See Also:

• Constant Field Values

subTypes

private final Class<?>[] subTypes

Sub-interfaces of type to handle, or null if none.

typeNames

private final String[] typeNames

Names of subTypes in the database, or null if none.

showColumn

final String showColumn

The column that specify if the object should be shown, or null if none.

Constructor Details

TableInfo

private TableInfo(Class<?> type,
 String table,
 String codeColumn,
 String nameColumn,
 String typeColumn,
 Class<?>[] subTypes,
 String[] typeNames,
 String showColumn)

Stores information about a specific table.

Method Details

unquoted

final String unquoted()

Returns the table name without brackets.

tableMatches

static boolean tableMatches(String expected,
 String name)

Returns true if the given table name matches the expected name. The given name may be prefixed by "epsg_" and may contain abbreviations of the full name. For example, "epsg_coordoperation" is considered as a match for "Coordinate_Operation".

The table name should be one of the values enumerated in the epsg_table_name type of the EPSG_Prepare.sql file.

Parameters:

expected - the expected table name (e.g. "Coordinate_Operation").

name - the actual table name.

Returns:

whether the given name is considered to match the expected name.

where

final Class<?> where(Class<?> userType,
 StringBuilder buffer)

Appends a WHERE clause together with a condition for searching the most specific subtype, if such condition can be added. The clause appended by this method looks like the following example (details may vary because of enumeration values): In any case, the caller shall add at least one condition after this method call.

Parameters:

userType - the type specified by the user.

buffer - where to append the WHERE clause.

Returns:

the subtype, or type if no subtype was found.