vortex.sql
Class vortexMetaResult

java.lang.Object
  extended by vortex.sql.vortexMetaResult
All Implemented Interfaces:
java.sql.ResultSetMetaData, java.sql.Wrapper

public class vortexMetaResult
extends java.lang.Object
implements java.sql.ResultSetMetaData

An object that can be used to get information about the types and properties of the columns in a ResultSet object.

See Also:
ResultSetMetaData

Field Summary
 
Fields inherited from interface java.sql.ResultSetMetaData
columnNoNulls, columnNullable, columnNullableUnknown
 
Method Summary
 java.lang.String getCatalogName(int column)
          Not supported by VORTEXjdbc.
 java.lang.String getColumnClassName(int column)
          Not supported by VORTEXjdbc.
 int getColumnCount()
          Returns the number of columns in this result set.
 int getColumnDisplaySize(int column)
          Gives the display size for this column.
 java.lang.String getColumnLabel(int column)
          This returns column_name.
 java.lang.String getColumnName(int column)
          The name of the requested column.
 int getColumnType(int column)
          Gives the column type using the types in java.sql.Types.
 java.lang.String getColumnTypeName(int column)
          Gives the column type as a string.
 int getPrecision(int column)
          Returning the precision
 int getScale(int column)
          Returning the scale
 java.lang.String getSchemaName(int column)
          Not supported by VORTEXjdbc.
 java.lang.String getTableName(int column)
          Not supported by VORTEXjdbc.
 boolean isAutoIncrement(int column)
          Is the column automatically numbered, thus read-only?
 boolean isCaseSensitive(int column)
          Does a column's case matter?
 boolean isCurrency(int column)
          Is the column a cash value?
 boolean isDefinitelyWritable(int column)
          Will a write on the column definitely succeed?
 int isNullable(int column)
          Determines if the column in question is nullable.
 boolean isReadOnly(int column)
          Is a column definitely not writable?
 boolean isSearchable(int column)
          Can the column be used in a where clause?
 boolean isSigned(int column)
          Since all VORTEXjdbc integer types are signed, this returns true.
 boolean isWrapperFor(java.lang.Class<?> ResultSetMetaData)
           
 boolean isWritable(int column)
          Is it possible for a write on the column to succeed?
<T> T
unwrap(java.lang.Class<T> ResultSetMetaData)
           
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

isWrapperFor

public boolean isWrapperFor(java.lang.Class<?> ResultSetMetaData)
                     throws java.sql.SQLException
Specified by:
isWrapperFor in interface java.sql.Wrapper
Throws:
java.sql.SQLException

unwrap

public <T> T unwrap(java.lang.Class<T> ResultSetMetaData)
         throws java.sql.SQLException
Specified by:
unwrap in interface java.sql.Wrapper
Throws:
java.sql.SQLException

getColumnCount

public int getColumnCount()
                   throws java.sql.SQLException
Returns the number of columns in this result set.

Specified by:
getColumnCount in interface java.sql.ResultSetMetaData
Returns:
number of columns
Throws:
java.sql.SQLException - do nothing
See Also:
ResultSetMetaData.getColumnCount()

isAutoIncrement

public boolean isAutoIncrement(int column)
                        throws java.sql.SQLException
Is the column automatically numbered, thus read-only?

Specified by:
isAutoIncrement in interface java.sql.ResultSetMetaData
Parameters:
column - the column index
Returns:
false
Throws:
java.sql.SQLException - thrown if the column is out of range
See Also:
ResultSetMetaData.isAutoIncrement(int)

isCaseSensitive

public boolean isCaseSensitive(int column)
                        throws java.sql.SQLException
Does a column's case matter?

Specified by:
isCaseSensitive in interface java.sql.ResultSetMetaData
Parameters:
column - the column index
Returns:
true, meaning is case sensitive
Throws:
java.sql.SQLException - thrown if the column is out of range
See Also:
ResultSetMetaData.isCaseSensitive(int)

isSearchable

public boolean isSearchable(int column)
                     throws java.sql.SQLException
Can the column be used in a where clause?

Specified by:
isSearchable in interface java.sql.ResultSetMetaData
Parameters:
column - the column index
Returns:
true
Throws:
java.sql.SQLException - thrown if the column is out of range
See Also:
ResultSetMetaData.isSearchable(int)

isCurrency

public boolean isCurrency(int column)
                   throws java.sql.SQLException
Is the column a cash value?

Specified by:
isCurrency in interface java.sql.ResultSetMetaData
Parameters:
column - the column index
Returns:
false
Throws:
java.sql.SQLException - thrown if the column is out of range
See Also:
ResultSetMetaData.isCurrency(int)

isNullable

public int isNullable(int column)
               throws java.sql.SQLException
Determines if the column in question is nullable.

Specified by:
isNullable in interface java.sql.ResultSetMetaData
Parameters:
column - the column index
Returns:
columnNullable if the column can accept null values, otherwise columnNoNulls
Throws:
java.sql.SQLException - thrown if the column is out of range
See Also:
ResultSetMetaData.isNullable(int)

isSigned

public boolean isSigned(int column)
                 throws java.sql.SQLException
Since all VORTEXjdbc integer types are signed, this returns true.

Specified by:
isSigned in interface java.sql.ResultSetMetaData
Parameters:
column - the column index
Returns:
true
Throws:
java.sql.SQLException - thrown if the column is out of range
See Also:
ResultSetMetaData.isSigned(int)

getColumnDisplaySize

public int getColumnDisplaySize(int column)
                         throws java.sql.SQLException
Gives the display size for this column.

Specified by:
getColumnDisplaySize in interface java.sql.ResultSetMetaData
Parameters:
column - the column index
Returns:
the length of display size
Throws:
java.sql.SQLException - thrown if the column is out of range
See Also:
ResultSetMetaData.getColumnDisplaySize(int)

getColumnLabel

public java.lang.String getColumnLabel(int column)
                                throws java.sql.SQLException
This returns column_name.

Specified by:
getColumnLabel in interface java.sql.ResultSetMetaData
Parameters:
column - the column index
Returns:
the display value for the field
Throws:
java.sql.SQLException - thrown if the column is out of range
See Also:
ResultSetMetaData.getColumnLabel(int)

getColumnName

public java.lang.String getColumnName(int column)
                               throws java.sql.SQLException
The name of the requested column.

Specified by:
getColumnName in interface java.sql.ResultSetMetaData
Parameters:
column - the column index
Returns:
the name of the requested column
Throws:
java.sql.SQLException - thrown when the column desired is bad
See Also:
ResultSetMetaData.getColumnName(int)

getSchemaName

public java.lang.String getSchemaName(int column)
                               throws java.sql.SQLException
Not supported by VORTEXjdbc.

Specified by:
getSchemaName in interface java.sql.ResultSetMetaData
Parameters:
column - the column index
Returns:
the schema name of the requested column
Throws:
java.sql.SQLException - thrown if the column is out of range

getPrecision

public int getPrecision(int column)
                 throws java.sql.SQLException
Returning the precision

Specified by:
getPrecision in interface java.sql.ResultSetMetaData
Parameters:
column - the column of the field this information is needed for
Returns:
the precision of the column
Throws:
java.sql.SQLException - thrown if the column is out of range

getScale

public int getScale(int column)
             throws java.sql.SQLException
Returning the scale

Specified by:
getScale in interface java.sql.ResultSetMetaData
Parameters:
column - the column of the field this information is needed for
Returns:
the scale of the column
Throws:
java.sql.SQLException - thrown if the column is out of range

getTableName

public java.lang.String getTableName(int column)
                              throws java.sql.SQLException
Not supported by VORTEXjdbc. Gives the name of the table to which this column belongs.

Specified by:
getTableName in interface java.sql.ResultSetMetaData
Parameters:
column - the column index
Returns:
the table name or "" if not applicable
Throws:
java.sql.SQLException - thrown if the column is out of range
See Also:
ResultSetMetaData.getTableName(int)

getCatalogName

public java.lang.String getCatalogName(int column)
                                throws java.sql.SQLException
Not supported by VORTEXjdbc.

Specified by:
getCatalogName in interface java.sql.ResultSetMetaData
Parameters:
column - the column index
Returns:
the catalog name
Throws:
java.sql.SQLException - thrown if the column is out of range

getColumnType

public int getColumnType(int column)
                  throws java.sql.SQLException
Gives the column type using the types in java.sql.Types.

Specified by:
getColumnType in interface java.sql.ResultSetMetaData
Parameters:
column - the column index
Returns:
the type as listed in java.sql.Types
Throws:
java.sql.SQLException - thrown if the column is out of range
See Also:
Types, ResultSetMetaData.getColumnType(int)

getColumnTypeName

public java.lang.String getColumnTypeName(int column)
                                   throws java.sql.SQLException
Gives the column type as a string.

Specified by:
getColumnTypeName in interface java.sql.ResultSetMetaData
Parameters:
column - the column index
Returns:
the name of the column type
Throws:
java.sql.SQLException - thrown if column out of range
See Also:
ResultSetMetaData.getColumnTypeName(int)

getColumnClassName

public java.lang.String getColumnClassName(int column)
                                    throws java.sql.SQLException
Not supported by VORTEXjdbc. Returns the fully-qualified name of the Java class whose instances are manufactured if the method ResultSet.getObject is called to retrieve a value from the column. ResultSet.getObject may return a subclass of the class returned by this method.

Specified by:
getColumnClassName in interface java.sql.ResultSetMetaData
Parameters:
column - the column index
Returns:
the fully-qualified name
Throws:
java.sql.SQLException - thrown if the column is out of range

isReadOnly

public boolean isReadOnly(int column)
                   throws java.sql.SQLException
Is a column definitely not writable?

Specified by:
isReadOnly in interface java.sql.ResultSetMetaData
Parameters:
column - the column index
Returns:
true is not writeable, otherwise false
Throws:
java.sql.SQLException - thrown if the column is out of range

isWritable

public boolean isWritable(int column)
                   throws java.sql.SQLException
Is it possible for a write on the column to succeed?

Specified by:
isWritable in interface java.sql.ResultSetMetaData
Parameters:
column - the column index
Returns:
true if writeable, otherwise false
Throws:
java.sql.SQLException - thrown if the column is out of range

isDefinitelyWritable

public boolean isDefinitelyWritable(int column)
                             throws java.sql.SQLException
Will a write on the column definitely succeed?

Specified by:
isDefinitelyWritable in interface java.sql.ResultSetMetaData
Parameters:
column - the column index
Returns:
true if writeable, otherwise
Throws:
java.sql.SQLException - thrown if the column is out of range


Updated May 06 2016