magpie.user.server.operations

Class ModelQueryHandler

java.lang.Object

magpie.user.server.operations.ModelQueryHandler

@Path(value="models")
public class ModelQueryHandler
extends java.lang.Object

Run operations to gather models that fit certain criteria.

Constructor Summary

Constructors

Constructor and Description
ModelQueryHandler()

Method Summary

Modifier and Type	Method and Description
Dataset	getDatasetByName(java.lang.String datasetType) Given the name of a dataset object, return an instance of that class
java.lang.String	serveModels(java.lang.String datasetType, java.lang.String supportsDatasetType) Get all models that match the users query

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ModelQueryHandler

public ModelQueryHandler()

Method Detail

serveModels

@GET
 @Produces(value="application/json")
public java.lang.String serveModels(@DefaultValue(value="") @QueryParam(value="datasetType")
                                                                              java.lang.String datasetType,
                                                                              @DefaultValue(value="") @QueryParam(value="supportsDatasetType")
                                                                              java.lang.String supportsDatasetType)

Get all models that match the users query

Parameters:

datasetType - Desired dataset type, looks for exact match

supportsDatasetType - Get models that at least support this kind of dataset type

Returns:

JSON object describing each matching model

getDatasetByName

public Dataset getDatasetByName(@DefaultValue(value="") @QueryParam(value="datasetType")
                                java.lang.String datasetType)

Given the name of a dataset object, return an instance of that class

Parameters:

datasetType - Name of dataset, without the "magpie.data" (e.g., "materials.CompositionDataset")

Returns:

Dataset object