Class ServiceResult

source code

object --+
         |
        ServiceResult

Known Subclasses:

• CSVResponse
• , FITSTableResult
• , JsonResponse
• , TSVResponse
• , TarResponse
• , TextResponse
• , VOTableResult

A base class for objects producing formatted output.

ServiceResults are constructed with a context and the service. On renderHTTP, they will spawn a thread to compute the service result (usually, an rsc.Data instance) and hand that over to _formatOutput.

All methods on these objects are class methods -- they are never instanciated.

Deriving classes can override

• _formatOutput(result, ctx) -- receives the service result and has to format it.
• canWrite(colSeq) -- a that returns true when a seq of columns can be serialized by this service result.
• code -- an identifier used in HTTP query strings to select the format
• label (optional) -- a string that is used in HTML forms to select the format (defaults to label).
• compute -- if False, at least the form renderer will not run the service (this is when you just return a container).