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:
gavo.registry.capabilities.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
gavo.registry.model.VOR.capability
-
renderer
= None¶
-
-
class
gavo.registry.capabilities.
CustomCapabilityMaker
[source]¶ Bases:
gavo.registry.capabilities.CapabilityMaker
-
renderer
= 'custom'¶
-
-
class
gavo.registry.capabilities.
CustomInterface
[source]¶ Bases:
gavo.registry.capabilities.WebBrowserInterface
-
renderer
= 'custom'¶
-
-
class
gavo.registry.capabilities.
DALIInterface
[source]¶ Bases:
gavo.registry.capabilities.InterfaceMaker
-
interfaceClass
¶
-
-
class
gavo.registry.capabilities.
DatalinkCapabilityMaker
[source]¶ Bases:
gavo.registry.capabilities.CapabilityMaker
-
renderer
= 'dlmeta'¶
-
-
class
gavo.registry.capabilities.
DatalinkInterface
[source]¶ Bases:
gavo.registry.capabilities.InterfaceWithParams
-
interfaceClass
¶
-
renderer
= 'dlmeta'¶
-
-
class
gavo.registry.capabilities.
DocformCapabilityMaker
[source]¶ Bases:
gavo.registry.capabilities.CapabilityMaker
-
renderer
= 'docform'¶
-
-
class
gavo.registry.capabilities.
DocformInterface
[source]¶ Bases:
gavo.registry.capabilities.WebBrowserInterface
-
renderer
= 'docform'¶
-
-
class
gavo.registry.capabilities.
EditionCapabilityMaker
[source]¶ Bases:
gavo.registry.capabilities.CapabilityMaker
-
capabilityClass
¶ alias of
gavo.registry.model.DOC.capability
-
renderer
= 'edition'¶
-
-
class
gavo.registry.capabilities.
EditionInterface
[source]¶ Bases:
gavo.registry.capabilities.InterfaceMaker
-
interfaceClass
¶ alias of
gavo.registry.model.VOR.WebBrowser
-
renderer
= 'edition'¶
-
-
class
gavo.registry.capabilities.
ExamplesCapabilityMaker
[source]¶ Bases:
gavo.registry.capabilities.PlainCapabilityMaker
-
renderer
= 'examples'¶
-
standardId
= 'ivo://ivoa.net/std/DALI#examples'¶
-
-
class
gavo.registry.capabilities.
ExamplesInterface
[source]¶ Bases:
gavo.registry.capabilities.InterfaceMaker
-
interfaceClass
¶ alias of
gavo.registry.model.VOR.WebBrowser
-
renderer
= 'examples'¶
-
-
class
gavo.registry.capabilities.
ExternalCapabilityMaker
[source]¶ Bases:
gavo.registry.capabilities.CapabilityMaker
-
renderer
= 'external'¶
-
-
class
gavo.registry.capabilities.
ExternalInterface
[source]¶ Bases:
gavo.registry.capabilities.WebBrowserInterface
-
renderer
= 'external'¶
-
-
class
gavo.registry.capabilities.
FixedCapabilityMaker
[source]¶ Bases:
gavo.registry.capabilities.CapabilityMaker
-
renderer
= 'fixed'¶
-
-
class
gavo.registry.capabilities.
FixedInterface
[source]¶ Bases:
gavo.registry.capabilities.WebBrowserInterface
-
renderer
= 'fixed'¶
-
-
class
gavo.registry.capabilities.
FormCapabilityMaker
[source]¶ Bases:
gavo.registry.capabilities.CapabilityMaker
-
renderer
= 'form'¶
-
-
class
gavo.registry.capabilities.
FormInterface
[source]¶ Bases:
gavo.registry.capabilities.WebBrowserInterface
-
renderer
= 'form'¶
-
-
class
gavo.registry.capabilities.
GetProductInterface
[source]¶ Bases:
gavo.registry.capabilities.WebBrowserInterface
-
renderer
= 'get'¶
-
-
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
gavo.registry.model.VOR.interface
-
renderer
= None¶
-
-
class
gavo.registry.capabilities.
InterfaceWithParams
[source]¶ Bases:
gavo.registry.capabilities.InterfaceMaker
An InterfaceMaker on a publication sporting input parameters.
This corresponds to a ParamHTTP interface.
-
interfaceClass
¶ alias of
gavo.registry.model.VS.ParamHTTP
-
-
class
gavo.registry.capabilities.
JPEGCapabilityMaker
[source]¶ Bases:
gavo.registry.capabilities.CapabilityMaker
-
renderer
= 'img.jpeg'¶
-
-
class
gavo.registry.capabilities.
OAIHTTPInterface
[source]¶ Bases:
gavo.registry.capabilities.InterfaceMaker
-
interfaceClass
¶ alias of
gavo.registry.model.VOG.OAIHTTP
-
renderer
= 'pubreg.xml'¶
-
-
class
gavo.registry.capabilities.
PlainCapabilityMaker
[source]¶ Bases:
gavo.registry.capabilities.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:
gavo.registry.capabilities.CapabilityMaker
-
renderer
= 'get'¶
-
-
class
gavo.registry.capabilities.
QPCapabilityMaker
[source]¶ Bases:
gavo.registry.capabilities.CapabilityMaker
-
renderer
= 'qp'¶
-
-
class
gavo.registry.capabilities.
QPInterface
[source]¶ Bases:
gavo.registry.capabilities.WebBrowserInterface
-
renderer
= 'qp'¶
-
-
class
gavo.registry.capabilities.
RegistryCapabilityMaker
[source]¶ Bases:
gavo.registry.capabilities.CapabilityMaker
-
capabilityClass
¶ alias of
gavo.registry.model.VOG.Harvest
-
renderer
= 'pubreg.xml'¶
-
-
class
gavo.registry.capabilities.
SCSCapabilityMaker
[source]¶ Bases:
gavo.registry.capabilities.CapabilityMaker
-
capabilityClass
¶ alias of
gavo.registry.model.SCS.capability
-
renderer
= 'scs.xml'¶
-
-
class
gavo.registry.capabilities.
SCSInterface
[source]¶ Bases:
gavo.registry.capabilities.InterfaceWithParams
-
interfaceClass
¶ alias of
gavo.registry.model.SCS.interface
-
renderer
= 'scs.xml'¶
-
-
class
gavo.registry.capabilities.
SIACapabilityMaker
[source]¶ Bases:
gavo.registry.capabilities.CapabilityMaker
-
auxiliaryId
= 'ivo://ivoa.net/std/SIA#aux'¶
-
capabilityClass
¶ alias of
gavo.registry.model.SIA.capability
-
renderer
= 'siap.xml'¶
-
-
class
gavo.registry.capabilities.
SIAP2Interface
[source]¶ Bases:
gavo.registry.capabilities.InterfaceWithParams
-
interfaceClass
¶ alias of
gavo.registry.model.SIA.interface
-
renderer
= 'siap2.xml'¶
-
-
class
gavo.registry.capabilities.
SIAPInterface
[source]¶ Bases:
gavo.registry.capabilities.InterfaceWithParams
-
interfaceClass
¶ alias of
gavo.registry.model.SIA.interface
-
renderer
= 'siap.xml'¶
-
-
class
gavo.registry.capabilities.
SIAV2CapabilityMaker
[source]¶ Bases:
gavo.registry.capabilities.SIACapabilityMaker
-
auxiliaryId
= 'ivo://ivoa.net/std/SIA#query-aux-2.0'¶
-
capabilityClass
¶ alias of
gavo.registry.model.SIA.capability2
-
renderer
= 'siap2.xml'¶
-
-
class
gavo.registry.capabilities.
SLAPCapabilityMaker
[source]¶ Bases:
gavo.registry.capabilities.CapabilityMaker
-
capabilityClass
¶ alias of
gavo.registry.model.SLAP.capability
-
renderer
= 'slap.xml'¶
-
-
class
gavo.registry.capabilities.
SLAPInterface
[source]¶ Bases:
gavo.registry.capabilities.InterfaceWithParams
-
interfaceClass
¶ alias of
gavo.registry.model.SLAP.interface
-
renderer
= 'slap.xml'¶
-
-
class
gavo.registry.capabilities.
SOAPCapabilityMaker
[source]¶ Bases:
gavo.registry.capabilities.CapabilityMaker
-
renderer
= 'soap'¶
-
-
class
gavo.registry.capabilities.
SOAPInterface
[source]¶ Bases:
gavo.registry.capabilities.InterfaceMaker
-
interfaceClass
¶ alias of
gavo.registry.model.VOR.WebService
-
renderer
= 'soap'¶
-
-
class
gavo.registry.capabilities.
SODAAsyncCapabilityMaker
[source]¶ Bases:
gavo.registry.capabilities.CapabilityMaker
-
renderer
= 'dlasync'¶
-
-
class
gavo.registry.capabilities.
SODAAsyncInterface
[source]¶ Bases:
gavo.registry.capabilities.SODASyncInterface
-
renderer
= 'dlasync'¶
-
-
class
gavo.registry.capabilities.
SODACapabilityMaker
[source]¶ Bases:
gavo.registry.capabilities.CapabilityMaker
-
renderer
= 'dlget'¶
-
-
class
gavo.registry.capabilities.
SODASyncInterface
[source]¶ Bases:
gavo.registry.capabilities.InterfaceMaker
-
interfaceClass
¶
-
renderer
= 'dlget'¶
-
-
class
gavo.registry.capabilities.
SSACapabilityMaker
[source]¶ Bases:
gavo.registry.capabilities.CapabilityMaker
-
capabilityClass
¶ alias of
gavo.registry.model.SSAP.capability
-
renderer
= 'ssap.xml'¶
-
-
class
gavo.registry.capabilities.
SSAPInterface
[source]¶ Bases:
gavo.registry.capabilities.InterfaceWithParams
-
interfaceClass
¶ alias of
gavo.registry.model.SSAP.interface
-
renderer
= 'ssap.xml'¶
-
-
class
gavo.registry.capabilities.
StandardParamHTTP
(id=None, qtype=None, role='std', version=None, xsi_type='vs:ParamHTTP')[source]¶
-
class
gavo.registry.capabilities.
StaticCapabilityMaker
[source]¶ Bases:
gavo.registry.capabilities.CapabilityMaker
-
renderer
= 'static'¶
-
-
class
gavo.registry.capabilities.
StaticInterface
[source]¶ Bases:
gavo.registry.capabilities.WebBrowserInterface
-
renderer
= 'static'¶
-
-
class
gavo.registry.capabilities.
TAPCapabilityMaker
[source]¶ Bases:
gavo.registry.capabilities.CapabilityMaker
-
auxiliaryId
= 'ivo://ivoa.net/std/TAP#aux'¶
-
capabilityClass
¶ alias of
gavo.registry.model.TR.capability
-
renderer
= 'dali'¶
-
-
class
gavo.registry.capabilities.
TAPInterface
[source]¶ Bases:
gavo.registry.capabilities.InterfaceMaker
-
interfaceClass
¶ alias of
gavo.registry.model.TR.interface
-
renderer
= 'dali'¶
-
-
class
gavo.registry.capabilities.
VOSIAvCapabilityMaker
[source]¶ Bases:
gavo.registry.capabilities.VOSICapabilityMaker
-
renderer
= 'availability'¶
-
standardId
= 'ivo://ivoa.net/std/VOSI#availability'¶
-
-
class
gavo.registry.capabilities.
VOSIAvInterface
[source]¶ Bases:
gavo.registry.capabilities.VOSIInterface
-
renderer
= 'availability'¶
-
-
class
gavo.registry.capabilities.
VOSICapCapabilityMaker
[source]¶ Bases:
gavo.registry.capabilities.VOSICapabilityMaker
-
renderer
= 'capabilities'¶
-
standardId
= 'ivo://ivoa.net/std/VOSI#capabilities'¶
-
-
class
gavo.registry.capabilities.
VOSICapInterface
[source]¶ Bases:
gavo.registry.capabilities.VOSIInterface
-
renderer
= 'capabilities'¶
-
-
class
gavo.registry.capabilities.
VOSICapabilityMaker
[source]¶ Bases:
gavo.registry.capabilities.PlainCapabilityMaker
-
capabilityClass
¶ alias of
gavo.registry.model.VOG.capability
-
-
class
gavo.registry.capabilities.
VOSIInterface
[source]¶ Bases:
gavo.registry.capabilities.InterfaceMaker
-
interfaceClass
¶
-
-
class
gavo.registry.capabilities.
VOSITMCapabilityMaker
[source]¶ Bases:
gavo.registry.capabilities.VOSICapabilityMaker
-
renderer
= 'tableMetadata'¶
-
standardId
= 'ivo://ivoa.net/std/VOSI#tables'¶
-
-
class
gavo.registry.capabilities.
VOSITMInterface
[source]¶ Bases:
gavo.registry.capabilities.VOSIInterface
-
renderer
= 'tableMetadata'¶
-
-
class
gavo.registry.capabilities.
VolatileCapabilityMaker
[source]¶ Bases:
gavo.registry.capabilities.CapabilityMaker
-
renderer
= 'volatile'¶
-
-
class
gavo.registry.capabilities.
VolatileInterface
[source]¶ Bases:
gavo.registry.capabilities.WebBrowserInterface
-
renderer
= 'volatile'¶
-
-
class
gavo.registry.capabilities.
WebBrowserInterface
[source]¶ Bases:
gavo.registry.capabilities.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
gavo.registry.model.VOR.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.