|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectuk.ac.starlink.vo.AbstractAdqlExample
public abstract class AbstractAdqlExample
Represents a type of example ADQL query. The query text can be generated as a function of given service metadata.
Nested Class Summary | |
---|---|
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. |
Constructor Summary | |
---|---|
protected |
AbstractAdqlExample(String name,
String description)
Constructor. |
Method Summary | |
---|---|
static String |
citeColumnName(String colName)
Fixes a colum name so it's suitable for insersion into ADQL. |
static String |
citeTableName(String tname)
Fixes a table name so it's suitable for insertion into ADQL. |
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[] |
createSomeExamples()
Returns a selection of examples. |
String |
getDescription()
Returns this example's description. |
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. |
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.AdqlExample |
---|
getText |
Constructor Detail |
---|
protected AbstractAdqlExample(String name, String description)
name
- example namedescription
- example short descriptionMethod Detail |
---|
public String getName()
AdqlExample
getName
in interface AdqlExample
public String getDescription()
AdqlExample
getDescription
in interface AdqlExample
public static AbstractAdqlExample.Breaker createBreaker(boolean lineBreaks)
lineBreaks
- whether line breaks are required
public static String citeTableName(String tname)
tname
- raw table name, may include delimiters (schema.table etc)
public static String citeColumnName(String colName)
colName
- raw column name, may not include delimiters
public static TableMeta[] toTables(TableMeta table, TableMeta[] tables)
table
- single input table, or nulltables
- input table array
public static AbstractAdqlExample.TableWithCols[] getRaDecTables(TableMeta[] tables, int max)
tables
- candidate table listmax
- the maximum number of output tables required
public static AdqlExample createDummyExample()
public static AdqlExample[] createSomeExamples()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |