Class TapTableLoadDialog

Method Details

• getUrlHandler

  public Consumer<URL> getUrlHandler()

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

  Returns:

  url click handler

• setUrlHandler

  public void setUrlHandler(Consumer<URL> urlHandler)

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

  Parameters:

  urlHandler - url click handler

• configure

  public void configure(uk.ac.starlink.table.StarTableFactory tfact, Action submitAct)

  Specified by:

  configure in interface uk.ac.starlink.table.gui.TableLoadDialog

  Overrides:

  configure in class uk.ac.starlink.table.gui.AbstractTableLoadDialog

• createQueryComponent

  protected Component createQueryComponent()

  Specified by:

  createQueryComponent in class uk.ac.starlink.table.gui.AbstractTableLoadDialog

• getUploadTable

  protected uk.ac.starlink.table.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 uk.ac.starlink.table.gui.TableLoader createTableLoader()

  Specified by:

  createTableLoader in interface uk.ac.starlink.table.gui.TableLoadDialog

• 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(uk.ac.starlink.votable.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 uk.ac.starlink.votable.VOTableWriter getVOTableWriter()

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

  Returns:

  table upload writer

• setContentCoding

  public void setContentCoding(uk.ac.starlink.util.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 uk.ac.starlink.util.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 uk.ac.starlink.table.TableSequence createTableSequence(uk.ac.starlink.table.StarTableFactory tfact, UwsJob tapJob, uk.ac.starlink.table.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()

  Overrides:

  isReady in class uk.ac.starlink.table.gui.AbstractTableLoadDialog

• 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.