Language:

The Free and Open Productivity Suite
Apache OpenOffice 4.1.4 released

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous


:: com :: sun :: star :: sdb :: tools ::

interface XTableName
Description
allows to manipulate table names.

When, in a database application, dealing with table names, there's many degrees of freedom to deal with. For instance, suppose you want to have the full name of a table object, as it should be used in a SELECT statement's FROM part. This requires you to evaluate whether or not the table has a catalog and/or schema name, to combine the catalog, the schema, and the basic table name into one name, respecting the database's quoting character, and the order in which all those parts should be combined. Additionally, you have to respect the client-side settings which tell OpenOffice.org to use or not use catalogs and schemas in SELECT at all.

The XTableName interface eases this and other, similar tasks around table names.

The component itself does not have life-time control mechanimns, i.e. you cannot explicitly dispose it (::com::sun::star::lang::XComponent::dispose), and you cannot be notified when it dies.
However, if your try to access any of its methods or attributes, after the connection which was used to create it was closed, a ::com::sun::star::lang::DisposedException will be thrown.

Since
OOo 2.0.4
See also
XConnectionTools, ::com::sun::star::sdbc::XDatabaseMetaData, ::com::sun::star::sdb::DataSource::Settings

Methods' Summary
getComposedName returns the composed table name, including the catalog and schema name, respecting the databases's quoting requirements, plus  
setComposedName sets a new composed table name  
Attributes' Summary
CatalogName denotes the name of the catalog which the table is a part of  
SchemaName denotes the name of the schema which the table is a part of  
TableName denotes the mere, unqualified table name, excluding any catalog and schema.  
NameForSelect represents the table name in a form to be used in a SELECT statement.  
Table is the ::com::sun::star::sdb::Table object specified by the current name.  
Methods' Details
getComposedName
string
getComposedName( [in] long  Type,
[in] boolean  Quote )
raises( ::com::sun::star::lang::IllegalArgumentException );

Description
returns the composed table name, including the catalog and schema name, respecting the databases's quoting requirements, plus
Parameter Type
the type of name composition to be used.
Parameter Quote
specifies whether the single parts of the table name should be quoted
Throws
com::sun::star::IllegalArgumentException if the given Type does not denote a valid CompositionType
See also
CompositionType
setComposedName
void
setComposedName( [in] string  ComposedName,
[in] long  Type );

Description
sets a new composed table name
Parameter ComposedName
specifies the composed table name
Parameter Type
specifies the composition type which was used to create the composed table name
Attributes' Details
CatalogName
string CatalogName;
Description
denotes the name of the catalog which the table is a part of
SchemaName
string SchemaName;
Description
denotes the name of the schema which the table is a part of
TableName
string TableName;
Description
denotes the mere, unqualified table name, excluding any catalog and schema.
NameForSelect
[ readonly ] string NameForSelect;
Description
represents the table name in a form to be used in a SELECT statement.

On a per-data-source basis, OpenOffice.org allows to override database meta data information in that you can specify to not use catalog and or schema names in SELECT statements. Using this attribute, you can generate a table name which respects those settings.

See also
::com::sun::star::sdb::DataSource::Settings
Table
::com::sun::star::beans::XPropertySet Table
get raises (::com::sun::star::container::NoSuchElementException)
set raises (::com::sun::star::lang::IllegalArgumentException);

Description
is the ::com::sun::star::sdb::Table object specified by the current name.

Retrieving this attribute is equivalent to obtaining the tables container from the connection (via ::com::sun::star::sdbcx::XTablesSupplier), and calling its ::com::sun::star::container::XNameAccess::getByName method with the ComposedName.

Throws
com::sun::star::container::NoSuchElementException if, upon getting the attribute value, the current composed table name represented by this instance does not denote an existing table in the database.
Throws
com::sun::star::lang::IllegalArgumentException if you try to set an object which does not denote a table from the underlying database.
Top of Page

Apache Software Foundation

Copyright & License | Privacy | Contact Us | Donate | Thanks

Apache and the Apache feather logo are trademarks of The Apache Software Foundation. OpenOffice, OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.