uk.ac.starlink.vo
Interface AdqlExample

All Known Implementing Classes:
AbstractAdqlExample

public interface AdqlExample

Represents a type of example ADQL query. The query text can be generated as a function of given service metadata.

Since:
29 Mar 2011
Author:
Mark Taylor

Method Summary
 String getDescription()
          Returns this example's description.
 String getName()
          Returns this example's name.
 String getText(boolean lineBreaks, String lang, TapCapability tcap, TableMeta[] tables, TableMeta table)
          Produces ADQL text for a query of the type represented by this object, for a given set of service details.
 

Method Detail

getText

String getText(boolean lineBreaks,
               String lang,
               TapCapability tcap,
               TableMeta[] tables,
               TableMeta table)
Produces ADQL text for a query of the type represented by this object, for a given set of service details.

Parameters:
lineBreaks - whether output ADQL should include multiline formatting
lang - ADQL language variant (e.g. "ADQL-2.0")
tcap - TAP capability object
tables - table metadata set
table - currently selected table

getName

String getName()
Returns this example's name.

Returns:
name

getDescription

String getDescription()
Returns this example's description.

Returns:
short description


Copyright © 2015 Central Laboratory of the Research Councils. All Rights Reserved.