Overview

This document lists the functions available on the Astro Client Runtime via XMLRPC. It presents the methods in an abridged, language-independent form. This document is generated from the ACR javadoc - refer there for full details, and especially for Getting Started information.

Service List

In the ACR, related functions are grouped into Services. Related services are in turn grouped into Modules. This section summarizes the available modules and services.

Map Structures

Some ACR functions return structured data - which are represented in XML-RPC as maps. Different programming languages have differing terms for a map - it may be known as a dictionary / dict / hash / associative array. All refer to the same thing - a datastructure that provides mapping between keys and values This section describes the different kinds of map structure used by the ACR.

astrogrid

astrogrid.applications

Work with remote applications - Compute and Data Query services. The Common Execution Architecture (CEA) provides a uniform way to describe and execute astronomical applications and data services on the VO. This interface provides methods to

  • Discover available applications
  • Build invocation documents containing the correct parameters
  • Submit invocation documents for execution on remote servers
  • Monitor progress and retreive results of execution
Each new application invocation is assigned a new globally unique id. These id's should be treated as opaque objects - the internal structure is still liable to change.

See: Common Execution Architecture - IVOA Proposal

Tool Document Schema-Documentation Value Parameter Element Schema-Documentation XSD Schemas

Calling CEA services - example python script Calling CEA services - example groovy script Example Tool Document

org.astrogrid.acr.ui.ApplicationLauncher org.astrogrid.acr.astrogrid.ApplicationInformation org.astrogrid.acr.dialogs.ToolEditor org.astrogrid.acr.astrogrid.ExecutionInformation



astrogrid.applications.list()
list remote applications available in the registry.

Return - a list of the registry identifiers of available applications (List of : Ivorn or other URI)


astrogrid.applications.getRegistryQuery()
helper method - returns the ADQL query that should be passed to the registry to list all available applications. can be used as a starting point to build up filters, etc.

Return - an adql query string. (string)


astrogrid.applications.getApplicationInformation(applicationName)
get information for a specific application from the registry.

applicationName - name of the application to hunt for (Ivorn or other URI)

Return - details of this application (ApplicationInformation)


astrogrid.applications.getDocumentation(applicationName)
get formatted information about an application

applicationName - (Ivorn or other URI)

Return - formatted, human-readable information about the application (string)


astrogrid.applications.createTemplateDocument(applicationName, interfaceName)
create a template invocation document for a particular application. Examines the registry entry for this application, and constructs a template document containing fields for the required input and output parameters.

applicationName - the application to create the template for (Ivorn or other URI)

interfaceName - interface of this application to create a template from. (string)

Return - a tool document. (xml form) (string containing XML)


astrogrid.applications.createTemplateStruct(applicationName, interfaceName)
create a template invocation datastucture for a particular application. Examines the registry entry for this application, and constructs a template document containing fields for the required input and output parameters.

The datastructure returned is equivalent to the document returned by {@link #createTemplateDocument(URI, String)} - this is a convenience method for scripting languages with minimal xml abilities.

applicationName - the application to create the template for (Ivorn or other URI)

interfaceName - interface of this application to create a template from. (string)

Return - a tool object (structure) (key-value map)


astrogrid.applications.convertDocumentToStruct(document)
convert a invocation document to a invocation structure.

Translates an invocation document between two equvalent forms - a datastructure and a document

document - a tool document (string containing XML)

Return - the equvalent tool structure (key-value map)


astrogrid.applications.convertStructToDocument(struct)
convert a invocation structure to the equivalent document.

struct - a tool structure (key-value map)

Return - the equivalent tool document (string containing XML)


astrogrid.applications.validate(document)
Validate an invocation document against the application's description

Verifies that all required parameters are present.

document - tool document to validate (string containing XML)

Return - (nothing)


astrogrid.applications.validateStored(documentLocation)
Validate an invocation document (referenced by url) against an application description

documentLocation - location of a resource containing the tool document to validate (Ivorn or other URI)

Return - (nothing)


astrogrid.applications.listProvidersOf(applicationId)
list the remote servers that provides a particular application. (It's possible, for CEA especially, that an application may be provided by multiple servers)

applicationId - registry identifier of the application to search servers for. (Ivorn or other URI)

Return - list of registry summaries of cea servers that support this application (List of : ResourceInformation)


astrogrid.applications.submit(document)
submit an invocation document for execution.. No particular remote server is specified - the system will select a suitable one.

document - tool document to execute (string containing XML)

Return - a new unique execution id (Ivorn or other URI)


astrogrid.applications.submitTo(document, server)
submit an invocation document for execution on a named remote server.

document - tool document to execute (string containing XML)

server - remote server to execute on (Ivorn or other URI)

Return - a new unique execution id (Ivorn or other URI)


astrogrid.applications.submitStored(documentLocation)
a variant of {@link #submit} where invocation document is stored somewhere and referenced by URI.

documentLocation - pointer to tool document - may be file:/, http://, ftp:// or ivo:// (myspace) protocols (Ivorn or other URI)

Return - a new unique execution id (Ivorn or other URI)


astrogrid.applications.submitStoredTo(documentLocation, server)
variant of {@link #submitTo} where tool document is referenced by URI. * @param documentLocation pointer to tool document - may be file:/, http://, ftp:// or ivo:// (myspace) protocols

documentLocation - (Ivorn or other URI)

server - remote server to execute on (Ivorn or other URI)

Return - a new unique execution id (Ivorn or other URI)


astrogrid.applications.cancel(executionId)
cancel execution of an application.

executionId - id of execution to cancel (Ivorn or other URI)

Return - (nothing)


astrogrid.applications.getExecutionInformation(executionId)
retrive information about an application execution.

executionId - id of application to query (Ivorn or other URI)

Return - summary of this execution (ExecutionInformation)


astrogrid.applications.getResults(executionid)
retreive results of the application execution .

executionid - id of application to query (Ivorn or other URI)

Return - results of this execution (name - value pairs). Note that this will only be the actual results for direct output parameters. For output parameters specified as indirect, the value returned will be the URI pointing to the location where the results are stored. (key-value map)

astrogrid.community

astogrid identity and authentication. At the moment provides login ability. Later will provide access to permissioning and quota information for the current user.



astrogrid.community.login(username, password, community)
login to astrogrid - identify yourself

username - user name (e.g. fredbloggs) (string)

password - password for this user (string)

community - community the user is registered with (e.g. uk.ac.astogrid ) (string)

Return - (nothing)


astrogrid.community.getUserInformation()
access information about the currently logged in user. This method forces login if not already logged in.

Return - information about the current user. (UserInformation)


astrogrid.community.logout()
log current user out of astrogrid

Return - (nothing)


astrogrid.community.isLoggedIn()
verify user is currently logged in.

Return - true if the user is logged in (boolean)


astrogrid.community.guiLogin()
display the login dialogue to prompt the user for input, and then log in

Return - (nothing)

astrogrid.jobs

Execute and control workflows on remote job servers. For now, an interface to a single JES server - which is configured in the system properties for the ACR. In future, JES servers should be registered, and a default server associated with a user in a community . It may also be necessary to be able to browse a selection of job servers, and maybe aggregate a user's jobs from a set of servers.

Each workflow submitted is assigned a globally-unique identifier. This takes the form of a URI, but should be treated as opaque - the structure is liable to change once JES servers are registered.

See: Workflow Userguide Workflow Scripting FAQ

Workflow Schema-Documentation Execution Record Schema-Document XSD Schemas

Example workflow Example execution transcript Html-formatted execution transcript org.astrogrid.acr.astrogrid.Applications Information about executing single applications org.astrogrid.acr.astrogrid.Myspace Information about distributed file storage org.astrogrid.acr.astrogrid.RemoteProcessManager for more general process management - methods in this class are convenicne wrapper around operations in RemoteProcessManager

org.astrogrid.acr.ui.JobMonitor org.astrogrid.acr.ui.WorkflowBuilder org.astrogrid.acr.astrogrid.ExecutionInformation



astrogrid.jobs.list()
list the jobs for the current user.

Return - list of identifiers for the user's jobs (both current and completed jobs ) (List of : Ivorn or other URI)


astrogrid.jobs.listFully()
list summaries of the jobs for the current user.

Return - a beanful of information on each job (List of : ExecutionInformation)


astrogrid.jobs.createJob()
create a new initialized workflow document, suitable as a starting point for building workflows.

Return - a workflow document - a workflow document in the the http://www.astrogrid.org/schema/AGWorkflow/v1 namespace (string containing XML)


astrogrid.jobs.wrapTask(taskDocument)
wrap a remote application invocation document, to create a single-step workflow.

taskDocument - - a task document in the http://www.astrogrid.org/schema/AGWorkflow/v1 namespace (string containing XML)

Return - a workflow document with a single step that executes the parameter task - a workflow document in the the http://www.astrogrid.org/schema/AGWorkflow/v1 namespace (string containing XML)


astrogrid.jobs.getJobTranscript(jobURN)
retrieve the execution transcript for a job.

jobURN - the identifier of the job to retrieve (Ivorn or other URI)

Return - a workflow transcript document - A workflow document in the http://www.astrogrid.org/schema/AGWorkflow/v1 namespace, annotated with execution information from the http://www.astrogrid.org/schema/ExecutionRecord/v1 namespace. (string containing XML)


astrogrid.jobs.getJobInformation(jobURN)
retrive summary for a job.

jobURN - the identifier of the job to summarize (Ivorn or other URI)

Return - information about this job. (ExecutionInformation)


astrogrid.jobs.cancelJob(jobURN)
cancel the exeuciton of a running job.

jobURN - identifier of the job to cancel. (Ivorn or other URI)

Return - (nothing)


astrogrid.jobs.deleteJob(jobURN)
delete all record of a job from the job server.

jobURN - identifier of the job to delete (Ivorn or other URI)

Return - (nothing)


astrogrid.jobs.submitJob(workflow)
submit a workflow for execution.

workflow - workflow document to submit (string containing XML)

Return - a unique identifier for this new job (Ivorn or other URI)


astrogrid.jobs.submitStoredJob(workflowReference)
submit a workflow (stored in a file) for execution.

workflowReference - url refernce to the workflow document to submit (may be file://, http://, ftp:// or ivo:// - a myspace reference.) (Ivorn or other URI)

Return - a unique identifier for this new job. (Ivorn or other URI)

astrogrid.myspace

Work with Myspace - a distributed storage system, AstroGrid's implementation of VOSpace. All resources in myspace are uniquely identified by a myspace resource identifier - which is an URI of form * ivo://Community-Id/User-Id#File-Path. However, for convenience methods in this interface also accept an abridged form of reference - #File-Path - this is resolved relative to the currently logged-in user. The abridged form is more concise, and means hard-coded file references can be avoided if needed.

NB: At present this interface doesn't contain suficient functionality to work with myspace in a truly efficient manner. Expect a cleaner, more efficient interface to myspace to be added later. However this interface and it's current methods will remain available, and won't be deprecated.

See: IVOA VOStore org.astrogrid.acr.ui.MyspaceBrowser org.astrogrid.acr.dialogs.ResourceChooser org.astrogrid.acr.astrogrid.NodeInformation



astrogrid.myspace.getHome()
retreive the identifier of the current user's home folder in myspace. Each user has a single root folder. this method returns the name of it.

Return - uri of the home folder - typically has form ivo://Community-Id/User-Id# (Ivorn or other URI)


astrogrid.myspace.exists(ivorn)
test whether a myspace resource exists.

ivorn - uri to check (full or abridged form) (Ivorn or other URI)

Return - true if the resource exists (boolean)


astrogrid.myspace.getNodeInformation(ivorn)
access metadata about a myspace resource. NB: At the moment, this is a costly operation.

ivorn - resource to investigate (Ivorn or other URI)

Return - a beanful of information (NodeInformation)


astrogrid.myspace.createFile(ivorn)
create a new myspace file. Any parent folders that are missing will be created too.

ivorn - the resource to create. (Ivorn or other URI)

Return - (nothing)


astrogrid.myspace.createFolder(ivorn)
create a new myspace folder. Any parent folders that are missing will be created too.

ivorn - the resource to create. (Ivorn or other URI)

Return - (nothing)


astrogrid.myspace.createChildFolder(parentIvorn, name)
create a child folder of the specified resource.

parentIvorn - parent of the new resource (must be a folder) (Ivorn or other URI)

name - name of the new folder (string)

Return - the ivorn of the new folder (Ivorn or other URI)


astrogrid.myspace.createChildFile(parentIvorn, name)
create a child file of the specified resource.

parentIvorn - parent of the new resource (must be a folder) (Ivorn or other URI)

name - name of the new file (string)

Return - the ivorn of the new file (Ivorn or other URI)


astrogrid.myspace.getParent(ivorn)
retrieve the ID of the parent of a myspace resource

ivorn - uri of the resource to find parent for (Ivorn or other URI)

Return - uri of the parent (Ivorn or other URI)


astrogrid.myspace.list(ivorn)
list the names of the children (files and folders) of a myspace folder

ivorn - uri of the folder to inspect (Ivorn or other URI)

Return - an array of the names of the contents. (List of : string)


astrogrid.myspace.listIvorns(ivorn)
list the identifiers of the children ( files and folders) of a myspace folder

ivorn - uri of the folder to inspect (Ivorn or other URI)

Return - an array of the ivorns of the contents. (List of : Ivorn or other URI)


astrogrid.myspace.listNodeInformation(ivorn)
list the node information objects for the children ( files and folders) of a myspace folder NB: Expensive operation at present.

ivorn - uri of the folder to inspect (Ivorn or other URI)

Return - an array of the node information objects. (List of : NodeInformation)


astrogrid.myspace.refresh(ivorn)
refresh the metadata held about a myspace resource with the server.

For performance, metadata about myspace resources is used in a LRU cache. This method forces the ACR to re-query the myspace server about this resource.

ivorn - resource to refresh (Ivorn or other URI)

Return - (nothing)


astrogrid.myspace.delete(ivorn)
delete a myspace resource

ivorn - uri of the resource to delete (Ivorn or other URI)

Return - (nothing)


astrogrid.myspace.rename(srcIvorn, newName)
rename a myspace resource

srcIvorn - uri of the resource to renam (Ivorn or other URI)

newName - new name for this resource (string)

Return - uri pointing to the renamed resource (original uri may now be invalid) (Ivorn or other URI)


astrogrid.myspace.move(srcIvorn, newParentIvorn, newName)
move a myspace resource

srcIvorn - ivorn of the resource to move (Ivorn or other URI)

newParentIvorn - ivorn of the new parent (Ivorn or other URI)

newName - new name for this resource. (string)

Return - uri pointing to the moved resouce (original uri will now be invalid) (Ivorn or other URI)


astrogrid.myspace.changeStore(srcIvorn, storeIvorn)
relocate a myspace resource to a different store. The relocated file remains in the same position in the user's myspace filetree. However, this method moves the data associated with the file from one filestore to another.

srcIvorn - uri of the resource to relocate (Ivorn or other URI)

storeIvorn - uri of the store server to relocat to. (Ivorn or other URI)

Return - (nothing)


astrogrid.myspace.copy(srcIvorn, newParentIvorn, newName)
make a copy of a resource

srcIvorn - uri of the resource to copy (Ivorn or other URI)

newParentIvorn - uri of the folder to copy to (Ivorn or other URI)

newName - name to copy to (string)

Return - uri pointing to the resource copy (Ivorn or other URI)


astrogrid.myspace.read(ivorn)
read the content of a myspace resource directly. NB: not a good idea for large files. in this case use {@link #copyContentToURL(URI, URL) } or {@link #getReadContentURL(URI) }

ivorn - resource to read (Ivorn or other URI)

Return - content of this resource (as a string) (string)


astrogrid.myspace.write(ivorn, content)
Write data to a myspace resource. NB: not a good idea for large files. In this case use {@link #copyURLToContent(URL, URI) }

ivorn - resource to write to (Ivorn or other URI)

content - the data to write (string)

Return - (nothing)


astrogrid.myspace.readBinary(ivorn)
read the binary content of a myspace resource directly. NB: not a good idea for large files. in this case use {@link #copyContentToURL(URI, URL) } or {@link #getReadContentURL(URI) }

ivorn - resource to read (Ivorn or other URI)

Return - byte array of the contents of this resource (List of : byte)


astrogrid.myspace.writeBinary(ivorn, content)
Write binary data to a myspace resource. NB: not a good idea for large files. In this case use {@link #copyURLToContent(URL, URI) }

ivorn - resource to write to (Ivorn or other URI)

content - the data to write (List of : byte)

Return - (nothing)


astrogrid.myspace.getReadContentURL(ivorn)
compute a URL which can then be read to access the contents (data) of a myspace resource.

ivorn - resource to read (Ivorn or other URI)

Return - a url from which the contents of the resource can be read (URL)


astrogrid.myspace.getWriteContentURL(ivorn)
compute a URL which can then be written to set the contents (i.e. data) of a myspace resource.

ivorn - resource to write to (Ivorn or other URI)

Return - a url to which the contents of the resource can be written (URL)


astrogrid.myspace.transferCompleted(ivorn)
Notify the filemanager server that the data for a filestore node has been changed. This method must be called after storing data in a myspace file via the URL returned by {@link #getWriteContentURL}. There's no need to call this method when storing data using any other method

ivorn - the myspace resource just written to (Ivorn or other URI)

Return - (nothing)


astrogrid.myspace.copyContentToURL(ivorn, destination)
Copy the contents (data) of a resource out of myspace into a URL location.

ivorn - the myspace resource to write out (Ivorn or other URI)

destination - a writable URL - file:/, http:/ or ftp:/ protocol (URL)

Return - (nothing)


astrogrid.myspace.copyURLToContent(src, ivorn)
Copy the contents (data) of a URL location into a myspace resource

src - url to read data from - file:/, http:/ or ftp:/ protocol. (URL)

ivorn - the myspace resource to store the data in. (Ivorn or other URI)

Return - (nothing)


astrogrid.myspace.listAvailableStores()
List the available filestores

Return - an array of resource information (List of : ResourceInformation)

astrogrid.registry

access the AstroGrid registry. Astrogrid use an IVOA-compliant registry to store details of available resources - servers, applications, catalogues, etc. Later, a generic interface to arbitrary IVOA registries will be added. This will allow other registries to be interrogated.

See: IVOA Identifiers Resource Metadata IVOA Resource Metadata for the VO ADQL Query Language Specification IVOA Registry Working Group XQuery Language Tutorial org.astrogrid.acr.ui.RegistryBrowser org.astrogrid.acr.astrogrid.ResourceInformation



astrogrid.registry.resolveIdentifier(ivorn)
Resolve a registry identifier to an endpoint.

ivorn - registry identifier for the registered service (Ivorn or other URI)

Return - a URL endpoint of this service (URL)


astrogrid.registry.getRecord(ivorn)
Retreive a record from the registry.

ivorn - identifier of the registry entry to retrrieve (Ivorn or other URI)

Return - xml document of the registry entry - a Resource document i n the http://www.ivoa.net/xml/RegistryInterface/v0.1 namespace (string containing XML)


astrogrid.registry.getResourceInformation(ivorn)
Retrieve a record from the registry, returning it as a datastructure that contains the most commonly used parts. For most uses, it's better to use this method instead of {@link #getRecord} as the result is easier to work with.

ivorn - identifier of the registry entry to retrieve (Ivorn or other URI)

Return - a summary of the most significant parts of the registry entry - will be a {@link ResourceInformation} or a subclass - e.g. {@link ApplicationInformation} or {@link TabularDatabaseInformation} depending on resource type (ResourceInformation)


astrogrid.registry.adqlSearch(adql)
Perform a ADQL query.

adql - a string query (string form of ADQL) (string)

Return - xml document of search results - a series of matching registry records contained within an element called SearchResponse in the namespace http://www.astrogrid.org/registry/wsdl (string containing XML)


astrogrid.registry.adqlSearchRI(adql)
Perform an ADQL query, returning a list of datastructures. Equivalent of {@link #adqlSearch(String)} but returning a ist of datastructues that contain the most comonly used pats of the registry record.

adql - (string)

Return - (List of : ResourceInformation)


astrogrid.registry.xquerySearch(xquery)
perform an XQuery

xquery - the query to perform. (string)

Return - the result of executing this xquery over the registry - a document of arbitrary structure. If the result of executing this query is not a well-formed xml document itself (e.g. it's a list of nodes, or a text result, it will be wrapped in a <vor:resources> element. The name of this element is liable change in later versions - so queries that return well-formed documents re recommended). (string containing XML)


astrogrid.registry.listNamespaces()
List the namespaces that are used to qualify adql and xquery searches. These namepsaces are automatically prepended to queries submitted, which simplifies query entry.

Return - an arry of 2-element arrays. the first in each pair is the namespace name used within the queries., while the second is the uri that defines this namespace (List of : string)


astrogrid.registry.keywordSearch(keywords, orValues)
perform a keyword search

keywords - list of keywords to search for (string)

orValues - - true to 'OR' together matches. false to 'AND' together matches (boolean)

Return - xml document of search results, same format as result of {@link #adqlSearch(String)} (string containing XML)


astrogrid.registry.keywordSearchRI(keywords, orValues)
Perform a keyword search and return a list of datastructures. Equivalent of {@link #keywordSearch(String, boolean)} but more convenient to use.

keywords - (string)

orValues - (boolean)

Return - (List of : ResourceInformation)

cds

cds.coordinate

Astronomical Coordinate Web Service, from CDS

See: http://cdsweb.u-strasbg.fr/cdsws/astroCoo.gml



cds.coordinate.convert(x, y, z, precision)
convert a coordinate

x - (10.0) (double)

y - (15.0) (double)

z - (20.0) (double)

precision - (0=NONE, 1=DEG, 3=ARCMIN, 5=ARCSEC, 8=MAS) (int)

Return - a String like 03 45 14.3838 +47 58 07.990 (J2000.0) (string)


cds.coordinate.convertL(lon, lat, precision)
convert a longitude-lattitude coordinate

lon - (12.0) (double)

lat - (45.0) (double)

precision - (0=NONE, 1=DEG, 3=ARCMIN, 5=ARCSEC, 8=MAS) (int)

Return - a String like 04 21 34. +53 32.5 (J2000.0) (string)


cds.coordinate.convertE(frame1, frame2, x, y, z, precision, equinox1, equinox2)
convert a coordinate, considering equinox

frame1 - (1=FK4, 2=GAL, 3=SGAL, 4=ECL, 5=FK5, 6=ICRS) (int)

frame2 - (1=FK4, 2=GAL, 3=SGAL, 4=ECL, 5=FK5, 6=ICRS) (int)

x - (10.0) (double)

y - (15.0) (double)

z - (20.0) (double)

precision - (0=NONE, 1=DEG, 3=ARCMIN, 5=ARCSEC, 8=MAS) (int)

equinox1 - (Julian Years or Besselian, unused for GAL, SGAL, ICRS) (double)

equinox2 - (Julian Years or Besselian, unused for GAL, SGAL, ICRS) (double)

Return - a String like 150.4806267 -05.3873952 (Gal) (string)


cds.coordinate.convertLE(frame1, frame2, lon, lat, precision, equinox1, equinox2)
convert a longitude-latitude coordinate, considering equinox

frame1 - (1=FK4, 2=GAL, 3=SGAL, 4=ECL, 5=FK5, 6=ICRS) (int)

frame2 - (1=FK4, 2=GAL, 3=SGAL, 4=ECL, 5=FK5, 6=ICRS) (int)

lon - (12.0) (double)

lat - (45.0) (double)

precision - (0=NONE, 1=DEG, 3=ARCMIN, 5=ARCSEC, 8=MAS) (int)

equinox1 - (Julian Years or Besselian, unused for GAL, SGAL, ICRS) (double)

equinox2 - (Julian Years or Besselian, unused for GAL, SGAL, ICRS) (double)

Return - (string)

cds.glu

Webservice to resolve GLU (Generateur de Liens Uniformes).tags.

See: http://cdsweb.u-strasbg.fr/cdsws/glu_resolver.gml



cds.glu.getURLfromTag(id)
Resolve a tag.

id - a tag to resolve (example : VizieR.MetaCat) (string)

Return - Result : URL corresponding to the tag (example : http://vizier.u-strasbg.fr/cgi-bin/votable?-meta) (string)

cds.sesame

Resolve object names to position by querying Simbad and/or NED and/or VizieR.

See: http://cdsweb.u-strasbg.fr/cdsws/name_resolver.gml



cds.sesame.sesame(name, resultType)
resolve a name to position.

name - the name to resolve (string)

resultType - 
            u = usual (corresponding to the deprecated Sesame(String name) output)                 H = html                  x = XML (XSD at http://vizier.u-strasbg.fr/xml/sesame_1.xsd)                  p (for plain (text/plain)) and i (for all identifiers) options can be added to H or x
(string)

Return - (string)


cds.sesame.sesameChooseService(name, resultType, all, service)
resolve a name, selecing which services to use.

name - the name to resolve (string)

resultType - * 
            u = usual (corresponding to the deprecated Sesame(String name) output)                 H = html                  x = XML (XSD at http://vizier.u-strasbg.fr/xml/sesame_1.xsd)                  p (for plain (text/plain)) and i (for all identifiers) options can be added to H or x
(string)

all - true if all identifiers wanted (boolean)

service - 
    S=Simbad         N=NED          V=VizieR         A=all
(examples : S to query in Simbad, NS to query in Ned if not found in Simbad, NSA to query in Ned and Simbad, A to query in Ned, Simbad and VizieR, ...) (string)

Return - format depending on the resultTtpe parameter (string)

cds.ucd

Web Service for manipulating Unified Content Descriptors (UCD).

See: http://cdsweb.u-strasbg.fr/cdsws/ucdClient.gml



cds.ucd.UCDList()
list of UCD1

Return - html document containing all ucd1 (string)


cds.ucd.resolveUCD(ucd)
resolve a UCD1 (wont work with UCD1+)

ucd - ucd the UCD1 to resolve (example : PHOT_JHN_V) (string)

Return - sentence corresponding to the UCD1 (example : Johnson magnitude V (JHN)) (string)


cds.ucd.UCDofCatalog(catalog_designation)


catalog_designation - designes the catalog (example : I/239) (string)

Return - list of UCD1 (in raw text) contained in a given catalog (string)


cds.ucd.translate(ucd)
makes the translation of old-style UCD1 into the newer UCD1+ easier:

ucd - The argument is a UCD1 (not UCD1+ !). (string)

Return - String ucd. This function returns the default UCD1+ corresponding to an old-style UCD1. (string)


cds.ucd.upgrade(ucd)
upgrade a ucd

ucd - a deprecated UCD1+ (word or combination). Useful when the 'validate' method returns with code 2. (string)

Return - String ucd. This function returns a valid UCD1+ corresponding to a deprecated word. It is useful when some reference words of the UCD1+ vocabulary are changed, and ensures backward compatibility. (string)


cds.ucd.validate(ucd)
validate a ucd

ucd - (e.g. ivoa:phot.mag;em.opt.B) (string)

Return - String, this function checks that a UCD is well-formed 
 The first word of the string is an error code, possibly followed by an explanation of the error.  A return value of 0 indicates no error (valid UCD).  The error-code results from the combination (logical OR) of the following values:   1: warning indicating use of non-standard namespace (not ivoa:)  2: use of deprecated word  4: use of non-existing word  8: syntax error (extra space or unallowed character)
(string)


cds.ucd.explain(ucd)
returns description of a ucd

ucd - (e.g. ivoa:phot.mag;em.opt.B) (string)

Return - String, this function gives a human-readable explanation for a UCD composed of one or several words (string)


cds.ucd.assign(descr)
Find the UCD associated with a description

descr - Plain text description of a parameter to be described (string)

Return - String ucd. This function returns the UCD1+ corresponding to the description (string)

cds.vizier

Access VizieR catalogues from CDS

See: http://cdsweb.u-strasbg.fr/cdsws/vizierAccess.gml



cds.vizier.cataloguesMetaData(target, radius, unit, text)
get metadata about catalogues.

target - (example : M31) (string)

radius - (example : 1.0) (double)

unit - (example : arcmin) (string)

text - (author, ..., example : Ochsenbein) (string)

Return - metadata about catalogues depending on the given parameters (VOTable format) (string containing XML)


cds.vizier.cataloguesMetaDataWavelength(target, radius, unit, text, wavelength)
get metadata about catalogues

target - (example : M31) (string)

radius - (example : 1.0) (double)

unit - (example : arcmin) (string)

text - (author, ..., example : Ochsenbein) (string)

wavelength - (example : optical, Radio, like in the VizieR Web interface) (string)

Return - metadata about catalogues depending on the given parameters (VOTable format) (string containing XML)


cds.vizier.cataloguesData(target, radius, unit, text)
get catalogue data

target - (example : M31) (string)

radius - (example : 1.0) (double)

unit - (example : arcmin) (string)

text - (author, ..., example : Ochsenbein) (string)

Return - data about catalogues depending on the given parameters (VOTable format) (string containing XML)


cds.vizier.cataloguesDataWavelength(target, radius, unit, text, wavelength)
get catalogue data for a wavelength

target - (example : M31) (string)

radius - (example : 1.0) (double)

unit - (example : arcmin) (string)

text - (author, ..., example : Ochsenbein) (string)

wavelength - (example : optical, Radio, like in the VizieR Web interface) (string)

Return - data about catalogues depending on the given parameters (VOTable format) (string containing XML)


cds.vizier.metaAll()
get metadata for all catalogues

Return - all metadata about catalogues in VizieR (VOTable format) (string containing XML)

dialogs

dialogs.resourceChooser

Prompt the user to select a local file / myspace resource / url by displaying a resource chooser dialogue. This is a generalisation of the 'open/save file' browser that also allows a myspace resource, or arbitrary URL to be selected.





See: org.astrogrid.acr.astrogrid.Myspace



dialogs.resourceChooser.chooseResource(title, enableMySpace)
show the resource chooser, and block until user selects.

title - title for the dialogue - e.g.'choose file to open' (string)

enableMySpace - - if true, enable the myspace tab. if false, don't display this. (boolean)

Return - URI of the selected resource, or null if the user cancelled. (Ivorn or other URI)


dialogs.resourceChooser.fullChooseResource(title, enableMySpace, enableLocalFile, enableURI)
fully-configurable resource chooser - a generalization of {@link #chooseResource}

title - title for the dialogue (string)

enableMySpace - if true, enable the myspace tab (boolean)

enableLocalFile - if true, enable the local file tab (boolean)

enableURI - if true, enable the 'enter a URL' tab (boolean)

Return - the URI of the selected resource, or null if the user cancelled (Ivorn or other URI)

dialogs.toolEditor

Display the remote invocation document editor as a dialogue. Can be used to construct calls to Remote applications, such as data processor and catalogues.

Displays the content of a invocation document, augmented with data about this application loaded from the registry. Enables user to edit input ad output parameters (including using the {@link org.astrogrid.acr.dialogs.ResourceChooser} dialogue to select indirect parameters.



See: Tool Document Schema-Documentation Value Parameter Element Schema-Documentation XSD Schemas Example Tool Document org.astrogrid.acr.astrogrid.Applications



dialogs.toolEditor.edit(t)
Prompt the user to edit a tool document

t - document conforming to Tool schema (string containing XML)

Return - an edited copy of this document (string containing XML)


dialogs.toolEditor.editWithDescription(t, desc)
Prompt the user to edit a tool document

t - document conforming to Tool schema (string containing XML)

desc - description of the application this tool document is to be built for (rather than querying registry) (ApplicationInformation)

Return - an edited copy of this document (string containing XML)


dialogs.toolEditor.editStored(documentLocation)
prompt the user to edit a tool document stored elsewhere

documentLocation - location the tool document is stored at (http://, ftp://, ivo://) (Ivorn or other URI)

Return - edited copy of this document (string containing XML)


dialogs.toolEditor.selectAndBuild()
prompt the user to select a VO service (application, datacenter, or something else) and construct a query against it.

Return - a new tool document (string containing XML)

ivoa

ivoa.adql074

Routines for with Astronomy Data Query Language (ADQL)



ivoa.adql074.s2x(adqls)
convert ADQL/s to ADQL/x

adqls - query string (human readable) (string)

Return - equivalent adqlx (xml, v 7.4) (string containing XML)


ivoa.adql074.x2s(doc)
convert ADQL/x to ADQL/s

doc - adqlx document (xml, v 7.4) (string containing XML)

Return - equivalent adql/s (human readable) (string)

ivoa.siap

Queryi for Images from Simple Image Access Protocol (SIAP) services

See: http://www.ivoa.net/Documents/latest/SIA.html



ivoa.siap.constructQuery(service, ra, dec, size)
construct query on RA, DEC, SIZE

service - URL of the service endpoint, or ivorn of the service description (Ivorn or other URI)

ra - right ascension (as described in siap spec) (double)

dec - declination (as described in siap spec) (double)

size - radius of cone ( as described in siap spec) (double)

Return - query URL that can be fetched using a HTTP GET to execute query (URL)


ivoa.siap.constructQueryF(service, ra, dec, size, format)
construct query on RA, DEC, SIZE, FORMAT

service - URL of the service endpoint, or ivorn of the service description (Ivorn or other URI)

ra - right ascension (as described in siap spec) (double)

dec - declination (as described in siap spec) (double)

size - radius of cone ( as described in siap spec) (double)

format - format of images (as described in siap spec) (string)

Return - query URL that can be fetched using a HTTP GET to execute query (URL)


ivoa.siap.constructQueryS(service, ra, dec, ra_size, dec_size)
construct query on RA, DEC, RA_SIZE, DEC_SIZE

service - URL of the service endpoint, or ivorn of the service description (Ivorn or other URI)

ra - right ascension (as described in siap spec) (double)

dec - declination (as described in siap spec) (double)

ra_size - size of ra ( as described in siap spec) (double)

dec_size - size of dec (as described in siap spec) (double)

Return - query URL that can be fetched using a HTTP GET to execute query (URL)


ivoa.siap.constructQuerySF(service, ra, dec, ra_size, dec_size, format)
construct query on RA, DEC, RA_SIZE, DEC_SIZE, FORMAT

service - URL of the service endpoint, or ivorn of the service description (Ivorn or other URI)

ra - right ascension (as described in siap spec) (double)

dec - declination (as described in siap spec) (double)

ra_size - size of ra ( as described in siap spec) (double)

dec_size - size of dec (as described in siap spec) (double)

format - format of images (as described in siap spec) (string)

Return - query URL that can be fetched using a HTTP GET to execute query (URL)


ivoa.siap.addOption(query, optionName, optionValue)
add an option to a previously constructed query

query - the query url (URL)

optionName - name of the option to add (string)

optionValue - value for the new option (string)

Return - query with the option appended. (URL)


ivoa.siap.getResults(siapQuery)
execute a SIAP query. This is a convenience method - just performs a 'GET' on the query url- many programming languages support this functionality themselves

siapQuery - query url to execute (URL)

Return - a votable of results (string containing XML)


ivoa.siap.saveResults(siapQuery, saveLocation)
execute a SIAP query and save the results.

siapQuery - query url to execute (URL)

saveLocation - location to save result document - may be file:/, ivo:// (myspace), ftp:// (Ivorn or other URI)

Return - (nothing)


ivoa.siap.getRegistryQuery()
helper method - returns an ADQL query that should be passed to a registry to list all available siap services.

can be used as a starting point for filters, etc.

Return - an adql query string (string)

ivoa.ssap

Querying for Spectra from Simple Spectral Access Protool (SSAP) Services. NB: working, but based on unfinished IVOA specification - liable to change to follow specificaiton.

See: - url



ivoa.ssap.constructQuery(service, ra, dec, size)
construct query on RA, DEC, SIZE

service - URL of the service endpoint, or ivorn of the service description (Ivorn or other URI)

ra - right ascension (as described in ssap spec) (double)

dec - declination (as described in ssap spec) (double)

size - radius of cone ( as described in ssap spec) (double)

Return - query URL that can be fetched using a HTTP GET to execute query (URL)


ivoa.ssap.constructQueryS(service, ra, dec, ra_size, dec_size)
construct query on RA, DEC, RA_SIZE, DEC_SIZE

service - URL of the service endpoint, or ivorn of the service description (Ivorn or other URI)

ra - right ascension (as described in ssap spec) (double)

dec - declination (as described in ssap spec) (double)

ra_size - size of ra ( as described in ssap spec) (double)

dec_size - size of dec (as described in ssap spec) (double)

Return - query URL that can be fetched using a HTTP GET to execute query (URL)


ivoa.ssap.addOption(query, optionName, optionValue)
add an option to a previously constructed query

query - the query url (URL)

optionName - name of the option to add (string)

optionValue - value for the new option (string)

Return - query with the option appended. (URL)


ivoa.ssap.getResults(ssapQuery)
Eexecute a SSAP query. convenience method - just performs a 'GET' on the query url- many programming languages support this functionality themselves

ssapQuery - query url to execute (URL)

Return - a votable of results (string containing XML)


ivoa.ssap.saveResults(ssapQuery, saveLocation)
execute a SSAP query and save the results.

ssapQuery - query url to execute (URL)

saveLocation - location to save result document - may be file:/, ivo:// (myspace), ftp:// (Ivorn or other URI)

Return - (nothing)


ivoa.ssap.getRegistryQuery()
helper method - returns an ADQL query that should be passed to a registry to list all available siap services. Can be used as a starting point for filters, etc.

Return - an adql query string (string)

nvo

nvo.cone

Query catalogs using Cone-search services



nvo.cone.constructQuery(service, ra, dec, sr)
construct a query on RA, DEC, SR

service - URL of the service endpoint, or ivorn of the service description (Ivorn or other URI)

ra - right ascension (double)

dec - declination (double)

sr - search radius (double)

Return - query URL that can be fetched using a HTTP GET to execute the query (URL)


nvo.cone.addOption(coneQuery, optionName, optionValue)
Add an option to a previously constructed query

coneQuery - the query url (URL)

optionName - the name of the option to add (string)

optionValue - value for the new option (string)

Return - query with the option appended. (URL)


nvo.cone.getResults(coneQuery)
execute a cone query. Convenience method - just performs a 'GET' on the query URL - many programming languages support this themselves

coneQuery - query url to execute (URL)

Return - a votable of results (string containing XML)


nvo.cone.saveResults(coneQuery, saveLocation)
execute a cone query and save the results

coneQuery - the query url to execute (URL)

saveLocation - location to save result document - may be file://, ivo:// (myspace), ftp:// (Ivorn or other URI)

Return - (nothing)


nvo.cone.getRegistryQuery()
helper method - returns an ADQL query that should be passed to a registry to list all available siap services. Can be used as a starting point for building filters, etc

Return - an adql query string (string)

system

system.apihelp

Access documentation on the functions available in the ACR.. Returns type information applicable for xmlrpc only at moment. For JavaRMI consult the javadoc (available from the workbench in-program help)



system.apihelp.listMethods()
List all methods available in the acr

Return - array of method names in form module.component.method (List of : string)


system.apihelp.listModules()
List all modules available in the acr

Return - array of module names (List of : string)


system.apihelp.listComponentsOfModule(moduleName)
List the components / services within a module

moduleName - (string)

Return - list of service names in formmodule.component (List of : string)


system.apihelp.listMethodsOfComponent(componentName)
Lst the methods of a service

componentName - name of the service in form module.component (string)

Return - list of method names in form module.component.method (List of : string)


system.apihelp.methodSignature(methodName)
Access the XMLRPC type for this signature

methodName - name of the method in form module.component.method (string)

Return - an array of signatures for this method (allows for overloading of method name). Overloading never occurs in ACR, but this form is necessary for compatability with XMLRPC standard. So result will always be an array of length 1. First item in the array is an array of strings - first item in this array is the return type; any following items are parameter types. (List of : string)


system.apihelp.moduleHelp(moduleName)
Access help for a module

moduleName - (string)

Return - documentation for this module (string)


system.apihelp.componentHelp(componentName)
Acccess help for a component / service

componentName - name of the service in form module.component (string)

Return - documentation for this component (string)


system.apihelp.methodHelp(methodName)
Access help for a method

methodName - - name of the method in form module.component.method (string)

Return - documentation for this method (string)


system.apihelp.interfaceClassName(componentName)
Return the class name of the service iterface for a particular component

componentName - - service name of form module.component (string)

Return - class name of associated service interface (string)

system.browser

Control the desktop webbrowser. Trivial interface to display a URL in the desktop's webbrowser (relies on this being correclty configured in java web start console - mostly fine for windows, sometimes needs to be configured by hand on unixes.)



system.browser.openURL(url)
Display a page in the system webbrowser

url - URL of the resource to display (URL)

Return - (nothing)


system.browser.openRelative(relativeURL)
Display a page from the internal ACR webserver in the system webbrowser

relativeURL - relative url from root of ACR webserver context (string)

Return - (nothing)

system.configuration

Inspect and alter the configuration of the workbench and ACR. Allows the user / applications to set key-value pairs, which are automatically persisted between executions. As well as alteriing configuration settings, this is also useful for storing bits of state that should persist between script invocations (e.g. preferences, window positions and sizes), plus configuration information (e.g. username, service endpoints)



system.configuration.setKey(key, value)
Set the value of a new or existing key

key - name of key (string)

value - new value of key (string)

Return - ignore (boolean)


system.configuration.getKey(key)
get the value of a key

key - the name of the key (string)

Return - the associated value, or null (string)


system.configuration.listKeys()
list the keys present in the store

Return - an array of key names (List of : string)


system.configuration.list()
list the contents of the store

Return - a map of key-value pairs. (key-value map)


system.configuration.removeKey(string)
remove a previously defined key.

string - (string)

Return - (nothing)

system.help

Control the workbench in-program help viewer.



system.help.showHelp()
display the help viewer, with the 'top' help page

Return - (nothing)


system.help.showHelpForTarget(target)
display a specific help topic in the viewer

target - name of the topic to display (string)

Return - (nothing)

system.rmi

Access information about the JavaRMI interface to the ACR. No management functions - just query methods.



system.rmi.getPort()
Query which port the RMI server is running on

Return - the number of the network port (int)

system.systemtray

Control the ACR icon in the Desktop system tray. Can display popup alert messages in the notification area, and control the progress indicator.

Only supported on some operating systems - windows and some flavours of unix. If not supported on the current OS, {@link org.astrogrid.acr.builtin.ACR#getService(Class)} will throw a {@link org.astrogrid.acr.NotFoundException} when attempting to retreive this service.



system.systemtray.displayErrorMessage(caption, message)
Display a popup message with the os-local 'error' presentation

caption - popup title (string)

message - text of the message (string)

Return - (nothing)


system.systemtray.displayInfoMessage(caption, message)
Display a popup message with the os-local 'info' presentation

caption - popup title (string)

message - text of the message (string)

Return - (nothing)


system.systemtray.displayWarningMessage(caption, message)
Display a popup message with the os-local 'warning' presentation

caption - popup title (string)

message - text of the message (string)

Return - (nothing)


system.systemtray.startThrobbing()
change the tray icon to indicate ' communication in progress'

Return - (nothing)


system.systemtray.stopThrobbing()
change the tray icon to indicate 'communication finished'

Return - (nothing)

system.ui

Control the main user interface of the workbench. Show or Hide the main user interface, display messages in the status bar



system.ui.show()
show the user interface

Return - (nothing)


system.ui.hide()
hide the user interface - ACR server will continue to run

Return - (nothing)


system.ui.startThrobbing()
change the activity icon to indicate 'communication in progress'

Return - (nothing)


system.ui.stopThrobbing()
change the activity icon to indicate 'communication completed'

Return - (nothing)


system.ui.setLoggedIn(value)
set the login indicator

value - true to indicate logged in, false to indicate 'not logged in' (boolean)

Return - (nothing)


system.ui.setStatusMessage(msg)
set the status message

msg - (string)

Return - (nothing)

system.webserver

Access information about he web-server component of ACR. The web-server provides the HTML and XMLRPC interfaces into the ACR. This interface provides only informational methods, useful for working out how to connect to the webserver. It provides no way of administering the server or deploying new servlets.



system.webserver.getUrlRoot()
get the root url of the the HTML interface. Append xmlrpc to this root url to access the XMLRPC interface

Return - a url of form http://machine:getPort()/getKey/ (string)


system.webserver.getKey()


Return - (string)


system.webserver.getPort()


Return - (int)

ui

userInterface.applicationLauncher

Control the Application Launcher GUI.

See: org.astrogrid.acr.astrogrid.Applications



userInterface.applicationLauncher.show()
display the application launcher gui

Return - (nothing)


userInterface.applicationLauncher.hide()
hide the application launcher window

Return - (nothing)

userInterface.astroscope

Control AstroScope.



userInterface.astroscope.show()
display a new instance of astroscope

Return - (nothing)

userInterface.datascopeLauncher

Control the Datascope launcher



userInterface.datascopeLauncher.show()
display the application launcher gui

Return - (nothing)


userInterface.datascopeLauncher.hide()
hide the application launcher window

Return - (nothing)

userInterface.lookout

Control the Lookout UI



userInterface.lookout.show()


Return - (nothing)


userInterface.lookout.hide()


Return - (nothing)


userInterface.lookout.refresh()


Return - (nothing)

userInterface.myspaceBrowser

Control the Myspace Browser gui

See: org.astrogrid.acr.astrogrid.Myspace



userInterface.myspaceBrowser.show()
show the explorer gui

Return - (nothing)


userInterface.myspaceBrowser.hide()
hide the explorer gui

Return - (nothing)

userInterface.parameterizedWorkflows

Control the parameterized workflows launcher

See: org.astrogrid.acr.ui.JobMonitor



userInterface.parameterizedWorkflows.run()
run the launcher wizard

Return - (nothing)

userInterface.registryBrowser

Control the registry browser UI

See: org.astrogrid.acr.astrogrid.Registry



userInterface.registryBrowser.show()
show a new instance of registry browser ui

Return - (nothing)


userInterface.registryBrowser.hide()
hide the registry browser ui

Return - (nothing)

userInterface.workflowViewer

Control the Workflow Viewer / Builder UI

See: org.astrogrid.acr.ui.JobMonitor org.astrogrid.acr.astrogrid.Jobs



userInterface.workflowViewer.show()
show the workflow builder UI

Return - (nothing)


userInterface.workflowViewer.showTranscript(wf)
display transcript viewer

wf - (string)

Return - (nothing)


userInterface.workflowViewer.hide()
hide the workflow builder UI

Return - (nothing)

plastic

plastic.hub

The interface that a Plastic Hub should support. For information on what a Plastic Hub is, and why you'd want one, please see the URL below.

See: http://plastic.sourceforge.net



plastic.hub.getRegisteredIds()
Get all the IDs of the currently registered applications.

Return - see above (List)


plastic.hub.getHubId()
Get this hub's ID. The hub "registers with itself", and this method will give you its own Id.

Return - see above (Ivorn or other URI)


plastic.hub.registerXMLRPC(name, supportedMessages, callBackURL)
Register an application with the hub. Each application that wishes to use the hub should register with it - the hub may not forward messages from applications whose ID it doesn't recognise. There are different register methods dependening on how (and whether) the application wishes to receive messages back from the hub.

name - An optional string with a short name describing the application. This may be added to the hub assigned ID, making it more human friendly. (string)

supportedMessages - an array of messages (as URIs) the application is interested in. An empty List signifies "all". (List)

callBackURL - the application's internal xmlrpc server URL. Used by the hub to send messages to the application. (URL)

Return - a hub-assigned ID (Ivorn or other URI)


plastic.hub.registerRMI(name, supportedMessages, caller)
A java-rmi version of {@link #registerXMLRPC(String, List, URL) registerXMLRPC}

name - see {@link #registerRMI(String, List, PlasticListener) registerRMI} (string)

supportedMessages - (List)

caller - the PlasticListener that wishes to register (PlasticListener)

Return - (Ivorn or other URI)


plastic.hub.registerNoCallBack(name)
Register this application with the hub, but don't send it any messages in return. This is to allow uncallable applications like scripting environments to register. Note: this method is currently not part of the Plastic spec.

name - (string)

Return - (Ivorn or other URI)


plastic.hub.unregister(id)
Unregister the application from the hub.

id - the application to unregister (Ivorn or other URI)

Return - (nothing)


plastic.hub.request(sender, message, args)
Send a message to all registered Plastic applications.

sender - the id of the originating tool. Note that the hub is at liberty to refused to forward requests that don't come from an ID that it has registered. (Ivorn or other URI)

message - the message to send. (Ivorn or other URI)

args - any arguments to pass with the message (List)

Return - a Map of application ids to responses (key-value map)


plastic.hub.requestToSubset(sender, message, args, recipientIds)
Send a request to listed registered Plastic apps. See {@link #request(URI, URI, List) request} for details of the other parameters.

sender - (Ivorn or other URI)

message - (Ivorn or other URI)

args - (List)

recipientIds - a list of target application ids (as URIs) (List)

Return - (key-value map)


plastic.hub.requestToSubsetAsynch(sender, message, args, recipientIds)
Send a request to listed registered Plastic apps, but don't wait for a response.

sender - (Ivorn or other URI)

message - (Ivorn or other URI)

args - (List)

recipientIds - a List of target application ids (as URIs). See {@link #request(URI, URI, List) request} for details of the other parameters. (List)

Return - (nothing)


plastic.hub.requestAsynch(sender, message, args)
Send a request to all registered Plastic apps, but don't wait for a response. See {@link #request(URI, URI, List) request} for details of parameters.

sender - (Ivorn or other URI)

message - (Ivorn or other URI)

args - (List)

Return - (nothing)

Map Structures

AbstractInformation

Base class - all 'information' structures returned by ACR extend this class.

id
The unique identifier for the resource this bean provides information about. (Ivorn or other URI)
name
The name of this resource. (string)

ApplicationInformation

Inherits keys defined in ResourceInformation

Information Bean describing a registered remote application. getId() will contain a registry identifier - see {@link org.astrogrid.acr.astrogrid.ResourceInformation} for definition

interfaces
The names of the interfaces provided by this application. (List of : InterfaceBean)
parameters
The Parameters used in this application. (key-value map)

ColumnBean

describes a single column in a tabular database.

datatype
the type of this column (string)
description
human-readable description of this column (string)
name
name of this column (string)
uCD
Universal column descriptor for this column (string)
unit
description of the units of this column (string)

ConeInformation

Inherits keys defined in ApplicationInformation

Description of a registered cone-search service. Adds fields for the extra service information provided by a cone search registry entry.

maxRecords
access the maximum number of records this service will return (int)
maxSR
access the maximum search radius, in degrees, this service will accept (float)

DatabaseBean

describes a single database in a TablularDB registry entry

description
human-readable description of the database (string)
name
name of the database (string)
tables
list of descriptions of the tables in this database (List of : TableBean)

ExecutionInformation

Inherits keys defined in AbstractInformation

description of the progress of a remote process - e.g. a workflow job, or CEA application. getId() will return the execution identifier - either a job urn (for workfows) or an execution ivorn (for cea and other remote appilications).

description
description of the process being executed. (string)
startTime
the time the exection started (Date)
finishTime
the time that execution finished (Date)
status
current status of this execution (string)

InterfaceBean

Description of an interface to a remote application.

inputs
list of input parameters (List of : ParameterReferenceBean)
name
the name of the interface (string)
outputs
list of output parameters (List of : ParameterReferenceBean)

NodeInformation

Inherits keys defined in AbstractInformation

descripiton of the properties of a myspace resource (a file or folder). getId() will return a myspace resouce locator - an ivorn of form ivo://Community-Id/User-Id#File-Path

attributes
other metadata attributes of this node (key-value map)
createDate
the creation date for this node (Calendar)
modifyDate
the modification date for this node (Calendar)
size
the size of this resource (long)
contentLocation
the name of the filestore that holds the data of this resource. (Ivorn or other URI)

ParameterBean

description of a single parameter for a remote application. NB - all fields, apart from name and type may be null

defaultValue
default value for the parameter (string)
description
descriptin of the parameter (string)
name
name of the parameter- as used in the generated invocation document (string)
options
an enumeration of possible values for the parameter - may be null. (List of : string)
subType
some further description of the type of this parameter - e.g. acceptable ranges (string)
type
type of ths parameter (string)
ucd
the UCD associated with this parameter type (string)
uiName
user-readable name for this parameter (string)
units
descirption of the units for this parameter (string)

ParameterReferenceBean

Description of a parameter occuring in an interface to a remote application

max
maximum number of times this parameter is permitted to occur (int)
min
minimum number of times this parameter is permitted to occur (int)
ref
name of the parameter - should be used as a reference of the corresponding parameterBean (string)

ResourceInformation

Inherits keys defined in AbstractInformation

summarizes the most useful fields of a registry record. getId() will return a registry identifier - an ivorn of form ivo://Authority-Id/Resource-Id

description
the description of this entry (string)
title
the title of this entry - synonym for {@link #getName} (string)
accessURL
the endpoint URL for this entry (URL)
logoURL
the url for the logo for this entry (URL)

SiapInformation

Inherits keys defined in ApplicationInformation

Description of the registry entry for a Simple Image Access (SIAP) service. Adds fields for the extra service information provided by a SIAP registry entry.

imageServiceType
(string)
maxFileSize
(int)
maxImageExtentDec
(float)
maxImageExtentRa
(float)
maxImageSizeDec
(int)
maxImageSizeRa
(int)
maxQueryRegionSizeDec
(float)
maxQueryRegionSizeRa
(float)
maxRecords
(int)

SsapInformation

description of a SSAP service. no information here at present - as standard has not been agreed.

TableBean

descripition of a single table in a TablularDB registry entry

columns
list descriptions of the columns in this table (List of : ColumnBean)
description
human redable description for this table (string)
name
the name of this table (string)

TabularDatabaseInformation

Inherits keys defined in ResourceInformation

description of a tabular databse registry entry (TabularDB record).

databases
list the databases described by this registry entry (List of : DatabaseBean)

UserInformation

Inherits keys defined in AbstractInformation

Information about the currently logged in user.

  • id
    • - will be the user ivorn
  • name
    • - will be the user's name.

community
access the name of the community the logged in user belongs to (string)
password
access the password for the current user - just here temporarily (string)