LibreOffice
LibreOffice 6.2 SDK API Reference
Public Member Functions | List of all members
XColumn Interface Referencepublished

is used to access data which is collected in a row. More...

import"XColumn.idl";

Inheritance diagram for XColumn:
XInterface DataColumn

Public Member Functions

boolean wasNull () raises (com::sun::star::sdbc::SQLException)
 reports whether the last column read had a value of SQL NULL. More...
 
string getString () raises (com::sun::star::sdbc::SQLException)
 gets the value of a column in the current row as a String. More...
 
boolean getBoolean () raises (com::sun::star::sdbc::SQLException)
 gets the value of a column in the current row as boolean. More...
 
byte getByte () raises (com::sun::star::sdbc::SQLException)
 gets the value of a column in the current row as a byte. More...
 
short getShort () raises (com::sun::star::sdbc::SQLException)
 gets the value of a column in the current row as a short. More...
 
long getInt () raises (com::sun::star::sdbc::SQLException)
 gets the value of a column in the current row as a long. More...
 
hyper getLong () raises (com::sun::star::sdbc::SQLException)
 gets the value of a column in the current row as a hyper. More...
 
float getFloat () raises (com::sun::star::sdbc::SQLException)
 gets the value of a column in the current row as a float. More...
 
double getDouble () raises (com::sun::star::sdbc::SQLException)
 gets the value of a column in the current row as a double. More...
 
sequence< byte > getBytes () raises (com::sun::star::sdbc::SQLException)
 gets the value of a column in the current row as a byte array. More...
 
com::sun::star::util::Date getDate () raises (com::sun::star::sdbc::SQLException)
 gets the value of a column in the current row as a date object. More...
 
com::sun::star::util::Time getTime () raises (com::sun::star::sdbc::SQLException)
 gets the value of a column in the current row as a time object. More...
 
com::sun::star::util::DateTime getTimestamp () raises (com::sun::star::sdbc::SQLException)
 gets the value of a column in the current row as a datetime object. More...
 
com::sun::star::io::XInputStream getBinaryStream () raises (com::sun::star::sdbc::SQLException)
 gets the value of a column in the current row as a stream of uninterpreted bytes. More...
 
com::sun::star::io::XInputStream getCharacterStream () raises (com::sun::star::sdbc::SQLException)
 gets the value of a column in the current row as a stream of uninterpreted bytes. More...
 
any getObject ([in]com::sun::star::container::XNameAccess typeMap) raises (com::sun::star::sdbc::SQLException)
 
com::sun::star::sdbc::XRef getRef () raises (com::sun::star::sdbc::SQLException)
 gets a REF(<structured-type&gt) column value from the current row. More...
 
com::sun::star::sdbc::XBlob getBlob () raises (com::sun::star::sdbc::SQLException)
 gets a BLOB (Binary Large OBject) value in the current row. More...
 
com::sun::star::sdbc::XClob getClob () raises (com::sun::star::sdbc::SQLException)
 gets a CLOB value in the current row of this ResultSet object. More...
 
com::sun::star::sdbc::XArray getArray () raises (com::sun::star::sdbc::SQLException)
 gets a SQL ARRAY value from the current row. More...
 
- Public Member Functions inherited from XInterface
any queryInterface ([in] type aType)
 queries for a new interface to an existing UNO object. More...
 
void acquire ()
 increases the reference counter by one. More...
 
void release ()
 decreases the reference counter by one. More...
 

Detailed Description

is used to access data which is collected in a row.

Member Function Documentation

gets a SQL ARRAY value from the current row.

Returns
the column value
Exceptions
com::sun::star::sdbc::SQLExceptionif a database access error occurs.

gets the value of a column in the current row as a stream of uninterpreted bytes.

The value can then be read in chunks from the stream. This method is particularly suitable for retrieving large LONGVARBINARY or LONGVARCHAR values.

Note: All the data in the returned stream must be read prior to getting the value of any other column. The next call to a get method implicitly closes the stream. Also, a stream may return 0 when the method com::sun::star::io::XInputStream::available() is called whether there is data available or not.

Returns
the column value
Exceptions
com::sun::star::sdbc::SQLExceptionif a database access error occurs.

gets a BLOB (Binary Large OBject) value in the current row.

Returns
the column value
Exceptions
com::sun::star::sdbc::SQLExceptionif a database access error occurs.
boolean getBoolean ( )
raises (com::sun::star::sdbc::SQLException
)

gets the value of a column in the current row as boolean.

Returns
the column value
Exceptions
com::sun::star::sdbc::SQLExceptionif a database access error occurs.
byte getByte ( )
raises (com::sun::star::sdbc::SQLException
)

gets the value of a column in the current row as a byte.

Returns
the column value
Exceptions
com::sun::star::sdbc::SQLExceptionif a database access error occurs.
sequence<byte> getBytes ( )
raises (com::sun::star::sdbc::SQLException
)

gets the value of a column in the current row as a byte array.

The bytes represent the raw values returned by the driver.

Returns
the column value; if the value is SQL NULL, the result is empty.
Exceptions
com::sun::star::sdbc::SQLExceptionif a database access error occurs.

gets the value of a column in the current row as a stream of uninterpreted bytes.

The value can then be read in chunks from the stream. This method is particularly suitable for retrieving large LONGVARCHAR values.

Note: All the data in the returned stream must be read prior to getting the value of any other column. The next call to a get method implicitly closes the stream. Also, a stream may return 0 when the method com::sun::star::io::XInputStream::available() is called whether there is data available or not.

Returns
the column value
Exceptions
com::sun::star::sdbc::SQLExceptionif a database access error occurs.

gets a CLOB value in the current row of this ResultSet object.

Returns
the column value
Exceptions
com::sun::star::sdbc::SQLExceptionif a database access error occurs.

gets the value of a column in the current row as a date object.

Returns
the column value
Exceptions
com::sun::star::sdbc::SQLExceptionif a database access error occurs.
double getDouble ( )
raises (com::sun::star::sdbc::SQLException
)

gets the value of a column in the current row as a double.

Returns
the column value
Exceptions
com::sun::star::sdbc::SQLExceptionif a database access error occurs.
float getFloat ( )
raises (com::sun::star::sdbc::SQLException
)

gets the value of a column in the current row as a float.

Returns
the column value
Exceptions
com::sun::star::sdbc::SQLExceptionif a database access error occurs.
long getInt ( )
raises (com::sun::star::sdbc::SQLException
)

gets the value of a column in the current row as a long.

Returns
the column value
Exceptions
com::sun::star::sdbc::SQLExceptionif a database access error occurs.
hyper getLong ( )
raises (com::sun::star::sdbc::SQLException
)

gets the value of a column in the current row as a hyper.

Returns
the column value
Exceptions
com::sun::star::sdbc::SQLExceptionif a database access error occurs.
Returns
the value of a column in the current row as an object. This method uses the given Map object for the custom mapping of the SQL structure or distinct type that is being retrieved.
Parameters
typeMapthe type map is used to fetch the correct type
Returns
the column value
Exceptions
com::sun::star::sdbc::SQLExceptionif a database access error occurs.

gets a REF(<structured-type&gt) column value from the current row.

Returns
the column value
Exceptions
com::sun::star::sdbc::SQLExceptionif a database access error occurs.
short getShort ( )
raises (com::sun::star::sdbc::SQLException
)

gets the value of a column in the current row as a short.

Returns
the column value
Exceptions
com::sun::star::sdbc::SQLExceptionif a database access error occurs.
string getString ( )
raises (com::sun::star::sdbc::SQLException
)

gets the value of a column in the current row as a String.

Returns
the column value
Exceptions
com::sun::star::sdbc::SQLExceptionif a database access error occurs.

gets the value of a column in the current row as a time object.

Returns
the column value
Exceptions
com::sun::star::sdbc::SQLExceptionif a database access error occurs.

gets the value of a column in the current row as a datetime object.

Returns
the column value
Exceptions
com::sun::star::sdbc::SQLExceptionif a database access error occurs.
boolean wasNull ( )
raises (com::sun::star::sdbc::SQLException
)

reports whether the last column read had a value of SQL NULL.

Note that you must first call getXXX on a column to try to read its value and then call wasNull() to see if the value read was SQL NULL.

Returns
TRUE if so
Exceptions
com::sun::star::sdbc::SQLExceptionif a database access error occurs.

The documentation for this interface was generated from the following file: