<acr-module description=" Reusable UI Dialogues"
name=" dialogs"
>
-
<component description="AR Service: Dialogue that prompts the user to select a registry resource<dl> <dt>See:</dt><dd> #selectResourcesFromList(String, boolean, URI[]) Example 1, #selectResourcesXQueryFilter(String, boolean, String) Example 2, Registry, </dd></dl>"
interface-class="org.astrogrid.acr.dialogs.RegistryGoogle"
name="registryGoogle"
>
-
<method description="Display the resource chooser dialogue, populated with resources described by a SRQL query - the little language used in VOExplorer SmartLists.<dl> <dt>See:</dt><dd> <a href='http://eurovotech.org/twiki/bin/view/VOTech/SimpleRegistryQueryLanguage'>SRQL Language Description</a>, </dd></dl>"
name="selectResources"
>
-
<return description="0 or more selected resources, never null."
type="org.astrogrid.acr.ivoa.resource.Resource[]"
uitype="Resource[]"
/>
-
<param description="the prompt to show the user"
name="prompt"
type="java.lang.String"
uitype="String"
/>
-
<param description="if true, allow multiple selections"
name="multiple"
type="boolean"
uitype="boolean"
/>
-
<param description="The query used to populate the dialogue."
name="srql"
type="java.lang.String"
uitype="String"
/>
</method>
-
<method description="<b>Deprecated: </b>unimplemented<p /> display the resource chooser dialogue, enabling only resources which match a filter."
excluded="true"
name="selectResourcesAdqlFilter"
>
-
<return description="0 or more selected resources. never null."
type="org.astrogrid.acr.ivoa.resource.Resource[]"
uitype="Resource[]"
/>
-
<param description="message to prompt user for input."
name="prompt"
type="java.lang.String"
uitype="String"
/>
-
<param description="if true, allow multiple selections."
name="multiple"
type="boolean"
uitype="boolean"
/>
-
<param description="adql-like 'where' clause."
name="adqlFilter"
type="java.lang.String"
uitype="String"
/>
</method>
-
<method description="Display the resource chooser dialogue, populated with resources from an xquery. <pre><b>Example: </b> "Python Example" # connect to the AR from xmlrpc import Server from os.path import expanduser ar = Server(file(expanduser('~/.astrogrid-desktop')).next().strip() +'xmlrpc') #call this function xquery = """ for $r in //vor:Resource[not (@status='inactive' or @status='deleted')] where $r/@xsi:type &= '*DataCollection' return $r """ rs = ar.dialogs.registryGoogle.selectResourcesXQueryFilter("Choose a DataCollection",True,xquery) #list the selected identifiers for r in rs: print r['id'] </pre>"
name="selectResourcesXQueryFilter"
>
-
<return description="0 or more selected resources. never null."
type="org.astrogrid.acr.ivoa.resource.Resource[]"
uitype="Resource[]"
/>
-
<param description="message to prompt user for input."
name="prompt"
type="java.lang.String"
uitype="String"
/>
-
<param description="if true, allow multiple selections."
name="multiple"
type="boolean"
uitype="boolean"
/>
-
<param description="a xquery to populate the resource chooser with. Same format as in an xquery list in voexplorer UI - which is convenient for constructing these queries."
name="xqueryFilter"
type="java.lang.String"
uitype="String"
/>
</method>
-
<method description="Display the resource chooser dialogue, populated with a list of resources. <pre><b>Example: </b> "Python Example" # connect to the AR from xmlrpc import Server from os.path import expanduser ar = Server(file(expanduser('~/.astrogrid-desktop')).next().strip() +'xmlrpc') #call this function ids = ['ivo://irsa.ipac/2MASS-PSC' ,'ivo://mast.stsci/siap-cutout/goods.hst' ,'ivo://stecf.euro-vo/SSA/HST/FOS' ,'ivo://uk.ac.cam.ast/iphas-dsa-catalog/IDR' ,'ivo://uk.ac.cam.ast/IPHAS/images/SIAP' ] rs = ar.dialogs.registryGoogle.selectResourcesFromList("Choose a DataCollection",True,ids) #list the selected identifiers for r in rs: print r['id'] </pre>"
name="selectResourcesFromList"
>
-
<return description="0 or more selected resources. never null."
type="org.astrogrid.acr.ivoa.resource.Resource[]"
uitype="Resource[]"
/>
-
<param description="message to prompt user for input"
name="prompt"
type="java.lang.String"
uitype="String"
/>
-
<param description="if true, allow multiple selections."
name="multiple"
type="boolean"
uitype="boolean"
/>
-
<param description="an array of resource identifiers that will be retrieved from registry and displayed in the dialogue."
name="identifiers"
type="java.net.URI[]"
uitype="URI[]"
/>
</method>
</component>
-
<component description="AR Service: Dialogue that prompts the user to select a local file, vospace resource or URL. <p /> This is a generalisation of the typical filechooser dialogue that allows local and remote ( myspace / vospace / URL) resources to be selected.<dl> <dt>See:</dt><dd> org.astrogrid.acr.astrogrid.Myspace, </dd></dl>"
interface-class="org.astrogrid.acr.dialogs.ResourceChooser"
name="resourceChooser"
>
-
<method description="Prompt the user to select a file. Blocks until a file is selected, or user presses cancel.<dl> <dt>Equivalent To:</dt><dd><tt> fullChooseResource(title,enableRemote,true,enableRemote)</tt></dd></dl>"
name="chooseResource"
>
-
<return description="URI of the selected resource, or null if the user pressed cancel"
type="java.net.URI"
uitype="URI"
/>
-
<param description="title for the dialogue - e.g.<tt>choose file to open</tt>"
name="title"
type="java.lang.String"
uitype="String"
/>
-
<param description="- if true,allow selection of a remote resource (myspace / vospace / URL). Selection of local resources is enabled always."
name="enableRemote"
type="boolean"
uitype="boolean"
/>
</method>
-
<method description="Prompt the user to select a folder. Blocks until a folder is selected, or user presses cancel.<dl> <dt>Equivalent To:</dt><dd><tt> fullChooseFolder(title,enableRemote,true,enableRemote)</tt></dd></dl>"
name="chooseFolder"
>
-
<return description="URI of the selected folder, or null if the user pressed cancel."
type="java.net.URI"
uitype="URI"
/>
-
<param description="title for the dialogue - e.g.<tt>choose file to open</tt>"
name="title"
type="java.lang.String"
uitype="String"
/>
-
<param description="- if true,allow selection of a remote resource (myspace / vospace / URL). Selection of local resources is enabled always."
name="enableRemote"
type="boolean"
uitype="boolean"
/>
</method>
-
<method description="Fully-configurable resource chooser - a generalization of <tt>chooseResource</tt>."
name="fullChooseResource"
>
-
<return description="the URI of the selected resource, or null if the user cancelled"
type="java.net.URI"
uitype="URI"
/>
-
<param description="title for the dialogue"
name="title"
type="java.lang.String"
uitype="String"
/>
-
<param description="if true,allow selection of a remote myspace / vospace resource."
name="enableVospace"
type="boolean"
uitype="boolean"
/>
-
<param description="if true, allow selection of local files"
name="enableLocal"
type="boolean"
uitype="boolean"
/>
-
<param description="if true, enable the 'enter a URL' tab, so an arbitrary URL can be entered."
name="enableURL"
type="boolean"
uitype="boolean"
/>
</method>
-
<method description="Fully-configurable resource chooser - a generalization of <tt>chooseFolder</tt>."
name="fullChooseFolder"
>
-
<return description="the URI of the selected folder, or null if the user cancelled"
type="java.net.URI"
uitype="URI"
/>
-
<param description="title for the dialogue"
name="title"
type="java.lang.String"
uitype="String"
/>
-
<param description="if true,allow selection of a remote myspace / vospace folder"
name="enableVospace"
type="boolean"
uitype="boolean"
/>
-
<param description="if true, allow selection of local folders"
name="enableLocal"
type="boolean"
uitype="boolean"
/>
-
<param description="if true, enable the 'enter a URL' tab, so an arbitrary URL can be entered. <blockquote><b>Warning: </b>No verification that an entered URL <i>is</i> a folder is performed.</blockquote>"
name="enableURL"
type="boolean"
uitype="boolean"
/>
</method>
</component>
-
<component description="AR Service: Dialogue that allows user to select a remote application or database and fill in invocation parameters. The output of the dialogue is a <i>Tool Document</i>, suitable for passing to the <tt>Applications</tt> service for execution.<dl> <dt>See:</dt><dd> org.astrogrid.acr.astrogrid.Applications, </dd></dl>"
interface-class="org.astrogrid.acr.dialogs.ToolEditor"
name="toolEditor"
>
-
<method description="Prompt the user to edit a tool document.<dl> <dt>XMLRPC:</dt><dd> takes a xml document string as a parameter, and returns another xml document string</dd></dl>"
name="edit"
>
-
<return description="an edited copy of this document, or null if the user pressed cancel."
type="org.w3c.dom.Document"
uitype="XML"
/>
-
<param description="document conforming to Tool schema"
name="t"
type="org.w3c.dom.Document"
uitype="XML"
/>
</method>
-
<method description="Prompt the user to edit a tool document."
name="editStored"
>
-
<return description="edited copy of this document, or null if the user pressed cancel."
type="org.w3c.dom.Document"
uitype="XML"
/>
-
<param description="location the tool document is stored at (http://, ftp://, ivo://)"
name="documentLocation"
type="java.net.URI"
uitype="URI"
/>
</method>
-
<method description="prompt the user to select a remote application or database and construct an invocation/query against it."
name="selectAndBuild"
>
-
<return description="a new tool document"
type="org.w3c.dom.Document"
uitype="XML"
/>
</method>
</component>
</acr-module>
|