AdqlExample
public abstract class AbstractAdqlExample extends java.lang.Object implements AdqlExample
Modifier and Type | Class | Description |
---|---|---|
static class |
AbstractAdqlExample.Breaker |
Interface for configurable line breaking.
|
static class |
AbstractAdqlExample.TableWithCols |
Encapsulates metadata for a table and a selection of colum names from it.
|
Modifier | Constructor | Description |
---|---|---|
protected |
AbstractAdqlExample(java.lang.String name,
java.lang.String description) |
Constructor.
|
Modifier and Type | Method | Description |
---|---|---|
static AbstractAdqlExample.Breaker |
createBreaker(boolean lineBreaks) |
Returns a breaker instance suitable for a given line break policy.
|
static AdqlExample |
createDummyExample() |
Returns a dummy example which never provides any text.
|
static AdqlExample |
createSimpleExample(java.lang.String name,
java.lang.String description,
java.lang.String[] textLines) |
Creates a static example.
|
static AdqlExample[] |
createSomeExamples() |
Returns a selection of examples.
|
static AdqlExample[] |
createTapSchemaExamples() |
Returns a selection of examples using the TAP_SCHEMA tables.
|
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.
|
static AbstractAdqlExample.TableWithCols[] |
getRaDecTables(TableMeta[] tables,
int max) |
Identifies tables in a given array which contain RA/Dec positional
columns.
|
static TableMeta[] |
toTables(TableMeta table,
TableMeta[] tables) |
Utility function to turn a single table and a table array into a
single array.
|
getText
protected AbstractAdqlExample(java.lang.String name, java.lang.String description)
name
- example namedescription
- example short descriptionpublic 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 static AbstractAdqlExample.Breaker createBreaker(boolean lineBreaks)
lineBreaks
- whether line breaks are requiredpublic static TableMeta[] toTables(TableMeta table, TableMeta[] tables)
table
- single input table, or nulltables
- input table arraypublic static AbstractAdqlExample.TableWithCols[] getRaDecTables(TableMeta[] tables, int max)
tables
- candidate table listmax
- the maximum number of output tables requiredpublic static AdqlExample createDummyExample()
public static AdqlExample[] createSomeExamples()
public static AdqlExample[] createTapSchemaExamples()
public static AdqlExample createSimpleExample(java.lang.String name, java.lang.String description, java.lang.String[] textLines)
name
- example namedescription
- example short descriptiontextLines
- lines of ADQL textCopyright © 2018 Central Laboratory of the Research Councils. All Rights Reserved.