spacer spacer spacer
spacer spacer spacer
spacer
NASA Jet Propulsion Laboratory, California Institute of Technology + View the NASA Portal

+ NASA en Español

+ Contact NASA
Search the API    

HTTP Interfaces for Data Dictionary

The HTTP interfaces described in this section are provided to manage, access, and search for data dictionaries. They are supported through the AccessServlet, ManagerServlet , and SearchServlet classes. The Details regarding the each servlet can be found in the subsections below.

AccessServlet

This servlet handles dictionary accesses. It takes the following parameters, either from a GET or POST request:

AccessServlet allows methods which is either get or export that is to obtain the detail of a dictionary iincluding its metadata and list of elements and their brief descriptions. Both methods take identifier and registryId assigned after a success registration. All methods require a common parameter object .

  • get is followed by
    • identifier dictionary registry's identifier.
    • registryId registry identifier, a sequence number assigned after a successful registration.
  • export is followed by
    • identifier dictionary registry's identifier.
    • registryId registry identifier, a sequence number assigned after a successful registration.

In response, the get method outputs the information in html format. The export method outputs the dictionary information into an xml structure compliant to dataDictionary.xsd or dataDictionary.dtd .

Examples:

    http://metadata.jpl.nasa.gov/DictionaryAccess?
    object=urn:eda:corba:JPL.EDM.MetadataRegistry&
    identifier=JPL.EDM.Metadata.Default&
    get
    	  
    http://metadata.jpl.nasa.gov/DictionaryAccess?
    object=urn:eda:corba:JPL.EDM.MetadataRegistry&
    identifier=JPL.EDM.Metadata.Default&
    export
    	  

ManagerServlet

This servlet provides methods that handle and manage dictionary registries.

Some methods involve too many input parameters for filling in the metadata information. The URL for HTTP interface can be very long. Therefore, it is better for the users to set up a html form page to feed the dictionary file and its metadata for processing. Please refer to jsp source http://metadata.jpl.nasa.gov/newDictionary.jsp as an example to create an empty dictionary or http://metadata.jpl.nasa.gov/importDictionary.jsp to import a dictionary file. These include create, add, and modify methods.

In response, this servlet dispatches to a jsp page that displays the registry status.

For other methods, the inputs are simpler. These include remove, removeAll, and release methods. All methods require a common parameter called object .

  • remove method is followed by
    • identifier dictionary registry's identifier.
    • registryId registry identifier, a sequence number assigned after a successful registration.
  • removeAll method is followed by
    • identifier dictionary registry's identifier.
  • release method is followed by
    • identifier dictionary registry's identifier.
    • registryId registry identifier, a sequence number assigned after a successful registration.

In response, this servlet dispatches to a jsp page, dictionaryRegistryResult.jsp that displays the registry status.

SearchServlet

This servlet handles dictionary (data dictionaries) search. It takes the following parameters, either from a GET or POST request:

  • search methods which should be either browse , textSearch , keywordSearch , or xmlQuery indicating what kind of search to perform. All these methods require a common parameter object .

Then, depending on the option selected above, other parameters must be specified.

  • browse : no parameter is further needed.
  • textSearch is followed by:
    • textString is a string of characters.
  • keywordSearch is followed by a set of keyword=value . The user will need to obtain a list of the attributes describing a dictionary. These attributes are derived from the Dublin Core standard.
    • keyword is an attribute describing dictionary.
    • value is value to keyword given above.
  • xmlQuery is followed by
    • DIS-style query string is a query using triples linked in a logical expression. Each triple is in the format of (element, relation, literal).

In response, this servlet dispatches to a jsp page that displays the html result from the search except for xmlQuery method which displays profile xml structure compliant to http://oodt.jpl.nasa.gov/dtd/profile.dtd .

Examples:

    http://metadata.jpl.nasa.gov/DictionarySearch?
    object=urn:eda:corba:JPL.EDM.MetadataRegistry&
    browse
    	  
    http://metadata.jpl.nasa.gov/DictionarySearch?
    object=urn:eda:corba:JPL.EDM.MetadataRegistry&
    textString=PDS&
    textSearch
    	  
    http://metadata.jpl.nasa.gov/DictionarySearch?
    object=urn:eda:corba:JPL.EDM.MetadataRegistry&
    DC.Identifier=JPL.EDM.Metadata.Default&
    keywordSearch
    	  
    http://metadata.jpl.nasa.gov/DictionarySearch?
    object=urn:eda:corba:JPL.EDM.MetadataRegistry&
    kwdString="Identifier=JPL.EDM.Metadata.Default"&
    xmlQuery=Profiles
    	  
FirstGov - Your First Click to the US Governmnet

+ Freedom of Information Act

+ NASA Privacy Statement, Disclaimer,

and Accessibility Certification


+ Freedom to Manage
NASA

Editor: Sean Kelly

NASA Official: Dan Crichton

Last Published: 04 November 2005

+ Contact NASA
spacer
spacer spacer spacer
spacer spacer spacer