Package | Description |
---|---|
tap | |
tap.config | |
tap.data | |
tap.db | |
tap.formatter | |
tap.metadata | |
tap.parameters | |
tap.resource | |
tap.upload |
Modifier and Type | Method and Description |
---|---|
static int |
ServiceConnection.LimitUnit.compare(int leftLimit,
ServiceConnection.LimitUnit leftUnit,
int rightLimit,
ServiceConnection.LimitUnit rightUnit)
Compares the 2 given values (each one expressed in the given unit).
|
static int |
ServiceConnection.LimitUnit.compare(long leftLimit,
ServiceConnection.LimitUnit leftUnit,
long rightLimit,
ServiceConnection.LimitUnit rightUnit)
Compares the 2 given values (each one expressed in the given unit).
|
abstract ADQLExecutor |
TAPFactory.createADQLExecutor()
Create the object able to execute an ADQL query and to write and to format its result.
|
ADQLExecutor |
AbstractTAPFactory.createADQLExecutor()
Note:
Unless the standard implementation -
ADQLExecutor - does not fit exactly your needs,
it should not be necessary to extend this class and to extend this function (implemented here by default). |
abstract ADQLParser |
TAPFactory.createADQLParser()
Create a parser of ADQL query.
|
ADQLParser |
AbstractTAPFactory.createADQLParser()
Note:
This function should be extended if you want to customize the ADQL grammar.
|
protected QueryChecker |
AbstractTAPFactory.createQueryChecker(java.util.Collection<TAPTable> tables)
Create an object able to check the consistency between the ADQL query and the database.
|
abstract QueryChecker |
TAPFactory.createQueryChecker(TAPSchema uploadSchema)
Create an object able to check the consistency between the ADQL query and the database.
|
QueryChecker |
AbstractTAPFactory.createQueryChecker(TAPSchema uploadSchema)
This implementation gathers all tables published in this TAP service and those uploaded
by the user.
|
abstract ADQLQueryFactory |
TAPFactory.createQueryFactory()
Create a factory able to build every part of an
ADQLQuery object. |
ADQLQueryFactory |
AbstractTAPFactory.createQueryFactory()
Note:
This function should be extended if you have customized the creation of any
ADQLQuery part ; it could be the addition of one or several user defined function
or the modification of any ADQL function or clause specific to your implementation. |
abstract TAPParameters |
TAPFactory.createTAPParameters(javax.servlet.http.HttpServletRequest request)
Extract all the TAP parameters from the given HTTP request (multipart or not) and return them.
|
TAPParameters |
AbstractTAPFactory.createTAPParameters(javax.servlet.http.HttpServletRequest request)
This implementation extracts standard TAP parameters from the given request.
|
abstract TAPParameters |
TAPFactory.createTAPParameters(java.util.Map<java.lang.String,java.lang.Object> params)
Identify all TAP parameters and gather them inside a
TAPParameters object. |
TAPParameters |
AbstractTAPFactory.createTAPParameters(java.util.Map<java.lang.String,java.lang.Object> params)
This implementation extracts standard TAP parameters from the given request.
|
abstract Uploader |
TAPFactory.createUploader(DBConnection dbConn)
Create an object able to manage the creation of submitted user tables (in VOTable) into the database.
|
Uploader |
AbstractTAPFactory.createUploader(DBConnection dbConn)
This implementation just create an
Uploader instance with the given database connection. |
abstract UWSService |
TAPFactory.createUWS()
Create the object which will manage the asynchronous resource of the TAP service.
|
UWSService |
AbstractTAPFactory.createUWS()
This implementation just create a
UWSService instance. |
abstract UWSBackupManager |
TAPFactory.createUWSBackupManager(UWSService uws)
Create the object which will manage the backup and restoration of all asynchronous jobs.
|
UWSBackupManager |
AbstractTAPFactory.createUWSBackupManager(UWSService uws)
This implementation does not provided a backup manager.
|
protected void |
ADQLExecutor.dropUploadedTables()
Drop all tables uploaded by the user from the database.
|
protected TableIterator |
ADQLExecutor.executeADQL(ADQLQuery adql)
Execute in "database" the given object representation of an ADQL query.
|
abstract DBConnection |
TAPFactory.getConnection(java.lang.String jobID)
Get a free database connection.
|
protected OutputFormat |
ADQLExecutor.getFormatter()
Get the object to use in order to write the query result in the appropriate format
(either the asked one, or else VOTable).
|
void |
ADQLExecutor.initDBConnection(java.lang.String jobID)
Create the database connection required for the ADQL execution.
|
protected ADQLQuery |
ADQLExecutor.parseADQL()
Parse the ADQL query provided in the parameters by the user.
|
protected TAPExecutionReport |
ADQLExecutor.start()
Process the ADQL query.
|
boolean |
TAPSyncJob.start(javax.servlet.http.HttpServletResponse response)
Start the execution of this job in order to execute the given ADQL query.
|
TAPExecutionReport |
ADQLExecutor.start(java.lang.Thread thread,
java.lang.String jobId,
TAPParameters params,
javax.servlet.http.HttpServletResponse response)
Start the synchronous processing of the ADQL query.
|
protected void |
ADQLExecutor.writeResult(TableIterator queryResult)
Write the given query result into the appropriate format in the appropriate output
(HTTP response for a synchronous execution, otherwise a file or any output provided by UWS).
|
protected void |
ADQLExecutor.writeResult(TableIterator queryResult,
OutputFormat formatter,
java.io.OutputStream output)
Format and write the given result in the given output with the given formatter.
|
Constructor and Description |
---|
TAPJob(JobOwner owner,
TAPParameters tapParams)
Build a pending TAP job with the given parameters.
|
TAPJob(JobOwner owner,
TAPParameters tapParams,
java.lang.String requestID)
Build a pending TAP job with the given parameters.
|
TAPJob(java.lang.String jobID,
long creationTime,
JobOwner owner,
TAPParameters params,
long quote,
long startTime,
long endTime,
java.util.List<Result> results,
ErrorSummary error)
Restore a job in a state defined by the given parameters.
|
Modifier and Type | Method and Description |
---|---|
protected JDBCTranslator |
ConfigurableTAPFactory.createADQLTranslator()
Build a
JDBCTranslator instance with the given class (ConfigurableTAPFactory.translator ;
specified by the property sql_translator). |
UWSBackupManager |
ConfigurableTAPFactory.createUWSBackupManager(UWSService uws)
Build an
DefaultTAPBackupManager thanks to the backup manager parameters specified
in the TAP configuration file (the properties: backup_frequency, backup_by_user). |
static <C> java.lang.Class<? extends C> |
TAPConfiguration.fetchClass(java.lang.String value,
java.lang.String propertyName,
java.lang.Class<C> expectedType)
Fetch the class object corresponding to the class name provided between brackets in the given value.
|
DBConnection |
ConfigurableTAPFactory.getConnection(java.lang.String jobID)
Build a
JDBCConnection thanks to the database parameters specified
in the TAP configuration file (the properties: jdbc_driver_path, db_url, db_user, db_password). |
protected static java.io.File |
ConfigurableServiceConnection.getFile(java.lang.String filePath,
java.lang.String webAppRootPath,
java.lang.String propertyName)
Resolve the given file name/path.
|
static <C> boolean |
TAPConfiguration.hasConstructor(java.lang.String propValue,
java.lang.String propName,
java.lang.Class<C> expectedType,
java.lang.Class<?>[] pTypes)
Test whether the specified class has a constructor with the specified parameters.
|
static <C> C |
TAPConfiguration.newInstance(java.lang.String propValue,
java.lang.String propName,
java.lang.Class<C> expectedType)
Create an instance of the specified class.
|
static <C> C |
TAPConfiguration.newInstance(java.lang.String propValue,
java.lang.String propName,
java.lang.Class<C> expectedType,
java.lang.Class<?>[] pTypes,
java.lang.Object[] parameters)
Create an instance of the specified class.
|
static java.lang.Object[] |
TAPConfiguration.parseLimit(java.lang.String value,
java.lang.String propertyName,
boolean areBytesAllowed)
Lets parsing a limit (for output, upload, ...) with its numeric value
and its unit.
|
static java.lang.Object[] |
TAPConfiguration.parseLimit(java.lang.String value,
java.lang.String propertyName,
boolean areBytesAllowed,
boolean longValue)
Lets parsing a limit (for output, upload, ...) with its numeric value
and its unit.
|
Constructor and Description |
---|
ConfigurableServiceConnection(java.util.Properties tapConfig)
Create a TAP service description thanks to the given TAP configuration
file.
|
ConfigurableServiceConnection(java.util.Properties tapConfig,
java.lang.String webAppRootDir)
Create a TAP service description thanks to the given TAP configuration
file.
|
ConfigurableTAPFactory(ServiceConnection service,
java.util.Properties tapConfig)
Build a
TAPFactory using the given TAP service description and TAP configuration file. |
Modifier and Type | Class and Description |
---|---|
class |
DataReadException
Exception that occurs when reading a data input (can be an InputStream, a ResultSet, a SavotTable, ...).
|
Modifier and Type | Class and Description |
---|---|
class |
DBCancelledException
Exception thrown when a processing of a
DBConnection is cancelled. |
class |
DBException
This kind of exception is thrown by instances of
DBConnection
if an error occurs while a DB operation (interrogation, update, transaction management). |
Modifier and Type | Method and Description |
---|---|
protected java.lang.String |
TextFormat.getHeader(TableIterator result,
TAPExecutionReport execReport,
java.lang.Thread thread)
Get the whole header (one row whose columns are just the columns' name).
|
static uk.ac.starlink.table.ColumnInfo[] |
VOTableFormat.toColumnInfos(TableIterator result,
TAPExecutionReport execReport,
java.lang.Thread thread)
Writes fields' metadata of the given query result.
|
protected void |
HTMLFormat.writeData(TableIterator result,
DBColumn[] selectedColumns,
java.io.BufferedWriter writer,
TAPExecutionReport execReport,
java.lang.Thread thread)
Write all the data rows.
|
protected void |
SVFormat.writeData(TableIterator result,
DBColumn[] selectedColumns,
java.io.BufferedWriter writer,
TAPExecutionReport execReport,
java.lang.Thread thread)
Write all the data rows.
|
protected void |
JSONFormat.writeData(TableIterator result,
DBColumn[] selectedColumns,
org.json.JSONWriter out,
TAPExecutionReport execReport,
java.lang.Thread thread)
Write the whole data part of the JSON file.
|
protected boolean |
TextFormat.writeData(TableIterator queryResult,
LargeAsciiTable asciiTable,
TAPExecutionReport execReport,
java.lang.Thread thread)
Write all the data rows into the given
LargeAsciiTable object. |
protected void |
JSONFormat.writeFieldMeta(TAPColumn tapCol,
org.json.JSONWriter out)
Formats in JSON and writes the given
TAPColumn in the given output. |
protected void |
SVFormat.writeFieldValue(java.lang.Object value,
DBColumn column,
java.io.BufferedWriter writer)
Writes the given field value in the given Writer.
|
protected void |
JSONFormat.writeFieldValue(java.lang.Object value,
DBColumn column,
org.json.JSONWriter out)
Writes the given field value in JSON and into the given output.
|
protected DBColumn[] |
HTMLFormat.writeHeader(TableIterator result,
java.io.BufferedWriter writer,
TAPExecutionReport execReport,
java.lang.Thread thread)
Write the whole header (one row whose columns are just the columns' name).
|
protected DBColumn[] |
SVFormat.writeHeader(TableIterator result,
java.io.BufferedWriter writer,
TAPExecutionReport execReport,
java.lang.Thread thread)
Write the whole header (one row whose columns are just the columns' name).
|
protected void |
VOTableFormat.writeHeader(uk.ac.starlink.votable.VOTableVersion votVersion,
TAPExecutionReport execReport,
java.io.BufferedWriter out)
Writes the first VOTable nodes/elements preceding the data: VOTABLE, RESOURCE and 3 INFOS (QUERY_STATUS, PROVIDER, QUERY).
|
protected DBColumn[] |
JSONFormat.writeMetadata(TableIterator result,
org.json.JSONWriter out,
TAPExecutionReport execReport,
java.lang.Thread thread)
Write the whole metadata part of the JSON file.
|
void |
FITSFormat.writeResult(TableIterator result,
java.io.OutputStream output,
TAPExecutionReport execReport,
java.lang.Thread thread) |
void |
HTMLFormat.writeResult(TableIterator result,
java.io.OutputStream output,
TAPExecutionReport execReport,
java.lang.Thread thread) |
void |
OutputFormat.writeResult(TableIterator result,
java.io.OutputStream output,
TAPExecutionReport execReport,
java.lang.Thread thread)
Formats the given query result and writes it in the given output stream.
|
void |
SVFormat.writeResult(TableIterator result,
java.io.OutputStream output,
TAPExecutionReport execReport,
java.lang.Thread thread) |
void |
TextFormat.writeResult(TableIterator result,
java.io.OutputStream output,
TAPExecutionReport execReport,
java.lang.Thread thread) |
void |
VOTableFormat.writeResult(TableIterator queryResult,
java.io.OutputStream output,
TAPExecutionReport execReport,
java.lang.Thread thread) |
void |
JSONFormat.writeResult(TableIterator result,
java.io.OutputStream output,
TAPExecutionReport execReport,
java.lang.Thread thread) |
Modifier and Type | Method and Description |
---|---|
TAPForeignKey |
TAPTable.addForeignKey(java.lang.String keyId,
TAPTable targetTable,
java.util.Map<java.lang.String,java.lang.String> columns)
Build a foreign key using the ID, the target table and the given list of columns.
|
TAPForeignKey |
TAPTable.addForeignKey(java.lang.String keyId,
TAPTable targetTable,
java.util.Map<java.lang.String,java.lang.String> columns,
java.lang.String description,
java.lang.String utype)
Build a foreign key using the ID, the target table, the given list of columns, the given description and the given UType.
|
void |
TAPTable.addForeignKey(TAPForeignKey key)
Add the given foreign key to this table.
|
protected DBType |
VotType.convertVariableLengthType(DBType.DBDatatype varType,
DBType.DBDatatype fixedType)
|
protected void |
TableSetParser.goToEndTag(javax.xml.stream.XMLStreamReader reader,
java.lang.String startNode)
Skip all tags from the current position to the end of the specified node.
|
TAPMetadata |
TableSetParser.parse(java.io.File file)
Parse the XML TableSet stored in the specified file.
|
TAPMetadata |
TableSetParser.parse(java.io.InputStream input)
Parse the XML TableSet stored in the given stream.
|
protected TAPColumn |
TableSetParser.parseColumn(javax.xml.stream.XMLStreamReader reader)
Parse the XML representation of a TAP column.
|
protected DBType |
TableSetParser.parseDataType(javax.xml.stream.XMLStreamReader reader)
Parse the XML representation of a column datatype.
|
protected TableSetParser.ForeignKey |
TableSetParser.parseFKey(javax.xml.stream.XMLStreamReader reader)
Parse the XML representation of a TAP foreign key.
|
protected TAPSchema |
TableSetParser.parseSchema(javax.xml.stream.XMLStreamReader reader,
java.util.List<TableSetParser.ForeignKey> allForeignKeys)
Parse the XML representation of a TAP schema.
|
protected TAPTable |
TableSetParser.parseTable(javax.xml.stream.XMLStreamReader reader,
java.util.List<TableSetParser.ForeignKey> keys)
Parse the XML representation of a TAP table.
|
protected TAPTable |
TableSetParser.searchTable(java.lang.String tableName,
TAPMetadata meta,
java.lang.String position)
Search for the specified table in the given TAP metadata.
|
DBType |
VotType.toTAPType()
Convert this VOTable type definition into a TAPColumn type.
|
Modifier and Type | Method and Description |
---|---|
protected static DALIUpload |
DALIUpload.buildDALIUpload(java.lang.String label,
java.lang.String uri,
java.util.Map<java.lang.String,java.lang.Object> parameters,
UWSFileManager fileManager)
Build a
DALIUpload corresponding to the specified URI. |
void |
TAPParameters.check()
Check the coherence between all TAP parameters.
|
protected static DALIUpload |
DALIUpload.fetchDALIUpload(java.lang.String uploadParam,
java.util.Map<java.lang.String,java.lang.Object> parameters,
UWSFileManager fileManager)
Fetch the single upload item (a pair with the syntax: "{label},{URI}".
|
protected static void |
DALIUpload.fetchDALIUploads(java.util.ArrayList<DALIUpload> uploads,
java.util.ArrayList<java.lang.String> usedFiles,
java.lang.String uploadParam,
java.util.Map<java.lang.String,java.lang.Object> parameters,
boolean allowTAPSyntax,
UWSFileManager fileManager)
Fetch all uploads specified in the DALI/TAP "UPLOAD" parameter.
|
static java.util.List<DALIUpload> |
DALIUpload.getDALIUploads(java.util.Map<java.lang.String,java.lang.Object> requestParams,
boolean allowTAPSyntax,
UWSFileManager fileManager)
Get all uploads specified in the DALI parameter "UPLOAD" from the given request parameters.
|
protected static java.lang.String[] |
DALIUpload.parseDALIParam(java.lang.String definition)
Extract the two parts (label and URI) of the given DALI parameter, and then, check their syntax.
|
Constructor and Description |
---|
TAPParameters(javax.servlet.http.HttpServletRequest request,
ServiceConnection service)
Create a
TAPParameters instance whose the parameters must be extracted from the given HttpServletRequest . |
TAPParameters(javax.servlet.http.HttpServletRequest request,
ServiceConnection service,
java.util.Map<java.lang.String,InputParamController> controllers)
Create a
TAPParameters instance whose the parameters must be extracted from the given HttpServletRequest . |
TAPParameters(ServiceConnection service,
java.util.Map<java.lang.String,java.lang.Object> params)
Create a
TAPParameters instance whose the parameters are given in parameter. |
TAPParameters(ServiceConnection service,
java.util.Map<java.lang.String,java.lang.Object> params,
java.util.Map<java.lang.String,InputParamController> controllers)
Create a
TAPParameters instance whose the parameters are given in parameter. |
Modifier and Type | Method and Description |
---|---|
boolean |
Capabilities.executeResource(javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response) |
boolean |
Examples.executeResource(javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response) |
boolean |
Sync.executeResource(javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response) |
boolean |
ASync.executeResource(javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response) |
boolean |
HomePage.executeResource(javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response) |
boolean |
TAPResource.executeResource(javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
Interpret the given request, execute the appropriate action and finally return a result or display information to the user.
|
boolean |
Availability.executeResource(javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response) |
Constructor and Description |
---|
ASync(ServiceConnection service)
Build an Asynchronous Resource of a TAP service.
|
TAP(ServiceConnection serviceConnection)
Build a HOME resource of a TAP service whose the description is given in
parameter.
|
Modifier and Type | Method and Description |
---|---|
TAPSchema |
Uploader.upload(DALIUpload[] uploads)
Upload all the given VOTable inputs.
|
Constructor and Description |
---|
Uploader(ServiceConnection service,
DBConnection dbConn)
Build an
Uploader object. |
Uploader(ServiceConnection service,
DBConnection dbConn,
TAPSchema uplSchema)
Build an
Uploader object. |