gavo.registry.capabilities module

VOResource capability/interface elements.

The basic mapping from our RD elements to VOResource elements is that each renderer on a service translates to a capability with one interface. Thus, in the module we mostly deal with publication objects. If you need the service object, use publication.parent.

class gavo.registry.capabilities.APICapabilityMaker

Bases: CapabilityMaker

renderer = 'api'

class gavo.registry.capabilities.CapabilityMaker

Bases: object

An encapsulation of capability construction.

Each capability (currently) corresponds to a renderer.

You will want to override (some of) the class variables at the top, plus the _makeCapability method (that you’ll probably still want to upcall for the basic functionality).

In particular, you will typically want to override capabilityClass with a stanxml element spitting out the right standardIds.

Additionally, if the capability should also appear in data collections served by a service with the capability, also define auxiliaryId (that’s an IVOID like ivo://ivoa.net/std/TAP#aux). These are used in getCapabilityElement.

CapabilityMakers are used by calling them.

auxiliaryId = None

capabilityClass

alias of capability

renderer = None

class gavo.registry.capabilities.CustomCapabilityMaker

Bases: CapabilityMaker

renderer = 'custom'

class gavo.registry.capabilities.CustomInterface

Bases: WebBrowserInterface

renderer = 'custom'

class gavo.registry.capabilities.DALIInterface

Bases: InterfaceMaker

interfaceClass

alias of daliInterface

class gavo.registry.capabilities.DatalinkCapabilityMaker

Bases: CapabilityMaker

class capabilityClass(id=None, standardID='ivo://ivoa.net/std/DataLink#links-1.1')

Bases: capability

renderer = 'dlmeta'

class gavo.registry.capabilities.DatalinkInterface

Bases: InterfaceWithParams

interfaceClass

alias of StandardParamHTTP

renderer = 'dlmeta'

class gavo.registry.capabilities.DocformCapabilityMaker

Bases: CapabilityMaker

renderer = 'docform'

class gavo.registry.capabilities.DocformInterface

Bases: WebBrowserInterface

renderer = 'docform'

class gavo.registry.capabilities.EditionCapabilityMaker

Bases: CapabilityMaker

capabilityClass

alias of capability

renderer = 'edition'

class gavo.registry.capabilities.EditionInterface

Bases: InterfaceMaker

interfaceClass

alias of WebBrowser

renderer = 'edition'

class gavo.registry.capabilities.ExamplesCapabilityMaker

Bases: PlainCapabilityMaker

renderer = 'examples'

standardId = 'ivo://ivoa.net/std/DALI#examples'

class gavo.registry.capabilities.ExamplesInterface

Bases: InterfaceMaker

interfaceClass

alias of WebBrowser

renderer = 'examples'

class gavo.registry.capabilities.ExternalCapabilityMaker

Bases: CapabilityMaker

renderer = 'external'

class gavo.registry.capabilities.ExternalInterface

Bases: WebBrowserInterface

renderer = 'external'

class gavo.registry.capabilities.FixedCapabilityMaker

Bases: CapabilityMaker

renderer = 'fixed'

class gavo.registry.capabilities.FixedInterface

Bases: WebBrowserInterface

renderer = 'fixed'

class gavo.registry.capabilities.FormCapabilityMaker

Bases: CapabilityMaker

renderer = 'form'

class gavo.registry.capabilities.FormInterface

Bases: WebBrowserInterface

renderer = 'form'

class gavo.registry.capabilities.GetProductInterface

Bases: WebBrowserInterface

renderer = 'get'

class gavo.registry.capabilities.HiPSCapabilityMaker

Bases: PlainCapabilityMaker

interfaceClass

alias of StandardParamHTTP

renderer = 'hips'

standardId = 'ivo://ivoa.net/std/hips#hips-1.0'

class gavo.registry.capabilities.InterfaceMaker

Bases: object

An encapsulation of interface construction.

Each interface maker corresponds to a renderer and thus a publication on a service. It knows enough about the characteristics of a renderer to create interface stan by just calling.

This class is abstract. To build concrete interface makers, at least fill out the class variables. You will probably want to override the _makeInterface method for some renderers corresponding so specially defined interfaces; the default implementation corresponds to the VOResource definition.

interfaceClass

alias of interface

renderer = None

class gavo.registry.capabilities.InterfaceWithParams

Bases: InterfaceMaker

An InterfaceMaker on a publication sporting input parameters.

This corresponds to a ParamHTTP interface.

interfaceClass

alias of ParamHTTP

class gavo.registry.capabilities.JPEGCapabilityMaker

Bases: CapabilityMaker

renderer = 'img.jpeg'

class gavo.registry.capabilities.OAIHTTPInterface

Bases: InterfaceMaker

interfaceClass

alias of OAIHTTP

renderer = 'pubreg.xml'

class gavo.registry.capabilities.PlainCapabilityMaker

Bases: CapabilityMaker

A capability maker for generic VR.capabilities.

These essentially just set standardId, in addition to what the plain capabilities do.

standardId = None

class gavo.registry.capabilities.ProductCapabilityMaker

Bases: CapabilityMaker

renderer = 'get'

class gavo.registry.capabilities.QPCapabilityMaker

Bases: CapabilityMaker

renderer = 'qp'

class gavo.registry.capabilities.QPInterface

Bases: WebBrowserInterface

renderer = 'qp'

class gavo.registry.capabilities.RegistryCapabilityMaker

Bases: CapabilityMaker

capabilityClass

alias of Harvest

renderer = 'pubreg.xml'

class gavo.registry.capabilities.SCSCapabilityMaker

Bases: CapabilityMaker

capabilityClass

alias of capability

renderer = 'scs.xml'

class gavo.registry.capabilities.SCSInterface

Bases: InterfaceWithParams

interfaceClass

alias of interface

renderer = 'scs.xml'

class gavo.registry.capabilities.SIACapabilityMaker

Bases: CapabilityMaker

auxiliaryId = 'ivo://ivoa.net/std/SIA#aux'

capabilityClass

alias of capability

renderer = 'siap.xml'

class gavo.registry.capabilities.SIAP2Interface

Bases: InterfaceWithParams

interfaceClass

alias of interface

renderer = 'siap2.xml'

class gavo.registry.capabilities.SIAPInterface

Bases: InterfaceWithParams

interfaceClass

alias of interface

renderer = 'siap.xml'

class gavo.registry.capabilities.SIAV2CapabilityMaker

Bases: SIACapabilityMaker

auxiliaryId = 'ivo://ivoa.net/std/SIA#query-aux-2.0'

capabilityClass

alias of capability2

renderer = 'siap2.xml'

class gavo.registry.capabilities.SLAPCapabilityMaker

Bases: CapabilityMaker

capabilityClass

alias of capability

renderer = 'slap.xml'

class gavo.registry.capabilities.SLAPInterface

Bases: InterfaceWithParams

interfaceClass

alias of interface

renderer = 'slap.xml'

class gavo.registry.capabilities.SOAPCapabilityMaker

Bases: CapabilityMaker

renderer = 'soap'

class gavo.registry.capabilities.SOAPInterface

Bases: InterfaceMaker

interfaceClass

alias of WebService

renderer = 'soap'

class gavo.registry.capabilities.SODAAsyncCapabilityMaker

Bases: CapabilityMaker

class capabilityClass(id=None, standardID='ivo://ivoa.net/std/SODA#async-1.0')

Bases: capability

renderer = 'dlasync'

class gavo.registry.capabilities.SODAAsyncInterface

Bases: SODASyncInterface

renderer = 'dlasync'

class gavo.registry.capabilities.SODACapabilityMaker

Bases: CapabilityMaker

class capabilityClass(id=None, standardID='ivo://ivoa.net/std/SODA#sync-1.0')

Bases: capability

renderer = 'dlget'

class gavo.registry.capabilities.SODASyncInterface

Bases: InterfaceMaker

interfaceClass

alias of StandardParamHTTP

renderer = 'dlget'

class gavo.registry.capabilities.SSACapabilityMaker

Bases: CapabilityMaker

capabilityClass

alias of capability

renderer = 'ssap.xml'

class gavo.registry.capabilities.SSAPInterface

Bases: InterfaceWithParams

interfaceClass

alias of interface

renderer = 'ssap.xml'

class gavo.registry.capabilities.StandardParamHTTP(id=None, qtype=None, role='std', version=None, xsi_type='vs:ParamHTTP')

Bases: ParamHTTP

class gavo.registry.capabilities.StaticCapabilityMaker

Bases: CapabilityMaker

renderer = 'static'

class gavo.registry.capabilities.StaticInterface

Bases: WebBrowserInterface

renderer = 'static'

class gavo.registry.capabilities.TAPCapabilityMaker

Bases: CapabilityMaker

auxiliaryId = 'ivo://ivoa.net/std/TAP#aux'

capabilityClass

alias of capability

renderer = 'dali'

class gavo.registry.capabilities.TAPInterface

Bases: InterfaceMaker

interfaceClass

alias of interface

renderer = 'dali'

class gavo.registry.capabilities.VOSIAvCapabilityMaker

Bases: VOSICapabilityMaker

renderer = 'availability'

standardId = 'ivo://ivoa.net/std/VOSI#availability'

class gavo.registry.capabilities.VOSIAvInterface

Bases: VOSIInterface

renderer = 'availability'

class gavo.registry.capabilities.VOSICapCapabilityMaker

Bases: VOSICapabilityMaker

renderer = 'capabilities'

standardId = 'ivo://ivoa.net/std/VOSI#capabilities'

class gavo.registry.capabilities.VOSICapInterface

Bases: VOSIInterface

renderer = 'capabilities'

class gavo.registry.capabilities.VOSICapabilityMaker

Bases: PlainCapabilityMaker

capabilityClass

alias of capability

class gavo.registry.capabilities.VOSIInterface

Bases: InterfaceMaker

interfaceClass

alias of StandardParamHTTP

class gavo.registry.capabilities.VOSITMCapabilityMaker

Bases: VOSICapabilityMaker

renderer = 'tableMetadata'

standardId = 'ivo://ivoa.net/std/VOSI#tables'

class gavo.registry.capabilities.VOSITMInterface

Bases: VOSIInterface

renderer = 'tableMetadata'

class gavo.registry.capabilities.VolatileCapabilityMaker

Bases: CapabilityMaker

renderer = 'volatile'

class gavo.registry.capabilities.VolatileInterface

Bases: WebBrowserInterface

renderer = 'volatile'

class gavo.registry.capabilities.WebBrowserInterface

Bases: InterfaceMaker

An InterfaceMaker on a publication to be consumed by a web browser.

This is abstract since various renderers boil down to this.

interfaceClass

alias of WebBrowser

gavo.registry.capabilities.getAuxiliaryCapability(publication)

returns a VR.capability element for an auxiliary publication.

That’s a plain capability with essentially the interface and a standardId obtained from the auxiliaryId attribute of the capability’s normal maker.

If no auxiliaryId is defined, None is returned (which means no capability will be generated).

gavo.registry.capabilities.getCapabilityElement(publication)

returns the appropriate capability definition for a publication object.

gavo.registry.capabilities.getInputParamFromColumn(column, rootElement=<class 'gavo.registry.model.VS.param'>)

returns a InputParam element for a rscdef.Column.

gavo.registry.capabilities.getInputParams(publication, service)

returns a sequence of vs:param elements for the input of service.