The web-based user interface defines how a user will interact with VXQuery through a browser. This page has been created to discuss and define the user interface while the issue  VXQUERY-182 - Getting issue details... STATUS  tracks the progress of the implementation.

Website User Interface Details

The VXQuery web interface must provide a clean query interface for the user. A user should be able to enter a query and see the results. Query options should allow for additional details to be returned inaddition to the query result. The interface should also include helpful links for the end user. 

The basic interface can be boiled down to three areas. The header, the query window, and the results.

Header

  • Apache logo
  • VXQuery logo
  • project site link
  • XQuery specification link
  • Server statistics link

Query Window and Options

  • Query window (may include many queries)
  • Print abstract syntax tree (AST) (text and/or picture)
  • Print logical plan (text and/or picture)
  • Print optimized plan (text and/or picture)
  • Print job specification (text and/or picture)
  • Print query statistics
  • Query button

Results

These results are for each query in the query window.

  • XML query results
  • Abstract syntax tree (optional)
  • Logical plan (optional)
  • Optimized plan (optional)
  • Job specification (optional)
  • Query statistics (optional)

UI Proposals

Suggested user interface proposals:

Tasks

  • Process XQuery
    • See detailed information about AST, logical and optimized plan, job (text and picture).
  • Get XQuery result
  • Observe the cluster state/configuration

FAQ

Q1. The AST of the query is given in the form of text through present system and there is no other way to extract it. Can I make few changes in the Core to get it in desired format ?

As for the results you need to return (AST, result, etc.), the API will need to accomplish two tasks. First would be to collect all the values that need to be returned to the client. Second, would be to consider the format that those results are returned.

 

 

 

  • No labels