uk.ac.starlink.vo

Class TapTableLoadDialog

java.lang.Object

uk.ac.starlink.table.gui.AbstractTableLoadDialog

uk.ac.starlink.vo.TapTableLoadDialog

All Implemented Interfaces:

TableLoadDialog, DalLoader

public class TapTableLoadDialog
extends AbstractTableLoadDialog
implements DalLoader

Load dialogue for TAP services.

Since:

18 Jan 2011

Author:

Mark Taylor

See Also:

IVOA TAP Recommendation

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TapTableLoadDialog.TapRunMode Enum for TAP run modes.

Constructor Summary

Constructors

Constructor and Description
TapTableLoadDialog() Constructor.

Method Summary

Modifier and Type	Method and Description
boolean	acceptResourceIdList(String[] ivoids, String msg) Takes a list of resource ID values and may load them or a subset into this object's dialogue as appropriate.
void	addQueryActionListener(ActionListener l) Adds a listener that will be informed if the effective TAP query specified by this dialogue may have changed.
void	addRunningQuery(UwsJob tapJob) Adds a running TAP query to the list of queries this dialogue is currently aware of.
void	configure(StarTableFactory tfact, Action submitAct) Provides some configuration which must be performed before use.
protected Component	createQueryComponent() Constructs the query component used by this dialogue.
protected TapTableLoadDialog.TapRunMode[]	createRunModes() Returns the run modes provided by this dialogue.
TableLoader	createTableLoader() Returns a new object which specifies how table loading is to be performed.
protected TableSequence	createTableSequence(StarTableFactory tfact, UwsJob tapJob, DescribedValue[] tapMeta) Returns a table sequence constructed from a given TAP query.
protected TapQueryPanel	createTapQueryPanel() Creates a new TapQueryPanel.
Action	getAuthenticateAction() Returns an action that can log in/out to the currently displayed TAP service.
ContentCoding	getContentCoding() Returns the HTTP content coding policy used for TAP queries and some metadata requests.
TapQueryPanel	getCurrentTapQueryPanel() Returns the TAP query panel currently visible.
TapServiceFinderPanel	getFinderPanel() Returns the finder panel for this window.
RegistryPanel	getRegistryPanel() Returns the registry panel for this window.
Action	getReloadAction() Returns a panel-specific reload action.
TapTableLoadDialog.TapRunMode	getRunMode() Returns the currently selected run mode.
TapService	getTapService() Returns the currently selected TAP service.
static Set<String>	getUploadLabels(String adql) Returns a set of table identifers which are required for upload.
protected StarTable	getUploadTable(String upLabel) Returns a table named by an upload specifier in an ADQL query.
java.util.function.Consumer<URL>	getUrlHandler() Returns a callback invoked when the user clicks on a displayed URL.
VOTableWriter	getVOTableWriter() Returns the VOTableWriter used for uploading table used by this dialog.
boolean	isReady() Indicates whether the submit action should be enabled.
static void	main(String[] args) Main method pops up an instance of this dialog.
void	removeQueryActionListener(ActionListener l) Removes a listener for TAP query changes.
void	setContentCoding(ContentCoding coding) Sets the HTTP content coding policy to use for TAP queries and some metadata requests.
void	setMetaPolicy(TapMetaPolicy metaPolicy) Sets the policy used for TAP service metadata acquisition.
void	setPreferredOutputFormat(String ofmtName) Sets the preferred format in which the service is to provide the table output.
void	setServiceFinder(TapServiceFinder finder) Sets the object that can locate TAP services by table metadata.
void	setUrlHandler(java.util.function.Consumer<URL> urlHandler) Sets a callback invoked when the user clicks on a displayed URL.
void	setVOTableWriter(VOTableWriter vowriter) Sets the VOTableWriter used to serialise tables for upload to the TAP service when upload queries are performed.

Methods inherited from class uk.ac.starlink.table.gui.AbstractTableLoadDialog

addToolbarAction, asIOException, createFormatSelector, getDescription, getIcon, getMenus, getName, getQueryComponent, getSelectedFormat, getSubmitAction, getToolbarActions, isAvailable, isComponentShowing, setIcon, setIconUrl, setMenus, setToolbarActions, submit, updateReady

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface uk.ac.starlink.vo.DalLoader

getMenus, setMenus

Constructor Detail

TapTableLoadDialog

public TapTableLoadDialog()

Constructor.

Method Detail

getUrlHandler

public java.util.function.Consumer<URL> getUrlHandler()

Returns a callback invoked when the user clicks on a displayed URL.

Returns:

url click handler

setUrlHandler

public void setUrlHandler(java.util.function.Consumer<URL> urlHandler)

Sets a callback invoked when the user clicks on a displayed URL.

Parameters:

urlHandler - url click handler

configure

public void configure(StarTableFactory tfact,
                      Action submitAct)

Description copied from interface: TableLoadDialog

Provides some configuration which must be performed before use. This method should be called before TableLoadDialog.getQueryComponent() is called.

The tfact argument provides a table factory which resembles the one to be used for generating tables. Although this factory should not in general be used or retained, since the one presented later to the TableLoader should be used instead, it can be interrogated for known table formats etc.

The submitAct argument sets the action which when invoked will cause TableLoadDialog.createTableLoader() to be called. Its setEnabled method can be called to reflect readiness, and it can be added as a listener to dialogue-specific events which indicate that a selection has been made.

Specified by:

configure in interface TableLoadDialog

Overrides:

configure in class AbstractTableLoadDialog

Parameters:

tfact - representative table factory

submitAct - action for load submission

createQueryComponent

protected Component createQueryComponent()

Description copied from class: AbstractTableLoadDialog

Constructs the query component used by this dialogue. Called only once (lazily).

Specified by:

createQueryComponent in class AbstractTableLoadDialog

Returns:

query component

getUploadTable

protected StarTable getUploadTable(String upLabel)

Returns a table named by an upload specifier in an ADQL query. The TapTableLoadDialog implementation of this throws an exception, but subclasses may override this if they are capable of providing uploadable tables. If no table named by the given label is available, it is good practice to throw an IllegalArgumentException with an informative message, though returning null is also acceptable.

Parameters:

upLabel - name part of an uploaded table specification, that is the part following the "TAP_UPLOAD." part

Returns:

table named by upLabel

createTableLoader

public TableLoader createTableLoader()

Description copied from interface: TableLoadDialog

Returns a new object which specifies how table loading is to be performed. The actions performed by the returned object will presumably be determined by the state at call time of this dialogues GUI component.

If the dialogue is not in a suitable state, either return null, or, if you want to provide more detailed information about what's wrong, throw a RuntimeException with an informative message.

Specified by:

createTableLoader in interface TableLoadDialog

Returns:

new table loader object

addRunningQuery

public void addRunningQuery(UwsJob tapJob)

Adds a running TAP query to the list of queries this dialogue is currently aware of.

Parameters:

tapJob - UWS job representing TAP query

setMetaPolicy

public void setMetaPolicy(TapMetaPolicy metaPolicy)

Sets the policy used for TAP service metadata acquisition. As currently implemented, a change in policy triggers a reload of the metadata for the currently displayed service metadata, though not for other cached ones.

Parameters:

metaPolicy - new metadata acquisition policy

setPreferredOutputFormat

public void setPreferredOutputFormat(String ofmtName)

Sets the preferred format in which the service is to provide the table output. This had better represent some form of VOTable. The supplied name may be a MIME type, an alias, or an ivo-id as described in sec 2.4 of TAPRegExt v1.0. If the supplied name is null, or if no output format has been declared by the service corresponding to the supplied name, then the service's default output format will be used.

Parameters:

ofmtName - output format MIME type, alias or ivo-id

setServiceFinder

public void setServiceFinder(TapServiceFinder finder)

Sets the object that can locate TAP services by table metadata. Invoking this with a new finder instance initiates an asynchronous search for TAP services.

Parameters:

finder - new finder

setVOTableWriter

public void setVOTableWriter(VOTableWriter vowriter)

Sets the VOTableWriter used to serialise tables for upload to the TAP service when upload queries are performed.

Parameters:

vowriter - new votable serializer

getVOTableWriter

public VOTableWriter getVOTableWriter()

Returns the VOTableWriter used for uploading table used by this dialog.

Returns:

table upload writer

setContentCoding

public void setContentCoding(ContentCoding coding)

Sets the HTTP content coding policy to use for TAP queries and some metadata requests. Subsequent communications will use this setting.

Parameters:

coding - configures HTTP compression

getContentCoding

public ContentCoding getContentCoding()

Returns the HTTP content coding policy used for TAP queries and some metadata requests.

Returns:

current HTTP compression configuration

getReloadAction

public Action getReloadAction()

Returns a panel-specific reload action. When enabled, this performs some kind of update action relevant to the currently visible tab.

Returns:

reload action

getAuthenticateAction

public Action getAuthenticateAction()

Returns an action that can log in/out to the currently displayed TAP service.

Returns:

authentication action

acceptResourceIdList

public boolean acceptResourceIdList(String[] ivoids,
                                    String msg)

Description copied from interface: DalLoader

Takes a list of resource ID values and may load them or a subset into this object's dialogue as appropriate.

Specified by:

acceptResourceIdList in interface DalLoader

Parameters:

ivoids - ivo:-type identifier strings

msg - text of user-directed message to explain where the IDs came from

Returns:

true iff at least some of the resources were, or may be, loaded into this window

getTapService

public TapService getTapService()

Returns the currently selected TAP service.

Returns:

TAP service description, or null

createRunModes

protected TapTableLoadDialog.TapRunMode[] createRunModes()

Returns the run modes provided by this dialogue.

Returns:

run mode options

addQueryActionListener

public void addQueryActionListener(ActionListener l)

Adds a listener that will be informed if the effective TAP query specified by this dialogue may have changed.

Parameters:

l - listener to add

removeQueryActionListener

public void removeQueryActionListener(ActionListener l)

Removes a listener for TAP query changes.

Parameters:

l - listener to remove

createTableSequence

protected TableSequence createTableSequence(StarTableFactory tfact,
                                            UwsJob tapJob,
                                            DescribedValue[] tapMeta)
                                     throws IOException

Returns a table sequence constructed from a given TAP query. This method marks each TapQuery for deletion on JVM shutdown. Subclass implementations may override this method to perform different job deletion behaviour.

Parameters:

tfact - table factory

tapJob - UWS job representing async TAP query

tapMeta - metadata describing the query suitable for decorating the resulting table

Returns:

table sequence suitable for a successful return from this dialog's TableLoader

Throws:

IOException

createTapQueryPanel

protected TapQueryPanel createTapQueryPanel()

Creates a new TapQueryPanel. This is called when a new TAP service is selected. The default implementation constructs one with a basic set of examples, but it can be overridden for more specialised behaviour.

Returns:

new query panel

isReady

public boolean isReady()

Description copied from class: AbstractTableLoadDialog

Indicates whether the submit action should be enabled. The implementation should return true if the user should be allowed to submit the query, or false if the internal state of this dialogue is known to be incomplete in some way. Evaluation should be fast; the return does not need to provide a guarantee that a submitted query will suceed.

The default implementation returns true.

Overrides:

isReady in class AbstractTableLoadDialog

Returns:

false iff dialogue state is known to be incomplete

getCurrentTapQueryPanel

public TapQueryPanel getCurrentTapQueryPanel()

Returns the TAP query panel currently visible.

Returns:

query panel

getRunMode

public TapTableLoadDialog.TapRunMode getRunMode()

Returns the currently selected run mode.

Returns:

run mode

getRegistryPanel

public RegistryPanel getRegistryPanel()

Returns the registry panel for this window.

Specified by:

getRegistryPanel in interface DalLoader

Returns:

registry panel

getFinderPanel

public TapServiceFinderPanel getFinderPanel()

Returns the finder panel for this window.

Returns:

finder panel

getUploadLabels

public static Set<String> getUploadLabels(String adql)

Returns a set of table identifers which are required for upload. This is the set of any [identifier]s in the query of the form TAP_UPLOAD.[identifier].

Parameters:

adql - ADQL/S text

Returns:

collection of upload identifiers

main

public static void main(String[] args)

Main method pops up an instance of this dialog. An initial TAP URL may be given on the command line.