RegistryQuery (Starjava VO API)

All Known Implementing Classes:: RegTapRegistryQuery, Ri1RegistryQuery

public interface RegistryQuery

Describes a query on a registry.

Since:: 4 Jan 2005
Author:: Mark Taylor (Starlink)

Method Summary

Modifier and Type

Method

Description

uk.ac.starlink.table.DescribedValue[]

getMetadata()

Returns a set of DescribedValue objects which characterise this query.

Iterator<RegResource>

getQueryIterator()

Executes the query described by this object and returns an Iterator over RegResource objects.

RegResource[]

getQueryResources()

Executes the query described by this object and returns the result as an array of RegResources.

URL

getRegistry()

Returns the registry URL.

String

getText()

Returns the query text.

Method Details
- getQueryIterator
  
  Iterator<RegResource> getQueryIterator() throws IOException
  
  Executes the query described by this object and returns an Iterator over RegResource objects. Note that the iterator's next method may throw the unchecked exception RegistryQueryException with a cause indicating the underlying error in case of a registry access problem.
  
  Returns:
  
  iterator over RegResources
  
  Throws:
  
  IOException
- getQueryResources
  
  RegResource[] getQueryResources() throws IOException
  
  Executes the query described by this object and returns the result as an array of RegResources.
  
  Returns:
  
  resource list
  
  Throws:
  
  IOException
- getText
  
  String getText()
  
  Returns the query text.
  
  Returns:
  
  query
- getRegistry
  
  URL getRegistry()
  
  Returns the registry URL.
  
  Returns:
  
  url
- getMetadata
  
  uk.ac.starlink.table.DescribedValue[] getMetadata()
  
  Returns a set of DescribedValue objects which characterise this query. These would be suitable for use in the parameter list of a StarTable resulting from the execution of this query.