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[source]

Bases: CapabilityMaker

renderer = 'api'
class gavo.registry.capabilities.CapabilityMaker[source]

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[source]

Bases: CapabilityMaker

renderer = 'custom'
class gavo.registry.capabilities.CustomInterface[source]

Bases: WebBrowserInterface

renderer = 'custom'
class gavo.registry.capabilities.DALIInterface[source]

Bases: InterfaceMaker

interfaceClass

alias of daliInterface

class gavo.registry.capabilities.DatalinkCapabilityMaker[source]

Bases: CapabilityMaker

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

Bases: capability

renderer = 'dlmeta'
class gavo.registry.capabilities.DatalinkInterface[source]

Bases: InterfaceWithParams

interfaceClass

alias of StandardParamHTTP

renderer = 'dlmeta'
class gavo.registry.capabilities.DocformCapabilityMaker[source]

Bases: CapabilityMaker

renderer = 'docform'
class gavo.registry.capabilities.DocformInterface[source]

Bases: WebBrowserInterface

renderer = 'docform'
class gavo.registry.capabilities.EditionCapabilityMaker[source]

Bases: CapabilityMaker

capabilityClass

alias of capability

renderer = 'edition'
class gavo.registry.capabilities.EditionInterface[source]

Bases: InterfaceMaker

interfaceClass

alias of WebBrowser

renderer = 'edition'
class gavo.registry.capabilities.ExamplesCapabilityMaker[source]

Bases: PlainCapabilityMaker

renderer = 'examples'
standardId = 'ivo://ivoa.net/std/DALI#examples'
class gavo.registry.capabilities.ExamplesInterface[source]

Bases: InterfaceMaker

interfaceClass

alias of WebBrowser

renderer = 'examples'
class gavo.registry.capabilities.ExternalCapabilityMaker[source]

Bases: CapabilityMaker

renderer = 'external'
class gavo.registry.capabilities.ExternalInterface[source]

Bases: WebBrowserInterface

renderer = 'external'
class gavo.registry.capabilities.FixedCapabilityMaker[source]

Bases: CapabilityMaker

renderer = 'fixed'
class gavo.registry.capabilities.FixedInterface[source]

Bases: WebBrowserInterface

renderer = 'fixed'
class gavo.registry.capabilities.FormCapabilityMaker[source]

Bases: CapabilityMaker

renderer = 'form'
class gavo.registry.capabilities.FormInterface[source]

Bases: WebBrowserInterface

renderer = 'form'
class gavo.registry.capabilities.GetProductInterface[source]

Bases: WebBrowserInterface

renderer = 'get'
class gavo.registry.capabilities.HiPSCapabilityMaker[source]

Bases: PlainCapabilityMaker

interfaceClass

alias of StandardParamHTTP

renderer = 'hips'
standardId = 'ivo://ivoa.net/std/hips#hips-1.0'
class gavo.registry.capabilities.InterfaceMaker[source]

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[source]

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[source]

Bases: CapabilityMaker

renderer = 'img.jpeg'
class gavo.registry.capabilities.OAIHTTPInterface[source]

Bases: InterfaceMaker

interfaceClass

alias of OAIHTTP

renderer = 'pubreg.xml'
class gavo.registry.capabilities.PlainCapabilityMaker[source]

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[source]

Bases: CapabilityMaker

renderer = 'get'
class gavo.registry.capabilities.QPCapabilityMaker[source]

Bases: CapabilityMaker

renderer = 'qp'
class gavo.registry.capabilities.QPInterface[source]

Bases: WebBrowserInterface

renderer = 'qp'
class gavo.registry.capabilities.RegistryCapabilityMaker[source]

Bases: CapabilityMaker

capabilityClass

alias of Harvest

renderer = 'pubreg.xml'
class gavo.registry.capabilities.SCSCapabilityMaker[source]

Bases: CapabilityMaker

capabilityClass

alias of capability

renderer = 'scs.xml'
class gavo.registry.capabilities.SCSInterface[source]

Bases: InterfaceWithParams

interfaceClass

alias of interface

renderer = 'scs.xml'
class gavo.registry.capabilities.SIACapabilityMaker[source]

Bases: CapabilityMaker

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

alias of capability

renderer = 'siap.xml'
class gavo.registry.capabilities.SIAP2Interface[source]

Bases: InterfaceWithParams

interfaceClass

alias of interface

renderer = 'siap2.xml'
class gavo.registry.capabilities.SIAPInterface[source]

Bases: InterfaceWithParams

interfaceClass

alias of interface

renderer = 'siap.xml'
class gavo.registry.capabilities.SIAV2CapabilityMaker[source]

Bases: SIACapabilityMaker

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

alias of capability2

renderer = 'siap2.xml'
class gavo.registry.capabilities.SLAPCapabilityMaker[source]

Bases: CapabilityMaker

capabilityClass

alias of capability

renderer = 'slap.xml'
class gavo.registry.capabilities.SLAPInterface[source]

Bases: InterfaceWithParams

interfaceClass

alias of interface

renderer = 'slap.xml'
class gavo.registry.capabilities.SOAPCapabilityMaker[source]

Bases: CapabilityMaker

renderer = 'soap'
class gavo.registry.capabilities.SOAPInterface[source]

Bases: InterfaceMaker

interfaceClass

alias of WebService

renderer = 'soap'
class gavo.registry.capabilities.SODAAsyncCapabilityMaker[source]

Bases: CapabilityMaker

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

Bases: capability

renderer = 'dlasync'
class gavo.registry.capabilities.SODAAsyncInterface[source]

Bases: SODASyncInterface

renderer = 'dlasync'
class gavo.registry.capabilities.SODACapabilityMaker[source]

Bases: CapabilityMaker

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

Bases: capability

renderer = 'dlget'
class gavo.registry.capabilities.SODASyncInterface[source]

Bases: InterfaceMaker

interfaceClass

alias of StandardParamHTTP

renderer = 'dlget'
class gavo.registry.capabilities.SSACapabilityMaker[source]

Bases: CapabilityMaker

capabilityClass

alias of capability

renderer = 'ssap.xml'
class gavo.registry.capabilities.SSAPInterface[source]

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')[source]

Bases: ParamHTTP

class gavo.registry.capabilities.StaticCapabilityMaker[source]

Bases: CapabilityMaker

renderer = 'static'
class gavo.registry.capabilities.StaticInterface[source]

Bases: WebBrowserInterface

renderer = 'static'
class gavo.registry.capabilities.TAPCapabilityMaker[source]

Bases: CapabilityMaker

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

alias of capability

renderer = 'dali'
class gavo.registry.capabilities.TAPInterface[source]

Bases: InterfaceMaker

interfaceClass

alias of interface

renderer = 'dali'
class gavo.registry.capabilities.VOSIAvCapabilityMaker[source]

Bases: VOSICapabilityMaker

renderer = 'availability'
standardId = 'ivo://ivoa.net/std/VOSI#availability'
class gavo.registry.capabilities.VOSIAvInterface[source]

Bases: VOSIInterface

renderer = 'availability'
class gavo.registry.capabilities.VOSICapCapabilityMaker[source]

Bases: VOSICapabilityMaker

renderer = 'capabilities'
standardId = 'ivo://ivoa.net/std/VOSI#capabilities'
class gavo.registry.capabilities.VOSICapInterface[source]

Bases: VOSIInterface

renderer = 'capabilities'
class gavo.registry.capabilities.VOSICapabilityMaker[source]

Bases: PlainCapabilityMaker

capabilityClass

alias of capability

class gavo.registry.capabilities.VOSIInterface[source]

Bases: InterfaceMaker

interfaceClass

alias of StandardParamHTTP

class gavo.registry.capabilities.VOSITMCapabilityMaker[source]

Bases: VOSICapabilityMaker

renderer = 'tableMetadata'
standardId = 'ivo://ivoa.net/std/VOSI#tables'
class gavo.registry.capabilities.VOSITMInterface[source]

Bases: VOSIInterface

renderer = 'tableMetadata'
class gavo.registry.capabilities.VolatileCapabilityMaker[source]

Bases: CapabilityMaker

renderer = 'volatile'
class gavo.registry.capabilities.VolatileInterface[source]

Bases: WebBrowserInterface

renderer = 'volatile'
class gavo.registry.capabilities.WebBrowserInterface[source]

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)[source]

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)[source]

returns the appropriate capability definition for a publication object.

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

returns a InputParam element for a rscdef.Column.

gavo.registry.capabilities.getInputParams(publication, service)[source]

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