public abstract class DataModelAdqlExample extends java.lang.Object implements AdqlExample
Modifier | Constructor and Description |
---|---|
protected |
DataModelAdqlExample(java.lang.String name,
java.lang.String description,
java.lang.String infoUrl,
java.lang.String[] textLines)
Constructor.
|
Modifier and Type | Method and Description |
---|---|
static DataModelAdqlExample[] |
createObsTapExamples()
Returns a list of examples applicable for the ObsCore data model.
|
static DataModelAdqlExample[] |
createRegTapExamples()
Returns a list of examples applicable for the RegTAP data model.
|
java.lang.String |
getDescription()
Returns this example's description.
|
java.net.URL |
getInfoUrl()
Returns a documentation URL associated with this example if available.
|
java.lang.String |
getName()
Returns this example's name.
|
java.lang.String |
getText(boolean lineBreaks,
java.lang.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.
|
abstract boolean |
isDataModel(java.lang.String dm)
Indicates whether a given data model string is the one to which
this example corresponds.
|
protected DataModelAdqlExample(java.lang.String name, java.lang.String description, java.lang.String infoUrl, java.lang.String[] textLines)
name
- example namedescription
- example short descriptioninfoUrl
- URL for explanationtextLines
- lines of ADQL textpublic abstract boolean isDataModel(java.lang.String dm)
dataModel
attribute, available from
TapCapability.getDataModels()
.dm
- data model identifierpublic java.lang.String getName()
AdqlExample
getName
in interface AdqlExample
public java.lang.String getDescription()
AdqlExample
getDescription
in interface AdqlExample
public java.net.URL getInfoUrl()
AdqlExample
getInfoUrl
in interface AdqlExample
public java.lang.String getText(boolean lineBreaks, java.lang.String lang, TapCapability tcap, TableMeta[] tables, TableMeta table)
AdqlExample
getText
in interface AdqlExample
lineBreaks
- whether output ADQL should include multiline
formattinglang
- ADQL language variant (e.g. "ADQL-2.0")tcap
- TAP capability objecttables
- table metadata settable
- currently selected tablepublic static DataModelAdqlExample[] createRegTapExamples()
public static DataModelAdqlExample[] createObsTapExamples()
Copyright © 2017 Central Laboratory of the Research Councils. All Rights Reserved.