Ticket #415 (assigned issue)

Opened 13 years ago

Last modified 11 years ago

[m] browse should link to the parameter definitions from the vocab server

Reported by: lawrence Owned by: lawrence
Priority: desirable Milestone: NDG3
Component: MILK Version:
Keywords: Cc:

Description

When we display a parameter name we should be able to click on it, and get a definition from the vocab server.

Change History

comment:1 Changed 13 years ago by selatham

If we can do this real-time that will be great. There is the facility to store the description locally in MOLES. Should be used as the backup if vocab server request is taking too long or that particular parameter name doesn't exist in the vocab server?

comment:2 Changed 13 years ago by rkl

I would hope that real-time should be possible. If performance becomes an issue the browser can issue a single call to the server on start-up and hold the whole list in string arrays until needed (providing we're not talking about the BODC PUV with its 18000+ entries).

I thought MOLES only contained slots for 'key', 'short_name' and 'long_name', but not for definition, so it could only provide a partial backup.

If we are operational enough to have a real 'key' then the term missing from list shouldn't happen under normal circumstances.

comment:3 Changed 13 years ago by selatham

dgStructuredKeyword type in MOLES has an optional 'Definition' tag available.

I was thinking of the situation where we don't have a real key, i.e. it's from some vocabulary which hasn't made it's way into the vocab/term server. The BODC are unlikely get this situation, but I reckon this will be quite common for other DCs. It's the reality of a huge legacy of data and metadata with non-standard names.

comment:4 Changed 13 years ago by rkl

When did 'definition' appear in dgStructuredKeyword? I don't recall it when I constructed my data analysis notes for the MOLES population software. In fact I have a note that it wasn't there!

comment:5 Changed 13 years ago by ko23

"Definition" has been there since Day 1. There used to be a "dgStructuredKeywordList" structure, in v1.2.3 and previous, to allow the storage of vocabs, if necessary, until a proper vocab/thesaurus was set up.

"Definition" has been left in to allow a definition to be stored alongside the term, if it is useful or pragmatics indicate local storage would be a good idea.

comment:6 Changed 13 years ago by lawrence

  • Status changed from new to assigned
  • Priority changed from required to critical
  • Type changed from task to issue

Coding this depends on deciding whether the vocab server wsdl should be rpc encoded, in which case we have to hand-craft the client (it appears that apache axis isn't that portable), or if it's document-literal, we can probably use the wsdl.

This comes down to how likely BODC are likely to change the wsdl interface. Needs discussion.

comment:7 Changed 13 years ago by siva

I think we can create a "Document/literal" type WSDL using 'Java2WSDL' by giving the arguments --style="WRAPPED", --use="LITERAL" which returns "DOCUMENT/LITERAL WRAPPED" type.I tried it on Java1.4.2 and Apache Axis 1.3 though. We at BODC could try that for Vocab wsdl interface.

comment:8 Changed 13 years ago by mhug

A Document/literal Wrapped version of the Vocab Server WSDL is now available at  http://vocab.ndg.nerc.ac.uk/VocabServerAPI_dl.wsdl

A simple way to link to parameter definitions in browse could be to reference the URL:  http://vocab.ndg.nerc.ac.uk/client/getList.jsp?listKey=P011&entryKey=BLENOX01 using the relevant 8-byte parameter code for the entryKey. However, this does not come wrapped in any sort of NDG branding.

comment:9 Changed 13 years ago by lawrence

We may yet be reduced to the RESTful interface. I've just lodged one  formal bug report with ZSI (for the rpc/enc) problem (includes a unittest, so the NDG vocabserver api may be a ZSI unittest :-), and I've queried the mailing list with a new problem with the doc/literal one you have produced ... and may yet turn that into a formal bug report.

comment:10 Changed 12 years ago by lawrence

  • Milestone changed from BETA to BETA+Services

comment:11 Changed 12 years ago by lawrence

  • Priority changed from critical to required
  • Milestone changed from PROD Final to portal1

comment:12 Changed 11 years ago by lawrence

  • Priority changed from required to desirable
  • Milestone changed from NDG2 Cleanup to NDG3

Yeah, but that can be handled in the V2 and later browse.

comment:13 Changed 11 years ago by lawrence

  • Component changed from MOLES to MILK
Note: See TracTickets for help on using tickets.