<html> <head> <title>Service QueryDesign</title> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <link rel="stylesheet" type="text/css" href="../../../../idl.css"> </head> <body> <div id="adc-idlref"> <a name="_top_"> </a><table class="navimain" border="0" cellpadding="3"> <tr> <td class="navimain"><a href="../module-ix.html" class="navimain">Overview</a></td> <td class="navimain"><a href="module-ix.html" class="navimain">Module</a></td> <td class="navimain"><a href="QueryDesign-xref.html" class="navimain">Use</a></td> <td class="navimainnone">Devguide</td> <td class="navimain"><a href="../../../../index-files/index-1.html" class="navimain">Index</a></td> </tr> </table> <table class="navisub" border="0" cellpadding="0"> <tr> <td class="navisub">Included Services</td> <td class="navisub"><a href="#ExportedInterfaces" class="navisub">Exported Interfaces</a></td> <td class="navisub"><a href="#PropertiesSummary" class="navisub">Properties' Summary</a></td> <td class="navisub"><a href="#PropertiesDetails" class="navisub">Properties' Details</a></td> </tr> </table> <hr> <table border="0" width="100%" cellpadding="5" cellspacing="3" class="title-table" style="margin-bottom:6pt;"> <tr> <td><p class="namechain"><a href="../../../../module-ix.html" class="namechain">::</a> <a href="../../../module-ix.html" class="namechain">com</a> :: <a href="../../module-ix.html" class="namechain">sun</a> :: <a href="../module-ix.html" class="namechain">star</a> :: <a href="module-ix.html" class="namechain">sdb</a> :: </p> </td> </tr> <tr> <td class="title">service QueryDesign</td> </tr> <tr> <td><dl> <dt><b>Description</b></dt> <dd>implements a component which allows the creation of SQL statements. </dd> <dd><p>This service implements a user interface for creating SQL statements either through a graphical design interface or simply to enter the SQL statement directly.</p> <p>The design view of the QueryDesign is divided into two parts. The first part contains the table windows where columns can be selected for the SQL statement. The second part contains the columns which should appear in the selection of the SQL statement or criterias which narrow the query.</p> <h3>Operation Modes</h3> <p>A <code>QueryDesign</code> component has 3 operation modes, which control what kind of object is edited: <ul><li><a name="query_mode"></a><b>Query Mode</b> <p>In <code>Query Mode</code>, the designer is used to modify an existing or create a new client-side query.</p></li> <li><a name="view_mode"</a><b>View Mode</b> <p>In <code>View Mode</code>, the designer is used to modify an existing or create a new server-side view.</p> <p>The view which is being designed must support the ::com::sun::star::<a href="../sdbcx/module-ix.html">sdbcx</a>::<a href="../sdbcx/XAlterView.html">XAlterView</a> interface, except when a new view is being designed. In the latter case, the designer closes itself automatically when <code>XAlterView</code> is not supported, and the view has been saved.</p></li> <li><a name="command_mode"</a><b>Command Mode</b> <p>In <code>Command Mode</code>, the designer is used to design an standalone SQL command.</p> <p>The client of the designer is then responsible to listen at changes in the <a href="QueryDesign.html#ActiveCommand">ActiveCommand</a> and <a href="QueryDesign.html#EscapeProcessing">EscapeProcessing</a> members, which are updated every time the user saves the command.</p></li> </ul></p> <h3><a name="initialization"></a>Initialization</h3> <p>Initialization is done using the ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/XInitialization.html">XInitialization</a> interface, which expects a sequence of objects being either ::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/NamedValue.html">NamedValue</a>s or ::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/PropertyValue.html">PropertyValue</a>s. The following parameters are supported at initialization time: <ul> <li><b>Frame</b><br/> has to be an ::com::sun::star::<a href="../frame/module-ix.html">frame</a>::<a href="../frame/XFrame.html">XFrame</a> interface specifying the frame to plug the QueryDesign component into.<br/> This parameter is mandatory. </li> <li><a name="data_source"></a><b>DataSourceName</b><br/> specifies the name of the globally registered <a href="DataSource.html">DataSource</a> for which a query, view, or SQL command is to be designed.<br/> The DataSourceName may be omitted if and only if a valid <a href="#active_connection">ActiveConnection</a> parameter is present.<br/> If both <code>DataSourceName</code> and <code>ActiveConnection</code> are present, the former is ignored. </li> <li><a name="active_connection"></a><b>ActiveConnection</b><br/> specifies the connection to work with.<br/> May be ommitted if and only if a valid <a href="#data_source">DataSourceName</a> parameter is supplied. </li> <li><a name="command"></a><b>Command</b><br/> specifies the name of the query or view to design, or, in case of the <a href="#command_type">CommandType</a> being <a href="CommandType.html">CommandType</a>::<a href="CommandType.html#COMMAND">COMMAND</a>, the initial SQL command.<br/> If this parameter is not present, a new query/view will be designed, respectively the initial command will be empty. </li> <li><a name="command_type"></a><b>CommandType</b><br/> specifies the type of object which should be designed. The following options are supported: <ul><li><a href="CommandType.html">CommandType</a>::<a href="CommandType.html#QUERY">QUERY</a> specifies the designer should operate in <a href="#query_mode">query mode</a>, that is, an existing client-side query should be designed, or a new query should be created, depending on the presence of the <a href="#command">Command</a> parameter.<br/> If the <a href="#data_source">DataSourceName</a> parameter is present, the query is looked up in the specified data source. Otherwise, the designer tries to determine the data source which the <a href="#active_connection">ActiveConnection</a> belongs to, and looks up the query there.</li> <li><a href="CommandType.html">CommandType</a>::<a href="CommandType.html#COMMAND">COMMAND</a> specifies the designer should operate in <a href="#command_mode">command mode</a>, that is, a standalone SQL command should be designed. When the user attempts to save the designed SQL statement, the <a href="QueryDesign.html#ActiveCommand">ActiveCommand</a> and <a href="QueryDesign.html#EscapeProcessing">EscapeProcessing</a> properties of the designer are updated.</li> <li><a href="CommandType.html">CommandType</a>::<a href="CommandType.html#TABLE">TABLE</a> specifies the designer should operate in <a href="#view_mode">view mode</a>, that is, an existing or a new server-side view should be designed, depending on the presence of the <a href="#command">Command</a> parameter.<br/> If the <a href="#data_source">DataSourceName</a> parameter is present, the view is looked up in a newly created connection for the specified data source. Otherwise, it is looked up in the connection given as <a href="#active_connection">ActiveConnection</a>.</li> </ul> If not present, this parameter defaults to <a href="CommandType.html">CommandType</a>::<a href="CommandType.html#QUERY">QUERY</a>. </li> <li><b>EscapeProcessing</b><br/> Specifies whether or not escape processing should be initially enabled in the query designer. If set to <b>false</b>, then the designer can operate in text view only (as opposed to the graphical view). The <a href="#graphical_design">GraphicalDesign</a> parameter will be ignored then, and assumed to be <b>false</b>.<br/> If not present, <b>true</b> is assumed for this parameter.</li> <li><a name="graphical_design"></a><b>GraphicalDesign</b><br/> This value indicates whether the designer should be opened in the graphical design view (<b>true</b>) or in the text view (<b>false</b>).<br/> If not present, <b>false</b> is assumed for this parameter. </li> </ul> </p> <p>There's a number of legacy settings which are recognized for compatibility reasons, though you're discouraged from using them: <ul> <li><b>CurrentQuery</b><br/> is the same as Command, and implies a <a href="#command_type">CommandType</a> of <a href="CommandType.html">CommandType</a>::<a href="CommandType.html#QUERY">QUERY</a></li> <li><b>QueryDesignView</b><br/> is the same as <a href="#graphical_design">GraphicalDesign</a>.</li> <li><b>IndependentSQLCommand</b><br/> is the same as Command, and implies a <a href="#command_type">CommandType</a> of <a href="CommandType.html">CommandType</a>::<a href="CommandType.html#COMMAND">COMMAND</a></li> <li><b>CreateView</b><br/> implies a <a href="#command_type">CommandType</a> of <a href="CommandType.html">CommandType</a>::<a href="CommandType.html#TABLE">TABLE</a></li> </ul> </dd> <dt><b>See also</b></dt> <dd><a href="ContentLoader.html">ContentLoader</a></dd> </dl> </td> </tr> </table> <hr> <a name="ExportedInterfaces"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Exported Interfaces</td> </tr> <tr> <td class="imsum_left">::com::sun::star::<a href="../frame/module-ix.html">frame</a>::<a href="../frame/XController.html">XController</a></td> <td class="imsum_right"><dl> <dt><b>Description</b></dt> <dd>allows the component to be plugged into frames. </dd> </dl> </td> </tr> <tr> <td class="imsum_left">::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/XInitialization.html">XInitialization</a></td> <td class="imsum_right"><dl> <dt><b>Description</b></dt> <dd>is used to initialize the QueryDesign. </dd> <dd><p>See chapter <a href="#initialization">Initialization</a> for details.</p> </dd> </dl> </td> </tr> </table> <a name="PropertiesSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Properties' Summary</td> </tr> <tr> <td class="imsum_left">[ readonly ] string<br> <a href="#ActiveCommand">ActiveCommand</a></td> <td class="imsum_right">reflects the designed SQL command at the moment it was last saved by the user. </td> </tr> <tr> <td class="imsum_left">[ readonly ] boolean<br> <a href="#EscapeProcessing">EscapeProcessing</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>specifies whether the user enabled escape processing for the statement being designed. </td> </tr> </table> <a name="PropertiesDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle">Properties' Details</td> </tr> <tr> <td class="imdetail"><a name="ActiveCommand" class="membertitle">ActiveCommand</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>[ readonly ] string <b>ActiveCommand</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>reflects the designed SQL command at the moment it was last saved by the user. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="EscapeProcessing" class="membertitle">EscapeProcessing</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>[ readonly ] boolean <b>EscapeProcessing</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>specifies whether the user enabled escape processing for the statement being designed. </dd> <dt><b/></dt> <dd/><dt><b>See also</b></dt> <dd><a href="DataAccessDescriptor.html">DataAccessDescriptor</a>::<a href="DataAccessDescriptor.html#EscapeProcessing">EscapeProcessing</a></dd> </dl> </td> </tr> </table> </td> </tr> </table> <br> <a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright © 2008 Sun Microsystems, Inc.</p> </div> <!-- id="adc-idlref" --> </body> </html>
distrib
>
Mandriva
>
2008.1
>
x86_64
>
media
>
main-testing
>
by-pkgid
>
2c50825dd66d0497b96a67f7fab2ee84
>
files
>
5011
