/*
 * Copyright (c) 2008, PostgreSQL Global Development Group
 * See the LICENSE file in the project root for more information.
 */

package org.postgresql.core;

import org.postgresql.util.PGobject;

import java.sql.SQLException;
import java.util.Iterator;

public interface TypeInfo {
  void addCoreType(String pgTypeName, Integer oid, Integer sqlType, String javaClass,
      Integer arrayOid);

  void addDataType(String type, Class<? extends PGobject> klass) throws SQLException;

  
Look up the SQL typecode for a given type oid.
Params:
oid – the type's OID
Throws:
SQLException – if an error occurs when retrieving sql type
Returns:
the SQL type code (a constant from Types) for the type/**
   * Look up the SQL typecode for a given type oid.
   *
   * @param oid the type's OID
   * @return the SQL type code (a constant from {@link java.sql.Types}) for the type
   * @throws SQLException if an error occurs when retrieving sql type
   */
  int getSQLType(int oid) throws SQLException;

  
Look up the SQL typecode for a given postgresql type name.
Params:
pgTypeName – the server type name to look up
Throws:
SQLException – if an error occurs when retrieving sql type
Returns:
the SQL type code (a constant from Types) for the type/**
   * Look up the SQL typecode for a given postgresql type name.
   *
   * @param pgTypeName the server type name to look up
   * @return the SQL type code (a constant from {@link java.sql.Types}) for the type
   * @throws SQLException if an error occurs when retrieving sql type
   */
  int getSQLType(String pgTypeName) throws SQLException;

  
Look up the oid for a given postgresql type name. This is the inverse of getPGType(int). 
Params:
pgTypeName – the server type name to look up
Throws:
SQLException – if an error occurs when retrieving PG type
Returns:
the type's OID, or 0 if unknown/**
   * Look up the oid for a given postgresql type name. This is the inverse of
   * {@link #getPGType(int)}.
   *
   * @param pgTypeName the server type name to look up
   * @return the type's OID, or 0 if unknown
   * @throws SQLException if an error occurs when retrieving PG type
   */
  int getPGType(String pgTypeName) throws SQLException;

  
Look up the postgresql type name for a given oid. This is the inverse of getPGType(String). 
Params:
oid – the type's OID
Throws:
SQLException – if an error occurs when retrieving PG type
Returns:
the server type name for that OID or null if unknown/**
   * Look up the postgresql type name for a given oid. This is the inverse of
   * {@link #getPGType(String)}.
   *
   * @param oid the type's OID
   * @return the server type name for that OID or null if unknown
   * @throws SQLException if an error occurs when retrieving PG type
   */
  String getPGType(int oid) throws SQLException;

  
Look up the oid of an array's base type given the array's type oid.
Params:
oid – the array type's OID
Throws:
SQLException – if an error occurs when retrieving array element
Returns:
the base type's OID, or 0 if unknown/**
   * Look up the oid of an array's base type given the array's type oid.
   *
   * @param oid the array type's OID
   * @return the base type's OID, or 0 if unknown
   * @throws SQLException if an error occurs when retrieving array element
   */
  int getPGArrayElement(int oid) throws SQLException;

  
Determine the oid of the given base postgresql type's array type.
Params:
elementTypeName – the base type's
Throws:
SQLException – if an error occurs when retrieving array type
Returns:
the array type's OID, or 0 if unknown/**
   * Determine the oid of the given base postgresql type's array type.
   *
   * @param elementTypeName the base type's
   * @return the array type's OID, or 0 if unknown
   * @throws SQLException if an error occurs when retrieving array type
   */
  int getPGArrayType(String elementTypeName) throws SQLException;

  
Determine the delimiter for the elements of the given array type oid.
Params:
oid – the array type's OID
Throws:
SQLException – if an error occurs when retrieving array delimiter
Returns:
the base type's array type delimiter/**
   * Determine the delimiter for the elements of the given array type oid.
   *
   * @param oid the array type's OID
   * @return the base type's array type delimiter
   * @throws SQLException if an error occurs when retrieving array delimiter
   */
  char getArrayDelimiter(int oid) throws SQLException;

  Iterator<String> getPGTypeNamesWithSQLTypes();

  Class<? extends PGobject> getPGobject(String type);

  String getJavaClass(int oid) throws SQLException;

  String getTypeForAlias(String alias);

  int getPrecision(int oid, int typmod);

  int getScale(int oid, int typmod);

  boolean isCaseSensitive(int oid);

  boolean isSigned(int oid);

  int getDisplaySize(int oid, int typmod);

  int getMaximumPrecision(int oid);

  boolean requiresQuoting(int oid) throws SQLException;

  
Returns true if particular sqlType requires quoting.
This method is used internally by the driver, so it might disappear without notice.
Params:
sqlType – sql type as in java.sql.Types
Throws:
SQLException – if something goes wrong
Returns:
true if the type requires quoting/**
   * Returns true if particular sqlType requires quoting.
   * This method is used internally by the driver, so it might disappear without notice.
   *
   * @param sqlType sql type as in java.sql.Types
   * @return true if the type requires quoting
   * @throws SQLException if something goes wrong
   */
  boolean requiresQuotingSqlType(int sqlType) throws SQLException;
}